Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TlsOptions

Options specific to the configuration of TLS.

Hierarchy

  • TlsOptions

Index

Accessors

Accessors

caCertPath

  • get caCertPath(): PathLike | undefined
  • set caCertPath(value: PathLike | undefined): void

  • Return the configured CA certificate paths.

    Returns PathLike | undefined

    the configured CA certificate paths, if any

  • Sets the comma-delimited CA certificate paths.

    Parameters

    • value: PathLike | undefined

      the comma-delimited CA certificate paths

    Returns void

    the configured CA certificate paths, if any

clientCertPath

  • get clientCertPath(): PathLike | undefined
  • set clientCertPath(value: PathLike | undefined): void

  • Return the client certificate path.

    Returns PathLike | undefined

    the client certificate path, if any

  • Sets the client certificate path.

    Parameters

    • value: PathLike | undefined

      the client certificate path, if any

    Returns void

    the client certificate path, if any

clientKeyPath

  • get clientKeyPath(): PathLike | undefined
  • set clientKeyPath(value: PathLike | undefined): void

  • Returns the configured client certificate key path.

    Returns PathLike | undefined

    the configured client certificate key path, if any

  • Set the client certificate key path.

    Parameters

    • value: PathLike | undefined

      the client certificate key path

    Returns void

    the configured client certificate key path, if any

enabled

  • get enabled(): boolean
  • set enabled(value: boolean): void

  • Returns true if TLS is to be enabled.

    Returns boolean

    true if TLS is to be enabled.

  • Enables/disables TLS support.

    Parameters

    • value: boolean

      true to enable TLS, otherwise false (default)

    Returns void

    true if TLS is to be enabled.