Interface TlsServeOptions

TLS (HTTPS) server options

interface TlsServeOptions {
    cert: string;
    hostname?: string;
    key: string;
    onError?: ((error) => void);
    onListen?: ((params) => void);
    port?: number;
    signal?: AbortSignal;
}

Hierarchy (view full)

Properties

cert hostname? key onError? onListen? port? signal?

Properties

cert

cert: string

TLS certificate chain in PEM format

Optional hostname

hostname?: string

Hostname or IP address or interface to listen on

Default Value

"localhost"

key

key: string

TLS private key in PEM format

Optional onError

onError?: ((error) => void)

Called when an unhandled error occurs

Type declaration

    • (error): void

    • Called when an unhandled error occurs

      Parameters

      • error: unknown

        Unhandled error

      Returns void

      Default Value

      console.error

Default Value

console.error

Param: error

Unhandled error

Optional onListen

onListen?: ((params) => void)

Called once the server starts listening for requests

Type declaration

    • (params): void

    • Called once the server starts listening for requests

      Parameters

      • params: {
            address: string;
            port: number;
        }

        Server network information

        • address: string

          Server IP address

        • port: number

          Server port

      Returns void

Param: params

Server network information

Optional port

port?: number

Port to listen on

Default Value

0

Optional signal

signal?: AbortSignal

Signal usable to shutdown the server

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc