IPWorks SSH 2020 JavaScript Edition

Questions / Feedback?

Transfer Event

Fired during file download/upload.

Syntax

scp.on('Transfer', listener: (e: {readonly direction: number, readonly localFile: string, readonly remoteFile: string, readonly remotePath: string, readonly bytesTransferred: number, readonly percentDone: number, readonly text: string, readonly textB: Uint8Array}) => void )

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.

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

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

Copyright (c) 2023 /n software inc. - All rights reserved.
IPWorks SSH 2020 JavaScript Edition - Version 20.0 [Build 8501]