NEST SFTP

This is nest-sftp.

Description

Nest framework module wrapper around ssh2-sftp-client

Installation

1$ npm install --save nest-sftp

Register in AppModule

Register the SftpModule in you App Module.

This version uses forRootAsync

1import { SftpModule } from 'nest-sftp';
2
3@Module({
4  imports: [
5    SftpModule.forRootAsync(
6      {
7        useFactory: (configService: ConfigService) => {
8          return configService.getSftpConnectionInfo();
9        },
10        inject: [ConfigService],
11        imports: [AppModule],
12      },
13      false,
14    ),
15  ],
16  controllers: [],
17  providers: [ConfigService],
18  exports: [ConfigService],
19})
20export class AppModule {}

The Options object implements the ConnectConfig from ssh2.

1import { SftpModule } from 'nest-sftp';
2
3@Module({
4  imports: [
5    SftpModule.forRoot(
6      {
7        host: 'fakehost.com',
8        port: 22,
9        username: 'fakeUser',
10        password: '*****', // passwords should not contain \ (thy should be espaced like \\) and they cannot contain ! or (
11      },
12      false,
13    ),
14  ],
15  controllers: [],
16  providers: [],
17})
18export class AppModule {}

With debug logging:

1import { SftpModule } from 'nest-sftp';
2
3@Module({
4  imports: [
5    SftpModule.forRoot(
6      {
7        host: 'fakehost.com',
8        port: 22,
9        username: 'fakeUser',
10        password: '*****', // passwords should not contain \ (thy should be espaced like \\) and they cannot contain ! or (
11        debug: console.log, // adds logging for researching problems
12      },
13      false,
14    ),
15  ],
16  controllers: [],
17  providers: [],
18})
19export class AppModule {}

Dependency Inject Service

The SftpModule is global. The forRoot() method will open the connection as well during AppModule registration. Then the SftpClientService can be injected into your class.

1import { SftpClientService } from 'nest-sftp';
2
3export class AppService {
4  private readonly logger: Logger;
5  constructor(private readonly sftpClient: SftpClientService) {
6    logger = new Logger();
7  }
8
9  async download(
10    remotePath: string,
11    localPath: string,
12  ): Promise<string | NodeJS.ReadableStream | Buffer> {
13    return await this.sftpClient.download(remotePath, localPath);
14  }
15  // change connection to a different user/password prior to upload
16  async submit(
17    remotePath: string,
18    localPath: string,
19    submitConfig: ConnectConfig,
20  ): Promise<string | NodeJS.ReadableStream | Buffer> {
21    await this.sftpClient.resetConnection(submitConfig);
22    return await this.sftpClient.upload(remotePath, localPath);
23  }
24}

Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.

Stay in touch

• Author - Benjamin Main
• Author - Victor Frank

License

Nest SFTP is MIT licensed.