SftpProviderOptions
Defined in: src/providers/native/sftp/NativeSftpProvider.ts:153
Options for createSftpProviderFactory.
The native provider is a zero-dependency replacement for the legacy
ssh2-backed provider. It implements RFC 4253 SSH transport, RFC 4252 user
authentication (password, keyboard-interactive, publickey with
Ed25519/RSA), RFC 5656 ECDSA host keys (nistp256/384/521), and the
SFTP v3 client protocol multiplexed over a single channel.
Properties
Section titled “Properties”| Property | Type | Description | Defined in |
|---|---|---|---|
keepaliveIntervalMs? | number | Default interval (milliseconds) between SSH-level keepalive pings sent once the transport is connected and idle. Prevents stateful firewalls / NAT devices from dropping long-lived sessions. The timer is reset on every outbound payload so active transfers do not generate extra traffic. Disabled when omitted or 0. | src/providers/native/sftp/NativeSftpProvider.ts:168 |
maxConcurrency? | number | Maximum concurrent file-transfer operations the engine should schedule against a single SFTP session. Each in-flight read/write occupies an outstanding SFTP request slot multiplexed over the same SSH channel; the default of 8 keeps memory bounded on commodity servers, but high-RTT links and modern OpenSSH builds can comfortably handle 16\u201364. Must be a positive integer. | src/providers/native/sftp/NativeSftpProvider.ts:177 |
readyTimeoutMs? | number | Default connection timeout in milliseconds when the profile omits timeoutMs. Bounds both the TCP connect and the SSH identification + key-exchange handshake, so a hung server cannot stall connect() indefinitely after the socket is accepted. | src/providers/native/sftp/NativeSftpProvider.ts:160 |