Class Ftp

constructor

• new Ftp(): Ftp

  Returns Ftp

Static ReadonlyDirectoryResponse

Static ReadonlyListingResponse

Static ReadonlyResponse

Static ReadonlyTransferMode

changeDirectory

• changeDirectory(path: string): Promise<FtpResponse>

  切换服务器当前工作目录。

  Parameters

  • path: string

  Returns Promise<FtpResponse>

close

• close(): void

  Abort any outstanding operation and release both connections.

  Returns void

connect

• connect(
      server: IpAddress,
      port?: number,
      timeout?: ReadonlyValue,
  ): Promise<FtpResponse>

  异步连接 FTP 服务器，默认端口 21；Time.Zero 不设连接超时，连接后另行 login。

  Parameters

  • server: IpAddress
  • port: number = 21
  • timeout: ReadonlyValue = Time.Zero

  Returns Promise<FtpResponse>

createDirectory

• createDirectory(path: string): Promise<FtpResponse>

  创建远端目录。

  Parameters

  • path: string

  Returns Promise<FtpResponse>

deleteDirectory

• deleteDirectory(path: string): Promise<FtpResponse>

  删除远端目录，通常要求目录为空。

  Parameters

  • path: string

  Returns Promise<FtpResponse>

deleteFile

• deleteFile(path: string): Promise<FtpResponse>

  删除远端文件。

  Parameters

  • path: string

  Returns Promise<FtpResponse>

disconnect

• disconnect(): Promise<FtpResponse>

  按队列顺序发送 QUIT 并关闭连接。

  Returns Promise<FtpResponse>

download

• download(
      remoteFile: string,
      localPath: string,
      mode?: TransferMode,
  ): Promise<FtpResponse>

  下载远端文件到本地目录 localPath，保留源文件名，默认二进制传输。

  Parameters

  • remoteFile: string
  • localPath: string
  • mode: TransferMode = TransferMode.Binary

  Returns Promise<FtpResponse>

getDirectoryListing

• getDirectoryListing(directory?: string): Promise<FtpListingResponse>

  通过 NLST 获取目录名称列表，默认当前目录，列表数据上限为 8 MiB。

  Parameters

  • directory: string = ''

  Returns Promise<FtpListingResponse>

getWorkingDirectory

• getWorkingDirectory(): Promise<FtpDirectoryResponse>

  查询服务器当前工作目录。

  Returns Promise<FtpDirectoryResponse>

keepAlive

• keepAlive(): Promise<FtpResponse>

  发送 NOOP 保持连接活跃。

  Returns Promise<FtpResponse>

login

• login(name?: string, password?: string): Promise<FtpResponse>

  异步登录，省略参数时使用匿名账号。

  Parameters

  • name: string = 'anonymous'
  • password: string = 'user@sfml-dev.org'

  Returns Promise<FtpResponse>

parentDirectory

• parentDirectory(): Promise<FtpResponse>

  切换到服务器当前目录的上一级。

  Returns Promise<FtpResponse>

renameFile

• renameFile(path: string, newPath: string): Promise<FtpResponse>

  将远端文件或目录从 path 重命名为 newPath。

  Parameters

  • path: string
  • newPath: string

  Returns Promise<FtpResponse>

sendCommand

• sendCommand(command: string, parameter?: string): Promise<FtpResponse>

  按队列顺序发送原始 FTP 命令及参数，参数不得含换行或空字节。

  Parameters

  • command: string
  • parameter: string = ''

  Returns Promise<FtpResponse>

upload

• upload(
      localFile: string,
      remotePath: string,
      mode?: TransferMode,
      append?: boolean,
  ): Promise<FtpResponse>

  上传本地文件到远端目录，保留文件名；append 为 true 时追加，默认覆盖。

  Parameters

  • localFile: string
  • remotePath: string
  • mode: TransferMode = TransferMode.Binary
  • append: boolean = false

  Returns Promise<FtpResponse>