Ftp

constructor

• new Ftp(): Ftp

  返回值

  Ftp

静态 只读DirectoryResponse

静态 只读ListingResponse

静态 只读Response

静态 只读TransferMode

changeDirectory

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

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

  参数

  path

  string

  返回值

  Promise<FtpResponse>

  源码与继承

close

• close(): void

  中止所有未完成操作并释放两条连接。

  返回值

  void

  源码与继承

connect

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

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

  参数

  server

  IpAddress

  port

  number = 21

  timeout

  ReadonlyValue = Time.Zero

  返回值

  Promise<FtpResponse>

  源码与继承

createDirectory

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

  创建远端目录。

  参数

  path

  string

  返回值

  Promise<FtpResponse>

  源码与继承

deleteDirectory

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

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

  参数

  path

  string

  返回值

  Promise<FtpResponse>

  源码与继承

deleteFile

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

  删除远端文件。

  参数

  path

  string

  返回值

  Promise<FtpResponse>

  源码与继承

disconnect

• disconnect(): Promise<FtpResponse>

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

  返回值

  Promise<FtpResponse>

  源码与继承

download

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

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

  参数

  remoteFile

  string

  localPath

  string

  mode

  TransferMode = TransferMode.Binary

  返回值

  Promise<FtpResponse>

  源码与继承

getDirectoryListing

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

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

  参数

  directory

  string = ''

  返回值

  Promise<FtpListingResponse>

  源码与继承

getWorkingDirectory

• getWorkingDirectory(): Promise<FtpDirectoryResponse>

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

  返回值

  Promise<FtpDirectoryResponse>

  源码与继承

keepAlive

• keepAlive(): Promise<FtpResponse>

  发送 NOOP 保持连接活跃。

  返回值

  Promise<FtpResponse>

  源码与继承

login

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

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

  参数

  name

  string = 'anonymous'

  password

  string = 'user@sfml-dev.org'

  返回值

  Promise<FtpResponse>

  源码与继承

parentDirectory

• parentDirectory(): Promise<FtpResponse>

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

  返回值

  Promise<FtpResponse>

  源码与继承

renameFile

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

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

  参数

  path

  string

  newPath

  string

  返回值

  Promise<FtpResponse>

  源码与继承

sendCommand

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

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

  参数

  command

  string

  parameter

  string = ''

  返回值

  Promise<FtpResponse>

  源码与继承

upload

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

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

  参数

  localFile

  string

  remotePath

  string

  mode

  TransferMode = TransferMode.Binary

  append

  boolean = false

  返回值

  Promise<FtpResponse>

  源码与继承