interface ServerOpts {
    allowHalfOpen?: boolean;
    pauseOnConnect?: boolean;
    noDelay?: boolean;
    keepAlive?: boolean;
    keepAliveInitialDelay?: number;
    highWaterMark?: number;
    blockList?: BlockList;
}

Properties

allowHalfOpen?: boolean

Indicates whether half-opened TCP connections are allowed.

false
pauseOnConnect?: boolean

Indicates whether the socket should be paused on incoming connections.

false
noDelay?: boolean

If set to true, it disables the use of Nagle's algorithm immediately after a new incoming connection is received.

false

v16.5.0

keepAlive?: boolean

If set to true, it enables keep-alive functionality on the socket immediately after a new incoming connection is received, similarly on what is done in socket.setKeepAlive([enable][, initialDelay]).

false

v16.5.0

keepAliveInitialDelay?: number

If set to a positive number, it sets the initial delay before the first keepalive probe is sent on an idle socket.

0

v16.5.0

highWaterMark?: number

Optionally overrides all net.Sockets' readableHighWaterMark and writableHighWaterMark.

See [stream.getDefaultHighWaterMark()](https://nodejs.org/docs/latest-v22.x/api/stream.html#streamgetdefaulthighwatermarkobjectmode).

v18.17.0, v20.1.0

blockList?: BlockList

blockList can be used for disabling inbound access to specific IP addresses, IP ranges, or IP subnets. This does not work if the server is behind a reverse proxy, NAT, etc. because the address checked against the block list is the address of the proxy, or the one specified by the NAT.

v22.13.0