SSH2 SFTP Client
Fork of https://github.com/jyu213/ssh2-sftp-client
Added fastGet
and fastPut
methods
a SFTP client for node.js, a wrapper for ssh2
Installation
npm install ssh2-sftp-client-fast
Usage
let Client = ;let sftp = ;sftp;
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
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). Default to 'utf8'.
sftp;
Put
upload a file from localPath
or Buffer
, Stream
data to remoteFilePath
.The encoding is passed to Node Stream to control how the content is encoded. Default to 'utf8'.
sftp;sftp;sftp;
Mkdir
create a new directory.
// recursive default is false, if true, it will create directory recursivesftp;
Rmdir
remove the directory or file.
// recursive default is false, if true, it will remove directory recursive even if is not emptysftp;
Delete
delete file.
sftp;
Rename
rename remoteSourcePath to remoteDestPath (removes remoteSourcePath).
sftp;
Chmod
modify rights to remoteDestPath file
sftp;
Connect
connection config you will see here
End
close the sftp connection. when you need it, you can call it in then()
or catch()
.
sftp.end();
Event
add client event handle. you can find more here
close
The socket was closed. hadError is set to true if this was due to error.
sftp.on('close', callbackFn)
end
The socket was disconnected.
sftp.on('end', callbackFn)
error
An error occurred. A 'level' property indicates 'client-socket' for socket-level errors and 'client-ssh' for SSH disconnection messages. In the case of 'client-ssh' messages, there may be a 'description' property that provides more detail.
sftp
FAQ
Log
V2.2.0
- fix: get readable not emitting data events in node 10.0.0
V2.1.1
- add: event listener. [doc](https://github.com/jyu213/ssh2-sftp-client#Event)
- add: `get` or `put` method add extra options [pr#52](https://github.com/jyu213/ssh2-sftp-client/pull/52)
V2.0.1
- add: `chmod` method [pr#33](https://github.com/jyu213/ssh2-sftp-client/pull/33)
- update: upgrade ssh2 to V0.5.0 [pr#30](https://github.com/jyu213/ssh2-sftp-client/pull/30)
- fix: get method stream error reject unwork [#22](https://github.com/jyu213/ssh2-sftp-client/issues/22)
- fix: return Error object on promise rejection [pr#20](https://github.com/jyu213/ssh2-sftp-client/pull/20)
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