Skip to main content

Class: FTPClientConfig

ftp-client/src.FTPClientConfig

Implements

Constructors

new FTPClientConfig()

new FTPClientConfig(): FTPClientConfig

Returns

FTPClientConfig

Properties

connectOnStartup

connectOnStartup: boolean = true

whether to connect to server using an access method on an application startup, or library user will do it on it own in ModuleInit method

Implementation of

IFTPClientConfig.connectOnStartup

Source

libs/ftp-client/src/lib/config/ftp-client.config.ts:62


host

host?: string

Host the client should connect to. Optional, default is "localhost".

Implementation of

IFTPClientConfig.host

Source

libs/ftp-client/src/lib/config/ftp-client.config.ts:16


password

password?: string

Password to use for login. Optional, default is "guest".

Implementation of

IFTPClientConfig.password

Source

libs/ftp-client/src/lib/config/ftp-client.config.ts:43


port

port?: number

Port the client should connect to. Optional, default is 21.

Implementation of

IFTPClientConfig.port

Source

libs/ftp-client/src/lib/config/ftp-client.config.ts:23


secure

secure?: boolean

Use FTPS over TLS. Optional, default is false. True is preferred explicit TLS, "implicit" supports legacy, non-standardized implicit TLS.

Implementation of

IFTPClientConfig.secure

Source

libs/ftp-client/src/lib/config/ftp-client.config.ts:53


timeout

timeout?: number

Client connection timeout, default is 30000

Implementation of

IFTPClientConfig.timeout

Source

libs/ftp-client/src/lib/config/ftp-client.config.ts:33


user

user?: string

Username to use for login. Optional, default is "anonymous".

Implementation of

IFTPClientConfig.user

Source

libs/ftp-client/src/lib/config/ftp-client.config.ts:38


Generated using typedoc-plugin-markdown and TypeDoc