Skip to content

Interface: TransferProgress ​

What TransferOptions.onProgress receives while bytes move.

Properties ​

PropertyTypeDescription
filesCompletednumberFiles finished so far.
fileSizenumberSize of the current file in bytes.
filesTotalnumber | undefinedTotal number of files, when known up front.
fileTransferrednumberBytes of the current file transferred so far.
pathstringPath of the file currently moving, relative to the transfer root, using /.
totalnumber | undefinedTotal bytes of the operation, when known up front. SCP downloads do not know it.
transferrednumberBytes transferred in the whole operation so far.

Released under the MIT License.