Skip to main content

ServerOptions

interface ServerOptions

Type Parameters Jump to heading

Properties Jump to heading

Specifies the IncomingMessage class to be used. Useful for extending the original IncomingMessage.

Specifies the ServerResponse class to be used. Useful for extending the original ServerResponse.

optional
Jump to headingrequestTimeout: number | undefined

Sets the timeout value in milliseconds for receiving the entire request from the client.

It joins the field line values of multiple headers in a request with , instead of discarding the duplicates.

optional
Jump to headingkeepAliveTimeout: number | undefined

The number of milliseconds of inactivity a server needs to wait for additional incoming data, after it has finished writing the last response, before a socket will be destroyed.

Sets the interval value in milliseconds to check for request and headers timeout in incomplete requests.

optional
Jump to headinghighWaterMark: number | undefined

Optionally overrides all sockets' readableHighWaterMark and writableHighWaterMark. This affects highWaterMark property of both IncomingMessage and ServerResponse. Default: @see stream.getDefaultHighWaterMark().

optional
Jump to headinginsecureHTTPParser: boolean | undefined

Use an insecure HTTP parser that accepts invalid HTTP headers when true. Using the insecure parser should be avoided. See --insecure-http-parser for more information.

optional
Jump to headingmaxHeaderSize: number | undefined

Optionally overrides the value of --max-http-header-size for requests received by this server, i.e. the maximum length of request headers in bytes.

optional
Jump to headingnoDelay: boolean | undefined

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

optional
Jump to headingkeepAlive: boolean | undefined

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]).

optional
Jump to headingkeepAliveInitialDelay: number | undefined

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

optional
Jump to headinguniqueHeaders: Array<string | string[]> | undefined

A list of response headers that should be sent only once. If the header's value is an array, the items will be joined using ; .

Back to top