Interface FastifyListenOptions

interface FastifyListenOptions {
    backlog?: number;
    exclusive?: boolean;
    host?: string;
    ipv6Only?: boolean;
    listenTextResolver?: ((address) => string);
    path?: string;
    port?: number;
    readableAll?: boolean;
    signal?: AbortSignal;
    writableAll?: boolean;
}

Properties

backlog? exclusive? host? ipv6Only? listenTextResolver? path? port? readableAll? signal? writableAll?

Properties

Optional backlog

backlog?: number

Specify the maximum length of the queue of pending connections. The actual length will be determined by the OS through sysctl settings such as tcp_max_syn_backlog and somaxconn on Linux. Default to 511.

Optional exclusive

exclusive?: boolean

Default to false.

Optional host

host?: string

Default to localhost.

Optional ipv6Only

ipv6Only?: boolean

For TCP servers, setting ipv6Only to true will disable dual-stack support, i.e., binding to host :: won't make 0.0.0.0 be bound. Default to false.

Optional listenTextResolver

listenTextResolver?: ((address) => string)

Function that resolves text to log after server has been successfully started

Type declaration

    • (address): string

    • Parameters

      • address: string

      Returns string

Optional path

path?: string

Will be ignored if port is specified.

See

Identifying paths for IPC connections.

Optional port

port?: number

Default to 0 (picks the first available open port).

Optional readableAll

readableAll?: boolean

For IPC servers makes the pipe readable for all users. Default to false.

Optional signal

signal?: AbortSignal

An AbortSignal that may be used to close a listening server.

Since

This option is available only in Node.js v15.6.0 and greater

Optional writableAll

writableAll?: boolean

For IPC servers makes the pipe writable for all users. Default to false.

Settings

Member Visibility

Theme

On This Page

backlogexclusivehostipv6OnlylistenTextResolverpathportreadableAllsignalwritableAll