ts-sftp-server v0.3.6

TypeScript SFTP Server

Implement a simple SFTP Server using TypeScript and Node.js.

NOTE: This work is part of MACbioIDi2: Promoting the cohesion of Macaronesian regions through a common ICT platform for biomedical R & D & i (INTERREG program MAC2/1.1b/352).

Warning Not all FTP methods are implemented.

Based on work by @mscdex - ssh2, ssh2-streams. Inspired by the work of @validityhq - node-sftp-server and @expressjs - express.

How to use

1) First, import the SFTP Server module

import SFTPServer from "ts-sftp-server";

2) Instanciate the server

let sftpServer = new SFTPServer({
  port: 3000,
  privateKeyFilePath: PRIVATE_KEY_FILE_PATH,
  authMethods: ['password'],
  printMethods: {
    // Print to console on error (not mandatory to implement)
    onError: (msg: string) => {
      // console.log(msg);
    },
    // Print to console on operation success (not mandatory to implement)
    onSuccess: (msg: string) => {
      // console.log(msg);
    },
    // Print to console warnings (not mandatory to implement)
    onWarning: (msg: string) => {
      // console.log(msg);
    },
  },
});

3) Implement the following events

The example inside the folder "test" demos the implementation of an SFTP Server using TypeScript

Funding