IPWorks SSH 2020 JavaScript Edition

Questions / Feedback?

StartTransfer Event

Fired when a file starts downloading/uploading.

Syntax

sftp.on('StartTransfer', listener: (e: {readonly direction: number, readonly localFile: string, readonly remoteFile: string}) => void )

Remarks

The StartTransfer event fires when a Data Interface connection is created. This is when the file starts transferring and/or a directory listing is started.

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.

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