safi-ssh2-sftp-client

    1.0.1 • Public • Published

    SSH2 SFTP Client

    a SFTP client for node.js, a wrapper for ssh2

    Installation

    npm install safi-ssh2-sftp-client

    Usage

    let Client = require('safi-ssh2-sftp-client');
    let sftp = new Client();
    sftp.connect({
        host: '127.0.0.1',
        port: '8080',
        username: 'username'
        password: '******'
    }).then(() => {
        return sftp.list('/pathname');
    }).then((data) => {
        console.log(data, 'the data info');
    }).catch((err) => {
        console.log(err, 'catch error');
    });
    

    Documentation

    the connection to server config pls see ssh2 client event.

    list of methods: all the methods will return a Promise;

    List

    Retrieves a directory listing.

    sftp.list(romoteFilePath)
    

    directory info:

    type: // file type(-, d, l)
    name: // file name
    size: // file size
    modifyTime: // file timestamp of modified time
    accessTime: // file timestamp of access time
    rights: {
        user:
        group:
        other:
    },
    owner: // user ID
    group: // group ID
    

    Get

    get a new readable stream for path. The encoding is passed to Node Stream (https://nodejs.org/api/stream.html) and it controls how the content is encoded. For example, when downloading binary data, 'null' should be passed (check node stream documentation). Defaults to 'utf8'.

    sftp.get(remoteFilePath, [useCompression], [encoding]);
    

    Put

    upload a file. it can be localPath or Buffer or Stream.

    sftp.put(localFilePath, remoteFilePath, [useCompression], [encoding]);
    sftp.put(Buffer, remoteFilePath, [useCompression], [encoding]);
    sftp.put(Stream, remoteFilePath, [useCompression], [encoding]);
    

    Mkdir

    create a new directory.

    // recursive default is false, if true, it will create directory recursive
    sftp.mkdir(remoteFilePath, recursive);
    

    Rmdir

    remove the directory or file.

    // recursive default is false, if true, it will remove directory recursive even if is not empty
    sftp.rmdir(localPath, recursive);
    

    Delete

    delete file.

    sftp.delete(remoteFilePath);
    

    Rename

    rename/remove remoteSourcePath to remoteDestPath.

    sftp.remove(remoteSourcePath, remoteDestPath);
    

    Connect

    connection config you will see here

    FAQ

    Log

    V1.1.0

    - fix: add encoding control support for binary stream
    

    V1.0.5:

    - fix: multi image upload
    - change: remove `this.client.sftp` to `connect` function
    

    Keywords

    Install

    npm i safi-ssh2-sftp-client

    DownloadsWeekly Downloads

    4

    Version

    1.0.1

    License

    MIT

    Last publish

    Collaborators

    • safiresh