StartTransfer Event

Fired when a file starts downloading/uploading.

Syntax

scp.on('StartTransfer', [callback])

Callback

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

function(e){ }

The argument 'e' has the following properties:

e.direction
e.localFile
e.remoteFile
e.remotePath
e.filePermissions

Remarks

The StartTransfer event fires when the file starts transferring.

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

The LocalFile, RemoteFile, and RemotePath parameters provide information about the current transfer.

The FilePermissions parameter may be used to set the remote file permissions on file currently being uploaded. It will also be populated with the current permissions of the remote file when downloading. See FilePermissions for more details.