Class TlsOptions

Options specific to the configuration of TLS.

Hierarchy

TlsOptions

Index

Constructors

Accessors

caCertPath clientCertPath clientKeyPath enabled

Constructors

constructor

new TlsOptions(): TlsOptions
Returns TlsOptions

Accessors

caCertPath

get caCertPath(): undefined | PathLike
Return the configured CA certificate paths.

Returns
the configured CA certificate paths, if any

Returns undefined | PathLike
set caCertPath(value: undefined | PathLike): void
Sets the comma-delimited CA certificate paths.
Parameters
- value: undefined | PathLike
  
  the comma-delimited CA certificate paths
Returns void

clientCertPath

get clientCertPath(): undefined | PathLike
Return the client certificate path.

Returns
the client certificate path, if any

Returns undefined | PathLike
set clientCertPath(value: undefined | PathLike): void
Sets the client certificate path.
Parameters
- value: undefined | PathLike
  
  the client certificate path, if any
Returns void

clientKeyPath

get clientKeyPath(): undefined | PathLike
Returns the configured client certificate key path.

Returns
the configured client certificate key path, if any

Returns undefined | PathLike
set clientKeyPath(value: undefined | PathLike): void
Set the client certificate key path.
Parameters
- value: undefined | PathLike
  
  the client certificate key path
Returns void

enabled

get enabled(): boolean
Returns true if TLS is to be enabled.

Returns
true if TLS is to be enabled.

Returns boolean
set enabled(value: boolean): void
Enables/disables TLS support.
Parameters
- value: boolean
  
  true to enable TLS, otherwise false (default)
Returns void