Sftp

constructor

• new Sftp(): Sftp

  返回值

  Sftp

静态 只读AttributesResult

静态 只读HostKeyType

静态 只读ListingResult

静态 只读PathResult

静态 只读Result

close

• close(): void

  立即销毁 SSH 连接并唤醒待完成操作。

  返回值

  void

  源码与继承

connect

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

  建立 SSH 握手，默认端口 22；随后调用 login 完成身份认证。 不自动核验主机可信性，应用可在登录前通过 getSessionInfo 核验主机指纹。

  参数

  server

  IpAddress

  port

  number = 22

  timeout

  SftpTimeout = Time.Zero

  返回值

  Promise<SftpResult>

  源码与继承

createDirectory

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

  创建远端目录，默认 Unix 权限为 0o755。

  参数

  path

  string

  permissions

  number = 0o755

  timeout

  SftpTimeout = Time.Zero

  返回值

  Promise<SftpResult>

  源码与继承

deleteDirectory

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

  删除远端空目录。

  参数

  path

  string

  timeout

  SftpTimeout = Time.Zero

  返回值

  Promise<SftpResult>

  源码与继承

deleteFile

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

  删除远端文件或符号链接。

  参数

  path

  string

  timeout

  SftpTimeout = Time.Zero

  返回值

  Promise<SftpResult>

  源码与继承

disconnect

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

  立即关闭会话并返回成功结果；timeout 仅作参数校验。

  参数

  timeout

  SftpTimeout = Time.Zero

  返回值

  Promise<SftpResult>

  源码与继承

download

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

  从字节偏移 offset 开始分块下载；依次等待 callback，偏移最大为 2^53−1。

  参数

  path

  string

  callback

  SftpDownloadCallback

  offset

  bigint = 0n

  timeout

  SftpTimeout = Time.Zero

  返回值

  Promise<SftpResult>

  源码与继承

getAttributes

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

  查询远端属性；followLinks 默认跟随符号链接，false 查询链接自身。

  参数

  path

  string

  followLinks

  boolean = true

  timeout

  SftpTimeout = Time.Zero

  返回值

  Promise<SftpAttributesResult>

  源码与继承

getDirectoryListing

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

  异步读取目录条目及其属性。

  参数

  path

  string

  timeout

  SftpTimeout = Time.Zero

  返回值

  Promise<SftpListingResult>

  源码与继承

getSessionInfo

• getSessionInfo(): undefined | SftpSessionInfo

  返回主机公钥和协商算法的快照；握手信息未就绪时为 undefined。

  返回值

  undefined | SftpSessionInfo

  源码与继承

getWorkingDirectory

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

  查询服务器对当前会话的默认工作目录。

  参数

  timeout

  SftpTimeout = Time.Zero

  返回值

  Promise<SftpPathResult>

  源码与继承

login

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

  以用户名和密码异步认证并打开 SFTP 通道。

  参数

  name

  string

  password

  string

  timeout可选

  SftpTimeout

  返回值

  Promise<SftpResult>

  源码与继承
• login(
      name: string,
      publicKey: string | Uint8Array,
      privateKey: string | Uint8Array,
      passphrase?: string,
      timeout?: SftpTimeout,
  ): Promise<SftpResult>

  以匹配的公私钥及可选私钥密码异步认证，密钥参数为内容而非文件路径。

  参数

  name

  string

  publicKey

  string | Uint8Array

  privateKey

  string | Uint8Array

  passphrase可选

  string

  timeout可选

  SftpTimeout

  返回值

  Promise<SftpResult>

  源码与继承

rename

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

  重命名远端路径；overwrite 为 true 时要求服务端支持 OpenSSH 覆盖重命名扩展。

  参数

  oldPath

  string

  newPath

  string

  overwrite

  boolean = false

  timeout

  SftpTimeout = Time.Zero

  返回值

  Promise<SftpResult>

  源码与继承

resolvePath

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

  请求服务器解析规范化绝对路径。

  参数

  path

  string

  timeout

  SftpTimeout = Time.Zero

  返回值

  Promise<SftpPathResult>

  源码与继承

upload

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

  按回调提供的数据块上传文件，逐块等待写入完成。

  参数

  path

  string

  远端文件路径。

  callback

  SftpUploadCallback

  填充缓冲区和 size 的回调。

  permissions

  number = 0o644

  新建文件权限，默认 0o644。

  truncate

  boolean = true

  是否清空现有文件，默认 true。

  append

  boolean = false

  是否要求追加写入，默认 false。

  offset

  bigint = 0n

  起始字节偏移，默认 0n，最大 2^53−1。

  timeout

  SftpTimeout = Time.Zero

  无进展超时配置，默认不限时。

  返回值

  Promise<SftpResult>

  源码与继承