Sftp

constructor

• new Sftp(): Sftp

  Returns

  Sftp

Static ReadonlyAttributesResult

Static ReadonlyHostKeyType

Static ReadonlyListingResult

Static ReadonlyPathResult

Static ReadonlyResult

close

• close(): void

  Destroy the SSH connection immediately and wake pending operations.

  Returns

  void

  Source & inheritance

connect

• connect(
      server: IpAddress,
      port?: number,
      timeout?: SftpTimeout,
  ): Promise<SftpResult>

  Establish an SSH handshake on port 22 by default; then call login to authenticate. Host trust is not verified automatically; applications can verify the host fingerprint via getSessionInfo before logging in.

  Parameters

  server

  IpAddress

  port

  number = 22

  timeout

  SftpTimeout = Time.Zero

  Returns

  Promise<SftpResult>

  Source & inheritance

createDirectory

• createDirectory(
      path: string,
      permissions?: number,
      timeout?: SftpTimeout,
  ): Promise<SftpResult>

  Create a remote directory with default Unix permissions of 0o755.

  Parameters

  path

  string

  permissions

  number = 0o755

  timeout

  SftpTimeout = Time.Zero

  Returns

  Promise<SftpResult>

  Source & inheritance

deleteDirectory

• deleteDirectory(path: string, timeout?: SftpTimeout): Promise<SftpResult>

  Delete an empty remote directory.

  Parameters

  path

  string

  timeout

  SftpTimeout = Time.Zero

  Returns

  Promise<SftpResult>

  Source & inheritance

deleteFile

• deleteFile(path: string, timeout?: SftpTimeout): Promise<SftpResult>

  Delete a remote file or symbolic link.

  Parameters

  path

  string

  timeout

  SftpTimeout = Time.Zero

  Returns

  Promise<SftpResult>

  Source & inheritance

disconnect

• disconnect(timeout?: SftpTimeout): Promise<SftpResult>

  Close the session immediately and return success; timeout is used only for argument validation.

  Parameters

  timeout

  SftpTimeout = Time.Zero

  Returns

  Promise<SftpResult>

  Source & inheritance

download

• download(
      path: string,
      callback: SftpDownloadCallback,
      offset?: bigint,
      timeout?: SftpTimeout,
  ): Promise<SftpResult>

  Download chunks from byte offset offset, awaiting callback sequentially; the maximum offset is 2^53-1.

  Parameters

  path

  string

  callback

  SftpDownloadCallback

  offset

  bigint = 0n

  timeout

  SftpTimeout = Time.Zero

  Returns

  Promise<SftpResult>

  Source & inheritance

getAttributes

• getAttributes(
      path: string,
      followLinks?: boolean,
      timeout?: SftpTimeout,
  ): Promise<SftpAttributesResult>

  Query remote attributes; followLinks follows symbolic links by default, while false queries the link itself.

  Parameters

  path

  string

  followLinks

  boolean = true

  timeout

  SftpTimeout = Time.Zero

  Returns

  Promise<SftpAttributesResult>

  Source & inheritance

getDirectoryListing

• getDirectoryListing(
      path: string,
      timeout?: SftpTimeout,
  ): Promise<SftpListingResult>

  Read directory entries and their attributes asynchronously.

  Parameters

  path

  string

  timeout

  SftpTimeout = Time.Zero

  Returns

  Promise<SftpListingResult>

  Source & inheritance

getSessionInfo

• getSessionInfo(): undefined | SftpSessionInfo

  Return a snapshot of the host public key and negotiated algorithms, or undefined if handshake information is not ready.

  Returns

  undefined | SftpSessionInfo

  Source & inheritance

getWorkingDirectory

• getWorkingDirectory(timeout?: SftpTimeout): Promise<SftpPathResult>

  Query the server's default working directory for the current session.

  Parameters

  timeout

  SftpTimeout = Time.Zero

  Returns

  Promise<SftpPathResult>

  Source & inheritance

login

• login(
      name: string,
      password: string,
      timeout?: SftpTimeout,
  ): Promise<SftpResult>

  Authenticate asynchronously with a username and password, then open an SFTP channel.

  Parameters

  name

  string

  password

  string

  timeoutOptional

  SftpTimeout

  Returns

  Promise<SftpResult>

  Source & inheritance
• login(
      name: string,
      publicKey: string | Uint8Array,
      privateKey: string | Uint8Array,
      passphrase?: string,
      timeout?: SftpTimeout,
  ): Promise<SftpResult>

  Authenticate asynchronously with matching public/private keys and an optional private-key passphrase; key arguments are contents, not paths.

  Parameters

  name

  string

  publicKey

  string | Uint8Array

  privateKey

  string | Uint8Array

  passphraseOptional

  string

  timeoutOptional

  SftpTimeout

  Returns

  Promise<SftpResult>

  Source & inheritance

rename

• rename(
      oldPath: string,
      newPath: string,
      overwrite?: boolean,
      timeout?: SftpTimeout,
  ): Promise<SftpResult>

  Rename a remote path; overwrite true requires server support for the OpenSSH overwrite-rename extension.

  Parameters

  oldPath

  string

  newPath

  string

  overwrite

  boolean = false

  timeout

  SftpTimeout = Time.Zero

  Returns

  Promise<SftpResult>

  Source & inheritance

resolvePath

• resolvePath(path: string, timeout?: SftpTimeout): Promise<SftpPathResult>

  Ask the server to resolve a canonical absolute path.

  Parameters

  path

  string

  timeout

  SftpTimeout = Time.Zero

  Returns

  Promise<SftpPathResult>

  Source & inheritance

upload

• upload(
      path: string,
      callback: SftpUploadCallback,
      permissions?: number,
      truncate?: boolean,
      append?: boolean,
      offset?: bigint,
      timeout?: SftpTimeout,
  ): Promise<SftpResult>

  Upload a file using callback-provided chunks, awaiting each chunk's write.

  Parameters

  path

  string

  Remote file path.

  callback

  SftpUploadCallback

  Callback that fills the buffer and sets size.

  permissions

  number = 0o644

  Permissions for new files; defaults to 0o644.

  truncate

  boolean = true

  Whether to clear an existing file; defaults to true.

  append

  boolean = false

  Whether to request append writes; defaults to false.

  offset

  bigint = 0n

  Starting byte offset; defaults to 0n, maximum 2^53-1.

  timeout

  SftpTimeout = Time.Zero

  No-progress timeout configuration; no timeout by default.

  Returns

  Promise<SftpResult>

  Source & inheritance