ssh2-sftp-client 8.1.0 → 9.0.0

package/README.md

@@ -1,62 +1,65 @@
-- [Overview](#orgbeea605)
-  - [Version 8.x.x Changes](#org2589748)
-- [Installation](#orgd7b0a7e)
-- [Basic Usage](#org2e1bee4)
-- [Documentation](#orgfac43d1)
-  - [Specifying Paths](#org38509ac)
-  - [Methods](#org26ecc4f)
-    - [new SftpClient(name) ===> SFTP client object](#orga50cd31)
-    - [connect(config) ===> SFTP object](#orgbc0c617)
-    - [list(path, pattern) ==> Array[object]](#orgdfab34d)
-    - [exists(path) ==> boolean](#orgd09b949)
-    - [stat(path) ==> object](#org31bacc1)
-    - [get(path, dst, options) ==> String|Stream|Buffer](#org12ed2ca)
-    - [fastGet(remotePath, localPath, options) ===> string](#org7b0d9e8)
-    - [put(src, remotePath, options) ==> string](#orgd38e78b)
-    - [fastPut(localPath, remotePath, options) ==> string](#orge130096)
-    - [append(input, remotePath, options) ==> string](#org4f2a1b1)
-    - [mkdir(path, recursive) ==> string](#orga9acefe)
-    - [rmdir(path, recursive) ==> string](#org9e51da5)
-    - [delete(path, noErrorOK) ==> string](#org2054a87)
-    - [rename(fromPath, toPath) ==> string](#org7497d9f)
-    - [posixRename(fromPath, toPath) ==> string](#orgb179088)
-    - [chmod(path, mode) ==> string](#org335a008)
-    - [realPath(path) ===> string](#org384f34a)
-    - [cwd() ==> string](#org8fa77d4)
-    - [uploadDir(srcDir, dstDir, filter) ==> string](#orgb824235)
-    - [downloadDir(srcDir, dstDir, filter) ==> string](#org46aa66f)
-    - [end() ==> boolean](#orge3fcb81)
-    - [Add and Remove Listeners](#org4607268)
-- [Platform Quirks & Warnings](#org66a7061)
-  - [Server Capabilities](#org740553b)
-  - [Promises, Events & Managing Exceptions](#orgf97d765)
-    - [Adding Custom Handlers](#org6acf9c6)
-  - [Windows Based Servers](#orgb2f13ee)
-  - [Don't Re-use SftpClient Objects](#orgcd82e68)
-- [FAQ](#orge1aa1d7)
-  - [Remote server drops connections with only an end event](#org9296404)
-  - [How can I pass writable stream as dst for get method?](#org3e48901)
-  - [How can I upload files without having to specify a password?](#org1474028)
-  - [How can I connect through a Socks Proxy](#orgb9a0ec1)
-  - [Timeout while waiting for handshake or handshake errors](#org62e1f3a)
-  - [How can I limit upload/download speed](#org7f26ef8)
-  - [Connection hangs or fails for larger files](#orgfb52441)
-- [Examples](#orgbe2b99e)
-- [Troubleshooting](#orgd2dcb05)
-  - [Common Errors](#orgae04d0a)
-    - [Not returning the promise in a `then()` block](#org2018983)
-    - [Mixing Promise Chains and Async/Await](#org6a3654b)
-    - [Try/catch and Error Handlers](#org36087fd)
-    - [Server Differences](#orgd09c9c8)
-    - [Avoid Concurrent Operations](#org67e5a24)
-  - [Debugging Support](#org00c676b)
-- [Logging Issues](#org6f7f508)
-- [Pull Requests](#org2d2ad0d)
-- [Contributors](#orgba32989)
-
-
-
-<a id="orgbeea605"></a>
+- [Overview](#orgdb4a63c)
+  - [Version 9.x Changes](#org3c3e874)
+- [Installation](#orga783863)
+- [Basic Usage](#org2f471c4)
+- [Documentation](#orgb5102f6)
+  - [Specifying Paths](#orgdae808e)
+  - [Methods](#orga8e09d8)
+    - [new SftpClient(name) ===> SFTP client object](#org518d51a)
+    - [connect(config) ===> SFTP object](#orgda648f9)
+    - [list(path, filter) ==> Array[object]](#org3258731)
+    - [exists(path) ==> boolean](#orgaae7860)
+    - [stat(path) ==> object](#org1e4f14a)
+    - [get(path, dst, options) ==> String|Stream|Buffer](#org447f36c)
+    - [fastGet(remotePath, localPath, options) ===> string](#org54de461)
+    - [put(src, remotePath, options) ==> string](#orgee0d1ef)
+    - [fastPut(localPath, remotePath, options) ==> string](#orgb9d8ee2)
+    - [append(input, remotePath, options) ==> string](#org1eaae65)
+    - [mkdir(path, recursive) ==> string](#org1c3ab90)
+    - [rmdir(path, recursive) ==> string](#org003ef11)
+    - [delete(path, noErrorOK) ==> string](#orgd3e3a35)
+    - [rename(fromPath, toPath) ==> string](#org3343888)
+    - [posixRename(fromPath, toPath) ==> string](#orgb8f840c)
+    - [chmod(path, mode) ==> string](#org15551c9)
+    - [realPath(path) ===> string](#org4ec95c3)
+    - [cwd() ==> string](#orgc1265f0)
+    - [uploadDir(srcDir, dstDir, options) ==> string](#org5c10c06)
+    - [downloadDir(srcDir, dstDir, options) ==> string](#org614dc71)
+    - [createReadStream(remotePath, options)) ==> stream object](#org906505f)
+    - [createWriteStream(remotePath, options) ==> stream object](#orgf5b3858)
+    - [rcopy(srcPath, dstPath) ==> string](#org3716ce1)
+    - [end() ==> boolean](#org93bfcf3)
+    - [Add and Remove Listeners](#org8fe6c29)
+- [Platform Quirks & Warnings](#org763e7bf)
+  - [Server Capabilities](#org3c7ec29)
+  - [Promises, Events & Managing Exceptions](#org13e7f16)
+    - [Adding Custom Handlers](#orgbea2ca0)
+  - [Windows Based Servers](#org13d5c2b)
+  - [Don't Re-use SftpClient Objects](#org56317e1)
+- [FAQ](#orgb28c841)
+  - [Remote server drops connections with only an end event](#orgb4c1c9d)
+  - [How can I pass writable stream as dst for get method?](#orgf09bf16)
+  - [How can I upload files without having to specify a password?](#org10382e7)
+  - [How can I connect through a Socks Proxy](#org34d3eb7)
+  - [Timeout while waiting for handshake or handshake errors](#orgbe4be79)
+  - [How can I limit upload/download speed](#org36a1f06)
+  - [Connection hangs or fails for larger files](#org293ce0b)
+- [Examples](#org897888b)
+- [Troubleshooting](#orgd93090a)
+  - [Common Errors](#org44294d4)
+    - [Not returning the promise in a `then()` block](#org44783ba)
+    - [Mixing Promise Chains and Async/Await](#org1bee008)
+    - [Try/catch and Error Handlers](#org004696d)
+    - [Server Differences](#org9131050)
+    - [Avoid Concurrent Operations](#org6c9fbb1)
+  - [Debugging Support](#org52099c1)
+- [Logging Issues](#orga96ad01)
+- [Pull Requests](#org0fa18ba)
+- [Contributors](#org05880d2)
+
+
+
+<a id="orgdb4a63c"></a>
 
 # Overview
 
@@ -64,27 +67,28 @@ 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) project pages.
 
-Current stable release is **v8.1.0**.
+Current stable release is **v9.0.0**.
 
 Code has been tested against Node versions 14.19.1, 16.15.0 and 18.1.0
 
 Node versions < 12.x are not supported. However, node v10.x should still work, although some tests will fail due to changes in file system functions used in test setup and tear down.
 
 
-<a id="org2589748"></a>
+<a id="org3c3e874"></a>
 
-## Version 8.x.x Changes
+## Version 9.x Changes
 
--   **Breaking Change**: The API for `uploadDir()` and `downloadDir()` has been changed. These methods now expect a function as the optional 3rd argument. Previously, the 3rd argument was a regular expression used to filter out which files and directories should be included in the upload or download action. The method now expects a predicate function which will return true if the target is to be included in the upload or download and false if it is to be excluded. The predicate function will be called with two arguments, a full path to the target object and a boolean value which is true when the target is a directory, false otherwise. If no filter predicate is supplied, all files and directories under the initial target directory will be transferred. At this time, asynchronous filter functions are not supported.
+-   **Breaking Change**: This `list()` method no longer accepts a regular expression for filtering the entries to be returned. You can now specify a filter function instead. The function is called for each item in the list of items to be returned, passing in the item object as its only argument. Essentially, this is just a call to `Array.filter()`, so the filter function should behave in the same way i.e. return true for items to be retained and false for those to be dropped.
+-   **Breaking Change**: The ability to set `autoClose` on read and write streams and the ability to set `end` on `pipe` operations has been removed. These options caused confusion for users and were too easy to get wrong, plus it made the methods overly complicated. For those use-cases where you want to control streams at a low level, two new methods have been added, `createReadStream()` and `createWriteStream()`. However, it should be noted that client code is 100% responsible for managing streams obtained using these methods. Use at your own risk!
+-   **Breaking Change**: The 3rd argument to `uploadDir()` and `downloadDir()` methods has been change. Previously, the argument was a filter function used to select which directories and files to be transferred. The 3rd argument is now an options object with two supported properties, `filter` and `useFastput` (for `uploadDir()`) or `useFastget` (for `downloadDir()`). If `useFastput` is true, the `fastPut()` method will be pused to upload files. If `false` or missing, the slower, but better supported, `put()` method will be used. Likewise, the `useFastget` options can be set to `true` to use the `fastGet()` method for donwloading files, otherwise the slower, but more reliable, `get()` method will be used.
+-   The `uploadDir()` and `downloadDir()` methods now use asynchrounous processes to upload/download files. This should result in improved performance for these two methods.
+-   New Methods: Two new methods, `createWriteStream()` and `createReadStream()` have been added. These methods will return a stream object connected to a remote file on the `sftp` server. Client code is responsible for managing these stream objects. This includes adding any necessary event listeners and disposing of the objects once finished with them.
+-   Refactoring of Listeners: The library manages temporary listeners in order to provide a way to catch events and processes them inside a `Promise` context. Previously, every method added its own set of temporary listeners. However, this could result in multiple sets of listeners being added, especially for methods which call other methods as part of their processing e.g. `rmdir(),` `uploadDir()` and `dowqnloadDir()`. To avoid this, *internal only* versions of each method have been created. These internal methods use an *underscore* `_` prefix. Client code should not use these methods directly.
+-   New method: Added `rcopy()` method to perform a remote copy of a file on the remote SFTP server.
+-   Bumped ssh2 version to 1.11.0
 
--   Internal Change: The `rmdir()` method has been refactored to enable asynchronous deletion of files and sub-directories. This has significantly increased performance when deleting larger directory trees, especially trees which are *broad* with lots of files and directories at the same level. For deep narrow trees, there is less performance benefit because sub-directories must be removed before parents, which imposes synchronous processing. It is likely that for extremely large directory trees, the additional resources required to run large numbers of asynchronous tasks will become problematic. In such situations, it may be necessary to manually break up the deletion process into multiple `rmdir()` calls. However, this is considered a fairly extreme use case which is rare (a use case which wold also have been problematic with the old implementation as performance would have been very poor).
 
--   v8.1.0: The `list()` method now includes a `longname` property in the descriptor object for each file in the listing. The `longname` value is a string which resembles the `ls -l` listing.
-
--   v8.1.0: The `rmdir()` method has been further modified to not recurse into directories using async. It was found that on large directories, this could result in too many separate async processes. Only deletion of files is now handled with asynchronous calls.
-
-
-<a id="orgd7b0a7e"></a>
+<a id="orga783863"></a>
 
 # Installation
 
@@ -93,7 +97,7 @@ npm install ssh2-sftp-client
 ```
 
 
-<a id="org2e1bee4"></a>
+<a id="org2f471c4"></a>
 
 # Basic Usage
 
@@ -116,7 +120,7 @@ sftp.connect({
 ```
 
 
-<a id="orgfac43d1"></a>
+<a id="orgb5102f6"></a>
 
 # Documentation
 
@@ -125,7 +129,7 @@ The connection options are the same as those offered by the underlying SSH2 modu
 All the methods will return a Promise, except for `on()` and `removeListener()`, which are typically only used in special use cases.
 
 
-<a id="org38509ac"></a>
+<a id="orgdae808e"></a>
 
 ## Specifying Paths
 
@@ -158,12 +162,12 @@ client.put('/home/fred/test.txt', '/remote/dir/test-copy.txt');
 This will copy the local file `test.txt` to the remote file `test-copy.txt` in the directory `/remote/dir`.
 
 
-<a id="org26ecc4f"></a>
+<a id="orga8e09d8"></a>
 
 ## Methods
 
 
-<a id="orga50cd31"></a>
+<a id="org518d51a"></a>
 
 ### new SftpClient(name) ===> SFTP client object
 
@@ -202,7 +206,7 @@ Constructor to create a new `ssh2-sftp-client` object. An optional `name` string
     ```
 
 
-<a id="orgbc0c617"></a>
+<a id="orgda648f9"></a>
 
 ### connect(config) ===> SFTP object
 
@@ -268,14 +272,14 @@ Connect to an sftp server. Full documentation for connection options is availabl
     ```
 
 
-<a id="orgdfab34d"></a>
+<a id="org3258731"></a>
 
-### list(path, pattern) ==> Array[object]
+### list(path, filter) ==> Array[object]
 
 Retrieves a directory listing. This method returns a Promise, which once realised, returns an array of objects representing items in the remote directory.
 
 -   **path:** {String} Remote directory path
--   **pattern:** (optional) {string|RegExp} A pattern used to filter the items included in the returned array. Pattern can be a simple *glob*-style string or a regular expression. Defaults to `/.*/`.
+-   **filter:** (optional) {function} A function used to filter the items included in the returned array. The function is called for each item with the item object being passed in as the argument. The function is passed to Array.filter() to perform the filtering.
 
 1.  Example Use
 
@@ -339,7 +343,7 @@ Retrieves a directory listing. This method returns a Promise, which once realise
     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.
 
 
-<a id="orgd09b949"></a>
+<a id="orgaae7860"></a>
 
 ### exists(path) ==> boolean
 
@@ -375,7 +379,7 @@ Tests to see if remote file or directory exists. Returns type of remote object i
     ```
 
 
-<a id="org31bacc1"></a>
+<a id="org1e4f14a"></a>
 
 ### stat(path) ==> object
 
@@ -426,7 +430,7 @@ Returns the attributes associated with the object pointed to by `path`.
     ```
 
 
-<a id="org12ed2ca"></a>
+<a id="org447f36c"></a>
 
 ### get(path, dst, options) ==> String|Stream|Buffer
 
@@ -482,7 +486,7 @@ In general, if you're going to pass in a string as the destination, you are bett
     -   **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'.
 
 
-<a id="org7b0d9e8"></a>
+<a id="org54de461"></a>
 
 ### fastGet(remotePath, localPath, options) ===> string
 
@@ -525,7 +529,7 @@ Downloads a file at remotePath to localPath using parallel reads for faster thro
     ```
 
 
-<a id="orgd38e78b"></a>
+<a id="orgee0d1ef"></a>
 
 ### put(src, remotePath, options) ==> string
 
@@ -575,7 +579,7 @@ Upload data from local system to remote server. If the `src` argument is a strin
     -   **Tip:** If the src argument is a path string, consider just using `fastPut()`.
 
 
-<a id="orge130096"></a>
+<a id="orgb9d8ee2"></a>
 
 ### fastPut(localPath, remotePath, options) ==> string
 
@@ -619,7 +623,7 @@ Uploads the data in file at `localPath` to a new file on remote server at `remot
     ```
 
 
-<a id="org4f2a1b1"></a>
+<a id="org1eaae65"></a>
 
 ### append(input, remotePath, options) ==> string
 
@@ -663,7 +667,7 @@ Append the `input` data to an existing remote file. There is no integrity checki
     ```
 
 
-<a id="orga9acefe"></a>
+<a id="org1c3ab90"></a>
 
 ### mkdir(path, recursive) ==> string
 
@@ -691,7 +695,7 @@ Create a new directory. If the recursive flag is set to true, the method will cr
     ```
 
 
-<a id="org9e51da5"></a>
+<a id="org003ef11"></a>
 
 ### rmdir(path, recursive) ==> string
 
@@ -721,7 +725,7 @@ Remove a directory. If removing a directory and recursive flag is set to `true`,
     ```
 
 
-<a id="org2054a87"></a>
+<a id="orgd3e3a35"></a>
 
 ### delete(path, noErrorOK) ==> string
 
@@ -750,7 +754,7 @@ Delete a file on the remote server.
     ```
 
 
-<a id="org7497d9f"></a>
+<a id="org3343888"></a>
 
 ### rename(fromPath, toPath) ==> string
 
@@ -779,7 +783,7 @@ Rename a file or directory from `fromPath` to `toPath`. You must have the necess
     ```
 
 
-<a id="orgb179088"></a>
+<a id="orgb8f840c"></a>
 
 ### posixRename(fromPath, toPath) ==> string
 
@@ -806,7 +810,7 @@ client.connect(config)
 ```
 
 
-<a id="org335a008"></a>
+<a id="org15551c9"></a>
 
 ### chmod(path, mode) ==> string
 
@@ -835,7 +839,7 @@ Change the mode (read, write or execute permissions) of a remote file or directo
     ```
 
 
-<a id="org384f34a"></a>
+<a id="org4ec95c3"></a>
 
 ### realPath(path) ===> string
 
@@ -846,26 +850,30 @@ Converts a relative path to an absolute path on the remote server. This method i
 -   **path:** A file path, either relative or absolute. Can handle '.' and '..', but does not expand '~'.
 
 
-<a id="org8fa77d4"></a>
+<a id="orgc1265f0"></a>
 
 ### cwd() ==> string
 
 Returns what the server believes is the current remote working directory.
 
 
-<a id="orgb824235"></a>
+<a id="org5c10c06"></a>
 
-### uploadDir(srcDir, dstDir, filter) ==> string
+### uploadDir(srcDir, dstDir, options) ==> string
 
 Upload the directory specified by `srcDir` to the remote directory specified by `dstDir`. The `dstDir` will be created if necessary. Any sub directories within `srcDir` will also be uploaded. Any existing files in the remote path will be overwritten.
 
 The upload process also emits 'upload' events. These events are fired for each successfully uploaded file. The `upload` event calls listeners with 1 argument, an object which has properties source and destination. The source property is the path of the file uploaded and the destination property is the path to where the file was uploaded. The purpose of this event is to provide some way for client code to get feedback on the upload progress. You can add your own listener using the `on()` method.
 
-The optionsl *filter* argument is a function which will be called for each item to be uploaded. The function will be called with two arguments. The first argument is the full path of the item to be uploaded and the second argument is a boolean, which will be true if the target path is for a directory. The filter function will be called for each item in the source path. If the function returns true, the item will be uploaded. If it returns false, it will be filtered and not uploaded. The filter function is called via the `Array.filter` method. These array comprehension methods are known to be unsafe for asynchronous functions. Therefore, only synchronous filter functions are supported at this time.
+The 3rd argument is an options object with two supported properties, `filter` and `useFastput`.
+
+The `filter` option is a function which will be called for each item to be uploaded. The function will be called with two arguments. The first argument is the full path of the item to be uploaded and the second argument is a boolean, which will be true if the target path is for a directory. The filter function will be called for each item in the source path. If the function returns true, the item will be uploaded. If it returns false, it will be filtered and not uploaded. The filter function is called via the `Array.filter` method. These array comprehension methods are known to be unsafe for asynchronous functions. Therefore, only synchronous filter functions are supported at this time.
+
+The `useFastput` option is a boolean option. If `true`, the method will use the faster `fastPut()` method to upload files. Although this method is faster, it is not supported by all SFTP servers. Enabling this option when unsupported by the remote SFTP server will result in failures.
 
 -   **srcDir:** A local file path specified as a string
 -   **dstDir:** A remote file path specified as a string
--   **filter:** A filter predicate function which is called for each item in the source path. The argument will receive two arguments. The first is the full path to the item and the second is a boolean which will be true if the item is a directory. If the function returns true, the item will be uploaded, otherwise it will be filtered out and ignored.
+-   **options:** An options object which supports two properties, `filter` and `useFastput`. A filter predicate function which is called for each item in the source path. The argument will receive two arguments. The first is the full path to the item and the second is a boolean which will be true if the item is a directory. If the function returns true, the item will be uploaded, otherwise it will be filtered out and ignored. The `useFastput` option is a boolean option. If `true`, the method will use the faster, but less supported, `fastPut()` method to transfer files. The default is to use the slightly slower, but better supported, `put()` method.
 
 1.  Example
 
@@ -918,19 +926,21 @@ The optionsl *filter* argument is a function which will be called for each item
     ```
 
 
-<a id="org46aa66f"></a>
+<a id="org614dc71"></a>
 
-### downloadDir(srcDir, dstDir, filter) ==> string
+### downloadDir(srcDir, dstDir, options) ==> string
 
 Download the remote directory specified by `srcDir` to the local file system directory specified by `dstDir`. The `dstDir` directory will be created if required. All sub directories within `srcDir` will also be copied. Any existing files in the local path will be overwritten. No files in the local path will be deleted.
 
 The method also emites `download` events to provide a way to monitor download progress. The download event listener is called with one argument, an object with two properties, source and destination. The source property is the path to the remote file that has been downloaded and the destination is the local path to where the file was downloaded to. You can add a listener for this event using the `on()` method.
 
-The optional *filter* argument is a predicate function which will be called with two arguments for each potential item to be downloaded. The first argument is the full path of the item and the second argument is a boolean, which will be true if the item is a directory. If the function returns true, the item will be included in the download. If it returns false, it will be filtered and ignored. The filter function is called via the `Array.filter` method. These array comprehension methods are known to be unsafe for asynchronous functions. Therefore, only synchronous filter functions are supported at this time.
+The `options` argument is an options object with two supported properties, `filter` and `useFastget`. The `filter` argument is a predicate function which will be called with two arguments for each potential item to be downloaded. The first argument is the full path of the item and the second argument is a boolean, which will be true if the item is a directory. If the function returns true, the item will be included in the download. If it returns false, it will be filtered and ignored. The filter function is called via the `Array.filter` method. These array comprehension methods are known to be unsafe for asynchronous functions. Therefore, only synchronous filter functions are supported at this time.
+
+If the `useFastget` property is set to `true`, the method will use `fastGet()` to transfer files. The `fastGet` method is faster, but not supported by all SFTP services.
 
 -   **srcDir:** A remote file path specified as a string
 -   **dstDir:** A local file path specified as a string
--   **filter:** A predicate function called with two arguments, the full path to an item and a boolean value which will be true if the item is a directory. The function is called for each item in the download path.
+-   **options:** An object with two supported properties, `filter` and `useFastget`. The filter property is a function accepting two arguments, the full path to an item and a boolean value which will be true if the item is a directory. The function is called for each item in the download path and should return true to include the item and false to exclude it in the download. The `useFastget` property is a boolean. If true, the `fastGet()` method will be used to transfer files. If `false` (the default), the slower but better supported `get()` mehtod is used. .
 
 1.  Example
 
@@ -981,7 +991,49 @@ The optional *filter* argument is a predicate function which will be called with
     ```
 
 
-<a id="orge3fcb81"></a>
+<a id="org906505f"></a>
+
+### createReadStream(remotePath, options)) ==> stream object
+
+Returns a read stream object which is attached to the remote file specified by the `remotePath` argument. This is a low level method which just returns a read stream object. Client code is fully responsible for managing and releasing the resources associated with the stream once finished i.e. closing files, removing listeners etc.
+
+-   **remotePath:** A remote file path specified as a string
+-   **options:** An options object. Supported properties are
+    -   **flags:** defaults to 'r'
+    -   **encoding:** defaults to null
+    -   **handle:** defaults to null
+    -   **mode:** 0o666
+    -   **autoClose:** defaults to true. If set to false, client code is responsible for closing file descriptors when finished
+    -   **start:** Default 0. Position to start reading bytes from (inclusive)
+    -   **end:** Postion to stop reading bytes (inclusive).
+
+
+<a id="orgf5b3858"></a>
+
+### createWriteStream(remotePath, options) ==> stream object
+
+Returns a write stream object which is attached to the remote file specified in the `remotePath` argument. This is a low legvel function which just returns the stream object. Client code is fully responsible for managing that object, including closing any file descriptiors and removing listeners etc.
+
+-   **remotePath:** Path to the remote file specified as a string
+-   **options:** An object containing stream options. Supported properties include
+    -   **flags:** default 'w'
+    -   **encoding:** defulat null
+    -   **mode:** 0o666
+    -   **autoClose:** true
+    -   **start:** Byte position to start writing from (inclusive). May require changing flag to 'r+'.
+
+
+<a id="org3716ce1"></a>
+
+### rcopy(srcPath, dstPath) ==> string
+
+Perfrom a remote file copy. The file identified by the `srcPath` argument will be copied to the file specified as the `dstPath` argument. The directory where `dstPath` will be placed must exist, but the actual file must not i.e. no overwrites allowed.
+
+-   **srcPath:** Path to remote file to be copied specified as a string
+-   **dstPath:** Path to where the copy will be creaeted specified as a string
+
+
+<a id="org93bfcf3"></a>
 
 ### end() ==> boolean
 
@@ -1005,7 +1057,7 @@ Ends the current client session, releasing the client socket and associated reso
     ```
 
 
-<a id="org4607268"></a>
+<a id="org8fe6c29"></a>
 
 ### Add and Remove Listeners
 
@@ -1026,12 +1078,12 @@ Although normally not required, you can add and remove custom listeners on the s
     Removes the specified listener from the event specified in eventType. Note that the `end()` method automatically removes all listeners from the client object.
 
 
-<a id="org66a7061"></a>
+<a id="org763e7bf"></a>
 
 # Platform Quirks & Warnings
 
 
-<a id="org740553b"></a>
+<a id="org3c7ec29"></a>
 
 ## Server Capabilities
 
@@ -1040,7 +1092,7 @@ All SFTP servers and platforms are not equal. Some facilities provided by `ssh2-
 One way to determine whether an issue you are encountering is due to `ssh2-sftp-client` or due to the remote server or server platform is to use a simple CLI sftp program, such as openSSH's sftp command. If you observe the same behaviour using plain `sftp` on the command line, the issue is likely due to server or remote platform limitations. Note that you should not use a GUI sftp client, like `Filezilla` or `winSCP` as such GUI programs often attempt to hide these server and platform incompatibilities and will take additional steps to simulate missing functionality etc. You want to use a CLI program which does as little as possible.
 
 
-<a id="orgf97d765"></a>
+<a id="org13e7f16"></a>
 
 ## Promises, Events & Managing Exceptions
 
@@ -1059,14 +1111,14 @@ The other area where additional events are fired is during the end() call. To de
 In addition to the promise based event handlers, `ssh2-sftp-client` also implements global event handlers which will catch any `error`, `end` or `close` events. Essentially, these global handlers only reset the `sftp` property of the client object, effectively ensuring any subsequent calls are rejected and in the case of an error, send the error to the console.
 
 
-<a id="org6acf9c6"></a>
+<a id="orgbea2ca0"></a>
 
 ### Adding Custom Handlers
 
 While the above strategies appear to work for the majority of use cases, there are always going to be edge cases which require more flexible or powerful event handling. To support this, the `on()` and `removeListener()` methods are provided. Any event listener added using the `on()` method will be added at the beginning of the list of handlers for that event, ensuring it will be called before any global or promise local events. See the documentation for the `on()` method for details.
 
 
-<a id="orgb2f13ee"></a>
+<a id="org13d5c2b"></a>
 
 ## Windows Based Servers
 
@@ -1075,7 +1127,7 @@ It appears that when the sftp server is running on Windows, a *ECONNRESET* error
 The best way to avoid this issue is to not re-use client objects. Always generate a new sftp client object for each new connection.
 
 
-<a id="orgcd82e68"></a>
+<a id="org56317e1"></a>
 
 ## Don't Re-use SftpClient Objects
 
@@ -1084,12 +1136,12 @@ Due to an issue with *ECONNRESET* error signals when connecting to Windows based
 To avoid this problem, don't re-use SftpClient objects. Generate a new SftpClient object for each connection. You can perform multiple actions with 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.
 
 
-<a id="orge1aa1d7"></a>
+<a id="orgb28c841"></a>
 
 # FAQ
 
 
-<a id="org9296404"></a>
+<a id="orgb4c1c9d"></a>
 
 ## Remote server drops connections with only an end event
 
@@ -1100,7 +1152,7 @@ Clients first make an unauthenticated connection to the SFTP server to begin neg
 One way to avoid this type of issue is to add a delay between connection attempts. It does not need to be a very long delay - just sufficient to permit the previous connection to be authenticated. In fact, the default setting for openSSH is `10:30:60`, so you really just need to have enough delay to ensure that the 1st connection has completed authentication before the 11th connection is attempted.
 
 
-<a id="org3e48901"></a>
+<a id="orgf09bf16"></a>
 
 ## How can I pass writable stream as dst for get method?
 
@@ -1159,7 +1211,7 @@ sftp
 ```
 
 
-<a id="org1474028"></a>
+<a id="org10382e7"></a>
 
 ## How can I upload files without having to specify a password?
 
@@ -1194,7 +1246,7 @@ sftp.connect({
 ```
 
 
-<a id="orgb9a0ec1"></a>
+<a id="org34d3eb7"></a>
 
 ## How can I connect through a Socks Proxy
 
@@ -1230,7 +1282,7 @@ client.connect({
 ```
 
 
-<a id="org62e1f3a"></a>
+<a id="orgbe4be79"></a>
 
 ## Timeout while waiting for handshake or handshake errors
 
@@ -1239,7 +1291,7 @@ Some users have encountered the error 'Timeout while waiting for handshake' or '
 When encountering this type of problem, one worthwhile approach is to use openSSH's CLI sftp program with the `-v` switch to raise loggin levels. This will show you what algorithms the CLI is using. You can then use this information to match the names with the accepted algorithm names documented in the `ssh2` README to set the properties in the `algorithms` object.
 
 
-<a id="org7f26ef8"></a>
+<a id="org36a1f06"></a>
 
 ## How can I limit upload/download speed
 
@@ -1279,7 +1331,7 @@ try {
 ```
 
 
-<a id="orgfb52441"></a>
+<a id="org293ce0b"></a>
 
 ## Connection hangs or fails for larger files
 
@@ -1290,14 +1342,14 @@ A symptom of this issue is that you are able to upload small files, but uploadin
 For more explanation, see [issue #342](https://github.com/theophilusx/ssh2-sftp-client/issues/342).
 
 
-<a id="orgbe2b99e"></a>
+<a id="org897888b"></a>
 
 # Examples
 
 I have started collecting example scripts in the example directory of the repository. These are mainly scripts I have put together in order to investigate issues or provide samples for users. They are not robust, lack adequate error handling and may contain errors. However, I think they are still useful for helping developers see how the module and API can be used.
 
 
-<a id="orgd2dcb05"></a>
+<a id="orgd93090a"></a>
 
 # Troubleshooting
 
@@ -1312,14 +1364,14 @@ Note also that in the repository there are two useful directories. The first is
 The second directory is the validation directory. I have some very simple scripts in this directory which perform basic tasks using only the `ssh2` modules (no `ssh2-sftp-client` module). These can be useful when trying to determine if the issue is with the underlying `ssh2` module or the `ssh2-sftp-client` wrapper module.
 
 
-<a id="orgae04d0a"></a>
+<a id="org44294d4"></a>
 
 ## Common Errors
 
 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.
 
 
-<a id="org2018983"></a>
+<a id="org44783ba"></a>
 
 ### Not returning the promise in a `then()` block
 
@@ -1356,7 +1408,7 @@ Note the `return` statements. These ensure that the Promise returned by the clie
 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.
 
 
-<a id="org6a3654b"></a>
+<a id="org1bee008"></a>
 
 ### Mixing Promise Chains and Async/Await
 
@@ -1416,7 +1468,7 @@ async function doSftp() {
 ```
 
 
-<a id="org36087fd"></a>
+<a id="org004696d"></a>
 
 ### Try/catch and Error Handlers
 
@@ -1427,14 +1479,14 @@ The basic problem is that the try/catch block will have completed execution befo
 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 event errors. Even creating an error handler which then throws an exception won't help as the key problem is that your try/catch block has already executed. There are a number of alternative ways to deal with this situation. However, the key symptom is that you see occasional uncaught 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.
 
 
-<a id="orgd09c9c8"></a>
+<a id="org9131050"></a>
 
 ### Server Differences
 
 Not all SFTP servers are the same. Like most standards, the SFTP protocol has some level of interpretation and allows different levels of compliance. This means there can be differences in behaviour between different servers and code which works with one server will not work the same with another. For example, the value returned by *realpath* for non-existent objects can differ significantly. Some servers will throw an error for a particular operation while others will just return null, some servers support concurrent operations (such as used by fastGet/fastPut) while others will not and of course, the text of error messages can vary significantly. In particular, we have noticed significant differences across different platforms. It is therefore advisable to do comprehensive testing when the SFTP server is moved to a new platform. This includes moving from to a cloud based service even if the underlying platform remains the same. I have noticed that some cloud platforms can generate unexpected events, possibly related to additional functionality or features associated with the cloud implementation. For example, it appears SFTP servers running under Azure will generate an error event when the connection is closed even when the client has requested the connection be terminated. The same SFTP server running natively on Windows does not appear to exhibit such behaviour.
 
 
-<a id="org67e5a24"></a>
+<a id="org6c9fbb1"></a>
 
 ### Avoid Concurrent Operations
 
@@ -1443,7 +1495,7 @@ Technically, SFTP should be able to perform multiple operations concurrently. As
 If you are going to try and perform concurrent operations, you need to test extensively and ensure you are using data which is large enough that context switching does occur (i.e. the request is not completed in a single run). Some SFTP servers will handle concurrent operations better than others.
 
 
-<a id="org00c676b"></a>
+<a id="org52099c1"></a>
 
 ## Debugging Support
 
@@ -1476,7 +1528,7 @@ If you just want to see debug messages from `ssh2-sftp-client` and exclude debug
 ```
 
 
-<a id="org6f7f508"></a>
+<a id="orga96ad01"></a>
 
 # Logging Issues
 
@@ -1493,7 +1545,7 @@ I am happy to try and help diagnose and fix any issues you encounter while using
 Perhaps the best assistance is a minimal reproducible example of the issue. Once the issue can be readily reproduced, it can usually be fixed very quickly.
 
 
-<a id="org2d2ad0d"></a>
+<a id="org0fa18ba"></a>
 
 # Pull Requests
 
@@ -1508,7 +1560,7 @@ This module will adopt a standard semantic versioning policy. Please indicate in
 -   **Bug Fix:** No change to functionality or features. Simple fix of an existing bug.
 
 
-<a id="orgba32989"></a>
+<a id="org05880d2"></a>
 
 # Contributors