Class SftpTransport`Experimental`

SFTP over SSH, through ssh2's pure JavaScript path.

Implements

Transport

Index

Constructors

Methods

chmod close connect get list mkdir put remove rename setMtime stat

Constructors

constructor

new SftpTransport(options: SftpTransportOptions): SftpTransport
Experimental
Parameters
- options: SftpTransportOptions
Returns SftpTransport
- Defined in transport/sftp.ts:205

Methods

chmod

chmod(target: RemotePath, mode: number): Promise<void>
Experimental
Sets a file's permission bits, when the protocol can.
Parameters
- target: RemotePath
- mode: number
Returns Promise<void>
Implementation of Transport.chmod
- Defined in transport/sftp.ts:603

close

close(): Promise<void>
Experimental
Closes the connection. Safe to call more than once.

Returns Promise<void>
Implementation of Transport.close
- Defined in transport/sftp.ts:612

connect

connect(signal?: AbortSignal): Promise<Capabilities>
Experimental
Connects, signs in and checks the remote root, then reports what the server offers.
Parameters
- Optionalsignal: AbortSignal
Returns Promise<Capabilities>
Implementation of Transport.connect
- Defined in transport/sftp.ts:278

get

get(target: RemotePath, to: Writable, signal?: AbortSignal): Promise<void>
Experimental
Streams the file at path into to.
Parameters
- target: RemotePath
- to: Writable
- Optionalsignal: AbortSignal
Returns Promise<void>
Implementation of Transport.get
- Defined in transport/sftp.ts:515

list

list(dir: RemotePath): Promise<RemoteEntry[]>
Experimental
The entries of one folder.
Parameters
- dir: RemotePath
Returns Promise<RemoteEntry[]>
Implementation of Transport.list
- Defined in transport/sftp.ts:458

mkdir

mkdir(target: RemotePath): Promise<void>
Experimental
Creates a folder; succeeds when it already exists.
Parameters
- target: RemotePath
Returns Promise<void>
Implementation of Transport.mkdir
- Defined in transport/sftp.ts:579

put

put(from: Readable, target: RemotePath, signal?: AbortSignal): Promise<void>
Experimental
Streams from into a file at path, replacing any file there.
Parameters
- from: Readable
- target: RemotePath
- Optionalsignal: AbortSignal
Returns Promise<void>
Implementation of Transport.put
- Defined in transport/sftp.ts:524

remove

remove(target: RemotePath): Promise<void>
Experimental
Removes a file, or an empty folder.
Parameters
- target: RemotePath
Returns Promise<void>
Implementation of Transport.remove
- Defined in transport/sftp.ts:558

rename

rename(from: RemotePath, to: RemotePath, overwrite: boolean): Promise<void>
Experimental
Renames from to to; with overwrite, replaces an existing to.
Parameters
- from: RemotePath
- to: RemotePath
- overwrite: boolean
Returns Promise<void>
Implementation of Transport.rename
- Defined in transport/sftp.ts:535

setMtime

setMtime(target: RemotePath, mtimeMs: number): Promise<void>
Experimental
Sets a file's modification time, when the protocol can.
Parameters
- target: RemotePath
- mtimeMs: number
Returns Promise<void>
Implementation of Transport.setMtime
- Defined in transport/sftp.ts:593

stat

stat(target: RemotePath): Promise<RemoteEntry | undefined>
Experimental
The entry at path, without following a symbolic link; undefined when nothing is there.
Parameters
- target: RemotePath
Returns Promise<RemoteEntry | undefined>
Implementation of Transport.stat
- Defined in transport/sftp.ts:502