Ftp

constructor

• new Ftp(): Ftp

  Returns

  Ftp

Static ReadonlyDirectoryResponse

Static ReadonlyListingResponse

Static ReadonlyResponse

Static ReadonlyTransferMode

changeDirectory

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

  Change the server's current working directory.

  Parameters

  path

  string

  Returns

  Promise<FtpResponse>

  Source & inheritance

close

• close(): void

  Abort any outstanding operation and release both connections.

  Returns

  void

  Source & inheritance

connect

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

  Connect to an FTP server asynchronously on port 21 by default. Time.Zero disables the connection timeout; call login separately afterward.

  Parameters

  server

  IpAddress

  port

  number = 21

  timeout

  ReadonlyValue = Time.Zero

  Returns

  Promise<FtpResponse>

  Source & inheritance

createDirectory

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

  Create a remote directory.

  Parameters

  path

  string

  Returns

  Promise<FtpResponse>

  Source & inheritance

deleteDirectory

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

  Delete a remote directory, which usually must be empty.

  Parameters

  path

  string

  Returns

  Promise<FtpResponse>

  Source & inheritance

deleteFile

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

  Delete a remote file.

  Parameters

  path

  string

  Returns

  Promise<FtpResponse>

  Source & inheritance

disconnect

• disconnect(): Promise<FtpResponse>

  Send QUIT in queue order and close the connection.

  Returns

  Promise<FtpResponse>

  Source & inheritance

download

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

  Download a remote file to local directory localPath, retaining the source filename; use binary transfer by default.

  Parameters

  remoteFile

  string

  localPath

  string

  mode

  TransferMode = TransferMode.Binary

  Returns

  Promise<FtpResponse>

  Source & inheritance

getDirectoryListing

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

  Retrieve directory entry names using NLST, defaulting to the current directory; listing data is limited to 8 MiB.

  Parameters

  directory

  string = ''

  Returns

  Promise<FtpListingResponse>

  Source & inheritance

getWorkingDirectory

• getWorkingDirectory(): Promise<FtpDirectoryResponse>

  Query the server's current working directory.

  Returns

  Promise<FtpDirectoryResponse>

  Source & inheritance

keepAlive

• keepAlive(): Promise<FtpResponse>

  Send NOOP to keep the connection alive.

  Returns

  Promise<FtpResponse>

  Source & inheritance

login

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

  Log in asynchronously; omitted arguments use an anonymous account.

  Parameters

  name

  string = 'anonymous'

  password

  string = 'user@sfml-dev.org'

  Returns

  Promise<FtpResponse>

  Source & inheritance

parentDirectory

• parentDirectory(): Promise<FtpResponse>

  Change to the parent of the server's current directory.

  Returns

  Promise<FtpResponse>

  Source & inheritance

renameFile

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

  Rename a remote file or directory from path to newPath.

  Parameters

  path

  string

  newPath

  string

  Returns

  Promise<FtpResponse>

  Source & inheritance

sendCommand

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

  Send raw FTP commands and arguments in queue order; arguments must not contain newlines or null bytes.

  Parameters

  command

  string

  parameter

  string = ''

  Returns

  Promise<FtpResponse>

  Source & inheritance

upload

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

  Upload a local file to a remote directory, retaining its filename; append when append is true, otherwise overwrite by default.

  Parameters

  localFile

  string

  remotePath

  string

  mode

  TransferMode = TransferMode.Binary

  append

  boolean = false

  Returns

  Promise<FtpResponse>

  Source & inheritance