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>

  ソースと継承