Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

Optional connTimeout

connTimeout: number

How long (in milliseconds) to wait for the control connection to be established. Default: 10000

Optional host

host: string

The hostname or IP address of the FTP server. Default: 'localhost'

Optional keepalive

keepalive: number

How often (in milliseconds) to send a 'dummy' (NOOP) command to keep the connection alive. Default: 10000

Optional password

password: string

Password for authentication. Default: 'anonymous@'

Optional pasvTimeout

pasvTimeout: number

How long (in milliseconds) to wait for a PASV data connection to be established. Default: 10000

Optional path

path: string

Optional port

port: number

The port of the FTP server. Default: 21

Optional secure

secure: string | boolean

Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990) Default: false

Optional secureOptions

secureOptions: ConnectionOptions

Additional options to be passed to tls.connect(). Default: (none)

Optional user

user: string

Username for authentication. Default: 'anonymous'