ssh2-sftp-client 5.3.1 → 5.3.2

package/CHANGELOG.org

@@ -1,38 +1,42 @@
 * Change Logging
 
-** V5.3.1 (Prod Version)
+** Version 5.3.2 (Prod Version)
+   - Minor README typo fixes
+   - Fix error in local file path checks (#294)
+
+** V5.3.1
    - Fix bug in handling of relative local paths
    - Change handling of stream closures in ~get()~ and ~put()~ methods
 
-** v5.3.0 
+** v5.3.0
    - Refine event handler management
    - Fix path processing for win32 based sftp servers
-   - Update documentation 
-** v5.2.2 
+   - Update documentation
+** v5.2.2
    - Bug fix release. Add error code 4 check to stat() method.
    - bump Mocha version for tests
 
 ** v5.2.1
    - Move some dependencies into dev-Dependencies
-** v5.2.0 
-   - Add new method posixRename() which uses the openSSH POSIX rename extension. 
+** v5.2.0
+   - Add new method posixRename() which uses the openSSH POSIX rename extension.
 ** v5.1.3
    - Fix bug when writing to root directory and failure due to not being able to
      determine parent
    - Refactor some tests to eliminate need to have artificial delays between
      tests
    - Bumped some dependency versions to latest version
-** v5.1.2 
+** v5.1.2
    - Added back global close handler
    - Added dumpListeners() method
-   
-** v5.1.1 
-   - Added separate close handlers to each method. 
+
+** v5.1.1
+   - Added separate close handlers to each method.
    - Added missing return statement in connect method
-   - Added additional troubleshooting documentation for 
+   - Added additional troubleshooting documentation for
      common errors.
 
-** v5.1.0 
+** v5.1.0
    - Fix bug in checkRemotePath() relating to handling of badly
      specified paths (issue #213)
    - Added additional debugging support

package/README.md

@@ -17,6 +17,7 @@
   - [Version 5.2.2](#sec-4-11)
   - [Version 5.3.0](#sec-4-12)
   - [Version 5.3.1](#sec-4-13)
+  - [Version 5.3.2](#sec-4-14)
 - [Documentation](#sec-5)
   - [Specifying Paths](#sec-5-1)
   - [Methods](#sec-5-2)
@@ -72,7 +73,7 @@ an SFTP client for node.js, a wrapper around [SSH2](https://github.com/mscdex/ss
 
 Documentation on the methods and available options in the underlying modules can be found on the [SSH2](https://github.com/mscdex/ssh2) and [SSH2-STREAMS](https://github.com/mscdex/ssh2-streams/blob/master/SFTPStream.md) project pages.
 
-Current stable release is **v5.3.1**.
+Current stable release is **v5.3.2**.
 
 Code has been tested against Node versions 12.18.2 and 13.14.0
 
@@ -82,6 +83,12 @@ Node versions < 10.x are not supported.
 
 A bug report hass been logged against the ssh2-streams library as [issue 156](https://github.com/mscdex/ssh2-streams/issues/156).
 
+<span class="underline">UPDATE</span>: The author of the upstream ssh2 and ssh2-streams module has decided on a re-write of the ssh2 module to address the above issues as well as some other design limitations and to allow the module to better fit in with newer versions of node. As part of that process, the functionality of ssh2-streams is being incorporated into the main ssh2 module and the ssh2-streams module is being deprecated. This will require a significant update to this module and may result in some API changes, depending on what changes in the re-write of ssh2.
+
+To support these changes, a new branch called *version-6* has been created. This branch will use the newest version of ssh2 and for now is very much experimental and subject to change.
+
+<span class="underline">UPDATE</span>: Apparently the change in core node which cause the issue with ssh2 has been rolled back in node version 15.3.0. Testing seems to indicate the above issue does not exist in that version of node.
+
 # Installation<a id="sec-2"></a>
 
 ```shell
@@ -213,6 +220,11 @@ In addition to the Promise error handlers, there is a default error handler whic
 -   Fix bug in handling of relative local paths
 -   Modified `get()` and `put()` methods to support special purpose streams which require `autoClose` to be `false`. These methods will now look for the `autoClose: false` property in the options object and if it is false, will issue a `destroy()` on the underlying stream just before the promise is resolved. The default is `autoClose: true` and this default should be used unless there is a known specific reason to change it to false.
 
+## Version 5.3.2<a id="sec-4-14"></a>
+
+-   Minor README typo fixes
+-   Fix error in local file path checks (#294)
+
 # Documentation<a id="sec-5"></a>
 
 The connection options are the same as those offered by the underlying SSH2 module. For full details, please see [SSH2 client methods](https://github.com/mscdex/ssh2#user-content-client-methods)
@@ -263,17 +275,17 @@ Constructor to create a new `ssh2-sftp-client` object. An optional `name` string
 
     ```javascript
     'use strict';
-    
+
     const Client = require('ssh2-sftp-client');
-    
+
     const config = {
       host: 'example.com',
       username: 'donald',
       password: 'my-secret'
     };
-    
+
     const sftp = new Client('example-client');
-    
+
     sftp.connect(config)
       .then(() => {
         return sftp.cwd();
@@ -294,12 +306,12 @@ Connect to an sftp server. Full documentation for connection options is availabl
 1.  Connection Options
 
     This module is based on the excellent [SSH2](https://github.com/mscdex/ssh2#client) module. That module is a general SSH2 client and server library and provides much more functionality than just SFTP connectivity. Many of the connect options provided by that module are less relevant for SFTP connections. It is recommended you keep the config options to the minimum needed and stick to the options listed in the `commonOpts` below.
-    
+
     The `retries`, `retry_factor` and `retry_minTimeout` options are not part of the SSH2 module. These are part of the configuration for the [retry](https://www.npmjs.com/package/retry) package and what is used to enable retrying of sftp connection attempts. See the documentation for that package for an explanation of these values.
-    
+
     ```javascript
     // common options
-    
+
     let commonOpts {
       host: 'localhost', // string Hostname or IP of server.
       port: 22, // Port number of the server.
@@ -309,7 +321,7 @@ Connect to an sftp server. Full documentation for connection options is availabl
       password: 'borsch', // string Password for password-based user authentication
       agent: process.env.SSH_AGENT, // string - Path to ssh-agent's UNIX socket
       privateKey: fs.readFileSync('/path/to/key'), // Buffer or string that contains
-      passphrase; 'a pass phrase', // string - For an encrypted private key
+      passphrase: 'a pass phrase', // string - For an encrypted private key
       readyTimeout: 20000, // integer How long (in ms) to wait for the SSH handshake
       strictVendor: true // boolean - Performs a strict server vendor check
       debug: myDebug // function - Set this to a function that receives a single
@@ -318,9 +330,9 @@ Connect to an sftp server. Full documentation for connection options is availabl
       retry_factor: 2 // integer. Time factor used to calculate time between retries
       retry_minTimeout: 2000 // integer. Minimum timeout between attempts
     };
-    
+
     // rarely used options
-    
+
     let advancedOpts {
       localAddress,
       localPort,
@@ -361,16 +373,16 @@ Retrieves a directory listing. This method returns a Promise, which once realise
 
     ```javascript
     const Client = require('ssh2-sftp-client');
-    
+
     const config = {
       host: 'example.com',
       port: 22,
       username: 'red-don',
       password: 'my-secret'
     };
-    
+
     let sftp = new Client;
-    
+
     sftp.connect(config)
       .then(() => {
         return sftp.list('/path/to/remote/dir');
@@ -389,7 +401,7 @@ Retrieves a directory listing. This method returns a Promise, which once realise
 2.  Return Objects
 
     The objects in the array returned by `list()` have the following properties;
-    
+
     ```javascript
     {
       type: // file type(-, d, l)
@@ -410,11 +422,11 @@ Retrieves a directory listing. This method returns a Promise, which once realise
 3.  Pattern Filter
 
     The filter options can be a regular expression (most powerful option) or a simple *glob*-like string where \* will match any number of characters, e.g.
-    
+
         foo* => foo, foobar, foobaz
         *bar => bar, foobar, tabbar
         *oo* => foo, foobar, look, book
-    
+
     The *glob*-style matching is very simple. In most cases, you are best off using a real regular expression which will allow you to do more powerful matching and anchor matches to the beginning/end of the string etc.
 
 ### exists(path) ==> boolean<a id="sec-5-2-4"></a>
@@ -425,16 +437,16 @@ Tests to see if remote file or directory exists. Returns type of remote object i
 
     ```javascript
     const Client = require('ssh2-sftp-client');
-    
+
     const config = {
       host: 'example.com',
       port: 22,
       username: 'red-don',
       password: 'my-secret'
     };
-    
+
     let sftp = new Client;
-    
+
     sftp.connect(config)
       .then(() => {
         return sftp.exists('/path/to/remote/dir');
@@ -459,7 +471,7 @@ Returns the attributes associated with the object pointed to by `path`.
 1.  Attributes
 
     The `stat()` method returns an object with the following properties;
-    
+
     ```javascript
     let stats = {
       mode: 33279, // integer representing type and permissions
@@ -482,7 +494,7 @@ Returns the attributes associated with the object pointed to by `path`.
 
     ```javascript
     let client = new Client();
-    
+
     client.connect(config)
       .then(() => {
         return client.stat('/path/to/remote/file');
@@ -511,7 +523,7 @@ In general, if your going to pass in a string as the destination, you are better
 1.  Options
 
     The options object can be used to pass options to the underlying readStream used to read the data from the remote server.
-    
+
     ```javascript
     {
       flags: 'r',
@@ -521,17 +533,17 @@ In general, if your going to pass in a string as the destination, you are better
       autoClose: true
     }
     ```
-    
+
     Most of the time, you won't want to use any options. Sometimes, it may be useful to set the encoding. For example, to 'utf-8'. However, it is important not to do this for binary files to avoid data corruption.
 
 2.  Example Use
 
     ```javascript
     let client = new Client();
-    
+
     let remotePath = '/remote/server/path/file.txt';
     let dst = fs.createWriteStream('/local/file/path/copy.txt');
-    
+
     client.connect(config)
       .then(() => {
         return client.get(remotePath, dst);
@@ -543,7 +555,7 @@ In general, if your going to pass in a string as the destination, you are better
         console.error(err.message);
       });
     ```
-    
+
     -   **Tip:** See examples file in the Git repository for more examples. You can pass any writeable stream in as the destination. For example, if you pass in `zlib.createGunzip()` writeable stream, you can both download and decompress a gzip file 'on the fly'.
 
 ### fastGet(remotePath, localPath, options) ===> string<a id="sec-5-2-7"></a>
@@ -564,7 +576,7 @@ Downloads a file at remotePath to localPath using parallel reads for faster thro
                                                       // chunk is transferred
     }
     ```
-    
+
     -   **Warning:** Some servers do not respond correctly to requests to alter chunk size. This can result in lost or corrupted data.
 
 2.  Sample Use
@@ -573,7 +585,7 @@ Downloads a file at remotePath to localPath using parallel reads for faster thro
     let client = new Client();
     let remotePath = '/server/path/file.txt';
     let localPath = '/local/path/file.txt';
-    
+
     client.connect(config)
       .then(() => {
         client.fastGet(remotePath, localPath);
@@ -597,7 +609,7 @@ Upload data from local system to remote server. If the `src` argument is a strin
 1.  Options
 
     The following options are supported;
-    
+
     ```javascript
     {
       flags: 'w',  // w - write and a - append
@@ -606,17 +618,17 @@ Upload data from local system to remote server. If the `src` argument is a strin
       autoClose: true // automatically close the write stream when finished
     }
     ```
-    
+
     The most common options to use are mode and encoding. The values shown above are the defaults. You do not have to set encoding to utf-8 for text files, null is fine for all file types. However, using utf-8 encoding for binary files will often result in data corruption.
 
 2.  Example Use
 
     ```javascript
     let client = new Client();
-    
+
     let data = fs.createReadStream('/path/to/local/file.txt');
     let remote = '/path/to/remote/file.txt';
-    
+
     client.connect(config)
       .then(() => {
         return client.put(data, remote);
@@ -628,7 +640,7 @@ Upload data from local system to remote server. If the `src` argument is a strin
         console.error(err.message);
       });
     ```
-    
+
     -   **Tip:** If the src argument is a path string, consider just using `fastPut()`.
 
 ### fastPut(localPath, remotePath, options) ==> string<a id="sec-5-2-9"></a>
@@ -650,7 +662,7 @@ Uploads the data in file at `localPath` to a new file on remote server at `remot
       // a part of a file was transferred
     }
     ```
-    
+
     -   **Warning:** There have been reports that some SFTP servers will not honour requests for non-default chunk sizes. This can result in data loss or corruption.
 
 2.  Example Use
@@ -659,7 +671,7 @@ Uploads the data in file at `localPath` to a new file on remote server at `remot
     let localFile = '/path/to/file.txt';
     let remoteFile = '/path/to/remote/file.txt';
     let client = new Client();
-    
+
     client.connect(config)
       .then(() => {
         client.fastPut(localFile, remoteFile);
@@ -683,7 +695,7 @@ Append the `input` data to an existing remote file. There is no integrity checki
 1.  Options
 
     The following options are supported;
-    
+
     ```javascript
     {
       flags: 'a',  // w - write and a - append
@@ -692,7 +704,7 @@ Append the `input` data to an existing remote file. There is no integrity checki
       autoClose: true // automatically close the write stream when finished
     }
     ```
-    
+
     The most common options to use are mode and encoding. The values shown above are the defaults. You do not have to set encoding to utf-8 for text files, null is fine for all file types. Generally, I would not attempt to append binary files.
 
 2.  Example Use
@@ -700,7 +712,7 @@ Append the `input` data to an existing remote file. There is no integrity checki
     ```javascript
     let remotePath = '/path/to/remote/file.txt';
     let client = new Client();
-    
+
     client.connect(config)
       .then(() => {
         return client.append(Buffer.from('Hello world'), remotePath);
@@ -725,7 +737,7 @@ Create a new directory. If the recursive flag is set to true, the method will cr
     ```javascript
     let remoteDir = '/path/to/new/dir';
     let client = new Client();
-    
+
     client.connect(config)
       .then(() => {
         return client.mkdir(remoteDir, true);
@@ -752,7 +764,7 @@ Remove a directory. If removing a directory and recursive flag is set to `true`,
     ```javascript
     let remoteDir = '/path/to/remote/dir';
     let client = new Client();
-    
+
     client.connect(config)
       .then(() => {
         return client.rmdir(remoteDir, true);
@@ -776,7 +788,7 @@ Delete a file on the remote server.
     ```javascript
     let remoteFile = '/path/to/remote/file.txt';
     let client = new Client();
-    
+
     client.connect(config)
       .then(() => {
         return client.delete(remoteFile);
@@ -802,7 +814,7 @@ Rename a file or directory from `fromPath` to `toPath`. You must have the necess
     let from = '/remote/path/to/old.txt';
     let to = '/remote/path/to/new.txt';
     let client = new Client();
-    
+
     client.connect(config)
       .then(() => {
         return client.rename(from, to);
@@ -850,9 +862,9 @@ Change the mode (read, write or execute permissions) of a remote file or directo
 
     ```javascript
     let path = '/path/to/remote/file.txt';
-    let ndwMode = 0o644;  // rw-r-r
+    let newMode = 0o644;  // rw-r-r
     let client = new Client();
-    
+
     client.connect(config)
       .then(() => {
         return client.chmod(path, newMode);
@@ -890,28 +902,28 @@ The upload process also emits 'upload' events. These events are fired for each s
 
     ```javascript
         'use strict';
-    
+
         // Example of using the uploadDir() method to upload a directory
         // to a remote SFTP server
-    
+
         const path = require('path');
         const SftpClient = require('../src/index');
-    
+
         const dotenvPath = path.join(__dirname, '..', '.env');
         require('dotenv').config({path: dotenvPath});
-    
+
         const config = {
     host: process.env.SFTP_SERVER,
     username: process.env.SFTP_USER,
     password: process.env.SFTP_PASSWORD,
     port: process.env.SFTP_PORT || 22
         };
-    
+
         async function main() {
     const client = new SftpClient('upload-test');
     const src = path.join(__dirname, '..', 'test', 'testData', 'upload-src');
     const dst = '/home/tim/upload-test';
-    
+
     try {
       await client.connect(config);
       client.on('upload', info => {
@@ -923,7 +935,7 @@ The upload process also emits 'upload' events. These events are fired for each s
       client.end();
     }
         }
-    
+
         main()
     .then(msg => {
       console.log(msg);
@@ -931,7 +943,7 @@ The upload process also emits 'upload' events. These events are fired for each s
     .catch(err => {
       console.log(`main error: ${err.message}`);
     });
-    
+
     ```
 
 ### downloadDir(srcDir, dstDir) ==> string<a id="sec-5-2-20"></a>
@@ -947,28 +959,28 @@ The method also emites `download` events to provide a way to monitor download pr
 
     ```javascript
     'use strict';
-    
+
     // Example of using the downloadDir() method to upload a directory
     // to a remote SFTP server
-    
+
     const path = require('path');
     const SftpClient = require('../src/index');
-    
+
     const dotenvPath = path.join(__dirname, '..', '.env');
     require('dotenv').config({path: dotenvPath});
-    
+
     const config = {
       host: process.env.SFTP_SERVER,
       username: process.env.SFTP_USER,
       password: process.env.SFTP_PASSWORD,
       port: process.env.SFTP_PORT || 22
     };
-    
+
     async function main() {
       const client = new SftpClient('upload-test');
       const dst = '/tmp';
       const src = '/home/tim/upload-test';
-    
+
       try {
         await client.connect(config);
         client.on('download', info => {
@@ -980,7 +992,7 @@ The method also emites `download` events to provide a way to monitor download pr
         client.end();
       }
     }
-    
+
     main()
       .then(msg => {
         console.log(msg);
@@ -988,7 +1000,7 @@ The method also emites `download` events to provide a way to monitor download pr
       .catch(err => {
         console.log(`main error: ${err.message}`);
       });
-    
+
     ```
 
 ### end() ==> boolean<a id="sec-5-2-21"></a>
@@ -999,7 +1011,7 @@ Ends the current client session, releasing the client socket and associated reso
 
     ```javascript
     let client = new Client();
-    
+
     client.connect(config)
       .then(() => {
         // do some sftp stuff
@@ -1270,7 +1282,7 @@ sftp.connect(config)
   });
 ```
 
-In the above code, the `sftp.end()` method will almost certainly be called before `sftp.gastGet()` has been fulfilled (unless the *foo.txt* file is really small!). In fact, the whole promise chain will complete and exit even before the `sftp.end()` call has been fulfilled. The correct code would be something like
+In the above code, the `sftp.end()` method will almost certainly be called before `sftp.fastGet()` has been fulfilled (unless the *foo.txt* file is really small!). In fact, the whole promise chain will complete and exit even before the `sftp.end()` call has been fulfilled. The correct code would be something like
 
 ```javascript
 sftp.connect(config)
@@ -1421,3 +1433,4 @@ Thanks to the following for their contributions -
 -   **jhorbulyk:** Contributed posixRename() functionality
 -   **teenangst:** Contributed fix for error code 4 in stat() method
 -   **kennylbj:** Contributed example of using a throttle stream to limit upload/download bandwidth.
+-   **anton-erofeev:** Documentation fix

package/README.org

@@ -9,7 +9,7 @@ convenience abstraction as well as a Promise based API.
 Documentation on the methods and available options in the underlying modules can
 be found on the [[https://github.com/mscdex/ssh2][SSH2]] and [[https://github.com/mscdex/ssh2-streams/blob/master/SFTPStream.md][SSH2-STREAMS]]  project pages.
 
-Current stable release is *v5.3.1*.
+Current stable release is *v5.3.2*.
 
 Code has been tested against Node versions 12.18.2 and 13.14.0
 
@@ -23,7 +23,23 @@ affect fastput, fastget, put and possibly get operations. Until this issue is
 resolved and a new version of ssh2/ssh2-streams is released, using node v14 is
 not recommended.
 
-A bug report hass been logged against the ssh2-streams library as [[https://github.com/mscdex/ssh2-streams/issues/156][issue 156]].  
+A bug report hass been logged against the ssh2-streams library as [[https://github.com/mscdex/ssh2-streams/issues/156][issue 156]].
+
+_UPDATE_: The author of the upstream ssh2 and ssh2-streams module has decided on
+a re-write of the ssh2 module to address the above issues as well as some other
+design limitations and to allow the module to better fit in with newer versions
+of node. As part of that process, the functionality of ssh2-streams is being
+incorporated into the main ssh2 module and the ssh2-streams module is being
+deprecated. This will require a significant update to this module and may result
+in some API changes, depending on what changes in the re-write of ssh2.
+
+To support these changes, a new branch called /version-6/ has been created. This
+branch will use the newest version of ssh2 and for now is very much experimental
+and subject to change.
+
+_UPDATE_: Apparently the change in core node which cause the issue with ssh2 has
+been rolled back in node version 15.3.0. Testing seems to indicate the above
+issue does not exist in that version of node.
 
 * Installation
 
@@ -225,7 +241,7 @@ reset to false in preparation for the next error.
    - Fix bug in checkRemotePath() relating to poor path specifications where
      you cannot determine parent directory.
 
-** Version 5.1.1 
+** Version 5.1.1
    - Bug fix for unexpected close of connections. It would seem that a
      connections can be unexpectedly closed without an accompanying error event.
      As methods only looked for error events, the method promise wold never
@@ -240,26 +256,26 @@ reset to false in preparation for the next error.
      inside promise chains. Common symptom is what appears to be truncated file
      upload/download. What is really happening is that the end method is being
      called before the transfer has completed.
-     
-** Version 5.1.2 
+
+** Version 5.1.2
    - Mainly a bug fix. We needed to add back a global close listener to ensure
-     the sftp object is unset whenever a close event occurs. As close events can 
+     the sftp object is unset whenever a close event occurs. As close events can
      occur outside main method calls, only having method based listeners was not
      sufficient.
    - Also added a utils.dumpListeners() method, useful when debugging issues with
      listener 'leakage' due to failure to remove listeners when no longer required.
-     
+
 ** Version 5.1.3
   - Fix issue with permissions for writing to root directory
   - Cleanup tests to use less connections and eliminate need for test delays
-  - Bumped some dependencies to latest versions  
+  - Bumped some dependencies to latest versions
 ** Version 5.2.0
    - Add posixRename() method. This is an openssh extension added in openssh
      v4.8 and will only work on servers which support this extension.conflict
    - Bumped through2 dependency version to 4.0.2
 
 ** Version 5.2.1
-   - Move some dev dependencies from dependencies to devDependencies. 
+   - Move some dev dependencies from dependencies to devDependencies.
 ** Version 5.2.2
    - Bug fix. Some servers appear to issue errors with code 4 instead of code 2
      for file not found errors. This version adds checks for error code 4 to the
@@ -285,7 +301,9 @@ reset to false in preparation for the next error.
      will issue a ~destroy()~ on the underlying stream just before the promise
      is resolved. The default is ~autoClose: true~ and this default should be
      used unless there is a known specific reason to change it to false.
-     
+** Version 5.3.2
+   - Minor README typo fixes
+   - Fix error in local file path checks (#294)
 * Documentation
 
 The connection options are the same as those offered by the underlying SSH2
@@ -424,7 +442,7 @@ for that package for an explanation of these values.
     password: 'borsch', // string Password for password-based user authentication
     agent: process.env.SSH_AGENT, // string - Path to ssh-agent's UNIX socket
     privateKey: fs.readFileSync('/path/to/key'), // Buffer or string that contains
-    passphrase; 'a pass phrase', // string - For an encrypted private key
+    passphrase: 'a pass phrase', // string - For an encrypted private key
     readyTimeout: 20000, // integer How long (in ms) to wait for the SSH handshake
     strictVendor: true // boolean - Performs a strict server vendor check
     debug: myDebug // function - Set this to a function that receives a single
@@ -965,7 +983,7 @@ Delete a file on the remote server.
 Rename a file or directory from ~fromPath~ to ~toPath~. You must have the
 necessary permissions to modify the remote file.
 
-- fromPath :: string. Path to existing file to be renamed 
+- fromPath :: string. Path to existing file to be renamed
 - toPath :: string. Path to new file existing file is to be renamed to. Should
   not already exist.
 
@@ -989,7 +1007,7 @@ necessary permissions to modify the remote file.
 #+end_src
 
 *** posixRename(fromPath, toPath) ==> string
-    
+
 This method uses the openssh POSIX rename extension introduced in OpenSSH 4.8.
 The advantage of this version of rename over standard SFTP rename is that it is
 an atomic operation and will allow renaming a resource where the destination
@@ -1019,7 +1037,7 @@ protocol and therefore is not supported on all sSFTP servers.
       console.error(err.message);
     });
 #+end_src
-    
+
 *** chmod(path, mode) ==> string
 
 Change the mode (read, write or execute permissions) of a remote file or
@@ -1032,7 +1050,7 @@ directory.
 
 #+begin_src javascript
   let path = '/path/to/remote/file.txt';
-  let ndwMode = 0o644;  // rw-r-r
+  let newMode = 0o644;  // rw-r-r
   let client = new Client();
 
   client.connect(config)
@@ -1050,7 +1068,7 @@ directory.
 *** realPath(path) ===> string
 
 Converts a relative path to an absolute path on the remote server. This method
-is mainly used internally to resolve remote path names. 
+is mainly used internally to resolve remote path names.
 
 *Warning*: Currently, there is a platform inconsistency with this method on
 win32 platforms. For servers running on non-win32 platforms, providing a path
@@ -1100,36 +1118,36 @@ using the ~on()~ method.
        require('dotenv').config({path: dotenvPath});
 
        const config = {
-	 host: process.env.SFTP_SERVER,
-	 username: process.env.SFTP_USER,
-	 password: process.env.SFTP_PASSWORD,
-	 port: process.env.SFTP_PORT || 22
+   host: process.env.SFTP_SERVER,
+   username: process.env.SFTP_USER,
+   password: process.env.SFTP_PASSWORD,
+   port: process.env.SFTP_PORT || 22
        };
 
        async function main() {
-	 const client = new SftpClient('upload-test');
-	 const src = path.join(__dirname, '..', 'test', 'testData', 'upload-src');
-	 const dst = '/home/tim/upload-test';
-
-	 try {
-	   await client.connect(config);
-	   client.on('upload', info => {
-	     console.log(`Listener: Uploaded ${info.source}`);
-	   });
-	   let rslt = await client.uploadDir(src, dst);
-	   return rslt;
-	 } finally {
-	   client.end();
-	 }
+   const client = new SftpClient('upload-test');
+   const src = path.join(__dirname, '..', 'test', 'testData', 'upload-src');
+   const dst = '/home/tim/upload-test';
+
+   try {
+     await client.connect(config);
+     client.on('upload', info => {
+       console.log(`Listener: Uploaded ${info.source}`);
+     });
+     let rslt = await client.uploadDir(src, dst);
+     return rslt;
+   } finally {
+     client.end();
+   }
        }
 
        main()
-	 .then(msg => {
-	   console.log(msg);
-	 })
-	 .catch(err => {
-	   console.log(`main error: ${err.message}`);
-	 });
+   .then(msg => {
+     console.log(msg);
+   })
+   .catch(err => {
+     console.log(`main error: ${err.message}`);
+   });
 
      #+end_src
 
@@ -1180,7 +1198,7 @@ the ~on()~ method.
     try {
       await client.connect(config);
       client.on('download', info => {
-	console.log(`Listener: Download ${info.source}`);
+  console.log(`Listener: Download ${info.source}`);
       });
       let rslt = await client.downloadDir(src, dst);
       return rslt;
@@ -1245,7 +1263,7 @@ Removes the specified listener from the event specified in eventType. Note that
 the ~end()~ method automatically removes all listeners from the client object.
 
 * Platform Quirks & Warnings
-** Server Capabilities 
+** Server Capabilities
 
    All SFTP servers and platforms are not equal. Some facilities provided by
    ~ssh2-sfto-client~ either depend on capabilities of the remote server or the
@@ -1352,7 +1370,7 @@ the ~end()~ method automatically removes all listeners from the client object.
    a single connection e.g. upload multiple files, download multiple files etc,
    but after you have called end(), you should not try to re-use the object with
    a further connect() call. Create a new object instead.
-   
+
 * FAQ
 
 ** Remote server drops connections with only an end event
@@ -1532,7 +1550,7 @@ issue.
    data, you can use a stream to limit throughput. The following example was
    provided by /kennylbj/. Note that there is a caveat that we must set the
    ~autoClose~ flag to false to avoid calling an extra ~_read()~ on a closed stream
-   that may cause _get Permission Denied error in ssh2-streams. 
+   that may cause _get Permission Denied error in ssh2-streams.
 
 
    #+begin_src javascript
@@ -1618,7 +1636,7 @@ trying to determine if the issue is with the underlying ~ssh2~ and
    There are some common errors people tend to make when using Promises or
    Asyc/Await. These are by far the most common problem found in issues logged
    against this module. Please check for some of these before logging your
-   issue. 
+   issue.
 
 *** Not returning the promise in a ~then()~ block
 
@@ -1628,9 +1646,9 @@ trying to determine if the issue is with the underlying ~ssh2~ and
     generates. Failing to do this will result in the ~then()~ block completing
     and your code starting execution of the next ~then()~, ~catch()~ or
     ~finally()~ block before your promise has been fulfilled. For exmaple, the
-    following will not do what you expect 
+    following will not do what you expect
 
-    #+begin_src javascript 
+    #+begin_src javascript
       sftp.connect(config)
         .then(() => {
           sftp.fastGet('foo.txt', 'bar.txt');
@@ -1641,14 +1659,14 @@ trying to determine if the issue is with the underlying ~ssh2~ and
           console.error(e.message);
         });
     #+end_src
-   
+
     In the above code, the ~sftp.end()~ method will almost certainly be called
-    before ~sftp.gastGet()~ has been fulfilled (unless the /foo.txt/ file is
+    before ~sftp.fastGet()~ has been fulfilled (unless the /foo.txt/ file is
     really small!). In fact, the whole promise chain will complete and exit even
     before the ~sftp.end()~ call has been fulfilled. The correct code would be
-    something like 
-    
-    #+begin_src javascript 
+    something like
+
+    #+begin_src javascript
       sftp.connect(config)
         .then(() => {
           return sftp.fastGet('foo.txt', 'bar.txt');
@@ -1659,20 +1677,20 @@ trying to determine if the issue is with the underlying ~ssh2~ and
           console.error(e.message);
         });
     #+end_src
-    
+
     Note the ~return~ statements. These ensure that the Promise returned by the
     client method is returned into the promise chain. It will be this promise
     the next block in the chain will wait on to be fulfilled before the next
     block is executed. Without the return statement, that block will return the
     default promise for that block, which essentially says /this block has been
     fulfilled/. What you really want is the promise which says /your sftp client
-    method call has been fulfilled/. 
+    method call has been fulfilled/.
 
     A common symptom of this type of error is for file uploads or download to
     fail to complete or for data in those files to be truncated. What is
     happening is that the connection is being ended before the transfer has
-    completed. 
-    
+    completed.
+
 *** Mixing Promise Chains and Async/Await
 
     Another common error is to mix Promise chains and async/await calls. This is
@@ -1706,14 +1724,14 @@ trying to determine if the issue is with the underlying ~ssh2~ and
     returning is a fulfilled promise which says the ~then()~ block has been run
     (note that the await'ed promise is not being returned and is therefore
     outside the main Promise chain). As a result, the ~finally()~ block will be
-    executed before the await promise has been fulfilled. 
+    executed before the await promise has been fulfilled.
 
     Using async/await inside the promise chain has created unnecessary
     complexity and leads to incorrect assumptions regarding how the code will
     execute. A quick glance at the code is likely to give the impression that
     execution will wait for the ~sftp.fastGet()~ call to be fulfilled before
     continuing. This is not the case. The code would be more clearly expressed
-    as either 
+    as either
 
     #+begin_src javascript
       sftp.connect(config)
@@ -1728,7 +1746,7 @@ trying to determine if the issue is with the underlying ~ssh2~ and
           return sftp.end();
         });
     #+end_src
-    
+
    *or, using async/await*
 
    #+begin_src javascript
@@ -1752,14 +1770,14 @@ trying to determine if the issue is with the underlying ~ssh2~ and
     signals, such as an error event. In general, you cannot use try/catch blocks
     for asynchronous code and expect errors to be caught by the ~catch~ block.
     Handling errors in asynchronous code is one of the key reasons we now have
-    the Promise and async/await frameworks. 
+    the Promise and async/await frameworks.
 
     The basic problem is that the try/catch block will have completed execution
     before the asynchronous code has completed. If the asynchronous code has not
     compleed, then there is a potential for it to raise an error. However, as
     the try/catch block has already completed, there is no /catch/ waiting to
     catch the error. It will bubble up and probably result in your script
-    exiting with an uncaught exception error. 
+    exiting with an uncaught exception error.
 
     Error events are essentially asynchronous code. You don't know when such
     events will fire. Therefore, you cannot use a try/catch block to catch such
@@ -1770,8 +1788,8 @@ trying to determine if the issue is with the underlying ~ssh2~ and
     error exceptions that cause your script to exit abnormally despite having
     try/catch blocks in your script. What you need to do is look at your code
     and find where errors are raised asynchronously and use an event handler or
-    some other mechanism to manage any errors raised.  
-    
+    some other mechanism to manage any errors raised.
+
 ** Debugging Support
 
 You can add a ~debug~ property to the config object passed in to ~connect()~ to
@@ -1864,3 +1882,4 @@ Thanks to the following for their contributions -
 - teenangst :: Contributed fix for error code 4 in stat() method
 - kennylbj :: Contributed example of using a throttle stream to limit
   upload/download bandwidth.
+- anton-erofeev :: Documentation fix

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ssh2-sftp-client",
-  "version": "5.3.1",
+  "version": "5.3.2",
   "description": "ssh2 sftp client for node",
   "main": "src/index.js",
   "repository": {
@@ -32,7 +32,7 @@
     "checksum": "^0.1.1",
     "dotenv": "^8.2.0",
     "mocha": "^8.1.3",
-    "moment": "^2.27.0",
+    "moment": "^2.29.0",
     "through2": "^4.0.2"
   }
 }

package/src/index.js

@@ -598,9 +598,9 @@ class SftpClient {
       this.debugMsg('fastGet local path info ', localInfo);
       if (!localInfo.valid) {
         let e = utils.formatError(
-          localInfo.parentMsg,
+          localInfo.msg,
           'fastGet',
-          localInfo.parentCode
+          localInfo.code
         );
         throw e;
       }

package/src/utils.js

@@ -131,7 +131,7 @@ function makeCloseListener(client, reject, name) {
   return function () {
     if (!client.endCalled) {
       if (reject) {
-        reject(formatError('Connection closed unepectedly', name));
+        reject(formatError('Connection closed unexpectedly', name));
       } else {
         console.error(`${client.clientName}: Connection closed unexpectedly`);
       }