IPWorks SFTP 2020 Node.js Edition

Questions / Feedback?

Transfer Event

Fired during file download/upload.

Syntax

sftp.on('Transfer', [callback])

Callback

The 'callback' is called when the 'Transfer' event is emited.

function(e){ }

The argument 'e' has the following properties:

e.direction
e.localFile
e.remoteFile
e.bytesTransferred
e.percentDone
e.text (buffer)
e.cancel

Remarks

One or more Transfer events are fired during file transfer. The BytesTransferred parameter shows the number of bytes transferred since the beginning of the transfer.

Text contains the portion of the file data being delivered.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

LocalFile identifies the local file. RemoteFile is the remote file.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

To cancel the current transfer set Cancel to true.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks SFTP 2020 Node.js Edition - Version 20.0 [Build 8263]