sftp-client-promise - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "sftp-client-promise",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "a SFTP client for node.js",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -24,3 +24,140 @@ ## SSH2 SFTP Client
     console.log(err, 'catch error');
+    conn.end();
 });
 ```
+
+### Documentation
+the connection to server config pls see [ssh2 client event](https://github.com/mscdex/ssh2#user-content-client-methods).
+
+list of methods: all the methods will return a Promise;
+
+#### readdir
+read a directory
+```
+conn.sftp('readdir', {path: remoteFilePath})
+```
+
+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
+
+```
+
+#### exists
+return true if the path(file or directory) exists, false otherwise.
+```
+conn.sftp('exists', {path: remotePath})
+```
+
+#### createReadStream
+download file from remote server
+```
+conn.sftp('createReadStream',  {
+  path: remoteFilePath, 
+  stream: localWriteStream, 
+  option: option
+})
+```
+for example:
+```javascript
+conn.sftp('createReadStream', { 
+  path: '/home/temp.gz', 
+  stream: fs.createWriteStream('./local/temp.gz')
+})
+```
+#### createWriteStream
+upload file from local, data(stream | buffer | string)
+```
+conn.sftp('createWriteStream',  {
+  path: remoteFilePath, 
+  data: stream | buffer | string, 
+  option: option
+})
+```
+for example:
+```javascript
+conn.sftp('createWriteStream', { 
+  path: '/home/temp.gz', 
+  data: fs.createReadStream('./local/temp.gz')
+  //data: fs.readFileSync('./local/temp.gz')
+  //data: 'some local data'
+})
+```
+#### readFile
+download remote server file
+```
+conn.sftp('readFile', {path: remoteFilePath, option: option})
+```
+#### writeFile
+upload file to remote server 
+```
+conn.sftp('writeFile', {path: remoteFilePath, data: localFilePath, option: option})
+```
+#### appendFile
+append local data to remote server file
+```
+conn.sftp('appendFile', {path: remoteFilePath, data: localData, option: option})
+```
+#### mkdir
+
+create a new directory.
+```
+conn.sftp('mkdir', {path: remoteFilePath});
+```
+
+#### rmdir
+
+remove the directory.
+```
+conn.sftp('rmdir', {path: localPath});
+```
+
+#### unlink
+
+delete file.
+```
+conn.sftp('delete', {path: remoteFilePath});
+```
+
+#### rename
+
+rename remoteSourcePath to remoteDestPath (removes remoteSourcePath).
+```
+conn.sftp('rename', {oldPath: remoteSourcePath, newPath: remoteDestPath});
+```
+
+#### chmod
+
+modify rights to remoteDestPath file
+```
+conn.sftp('chmod', {path: remoteDestPath,  mode: mode});
+```
+####connect
+
+connection config you will see [here](https://github.com/mscdex/ssh2#user-content-client-methods)
+
+#### end
+
+close the sftp connection. when you need it, you can call it in `then()` or `catch()`.
+
+```
+conn.end();
+```
+
+
+
+
+
+

test.js

@@ -14,3 +14,3 @@ let fs = require('fs');
   //.then(() => conn.sftp('readFile', {path: '/root/t.js', option: {encoding: 'utf8'}}))
-  //.then(() => conn.sftp('readdir', {path: '/root'}))
+  .then(() => conn.sftp('readdir', {path: '/root'}))
   //.then(() => {
@@ -17,0 +17,0 @@ //     let writeStream = fs.createWriteStream('./README.md');

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

10464

increased by32.86%

Number of lines in readme file

163

increased by526.92%

No dependency changes