doc: sort http.createServer() options alphabetically
PR-URL: https://github.com/nodejs/node/pull/45680 Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Zeyu "Alex" Yang <himself65@outlook.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de>
This commit is contained in:
parent
59678813e7
commit
c89f9d3fd4
@ -3142,39 +3142,20 @@ changes:
|
|||||||
-->
|
-->
|
||||||
|
|
||||||
* `options` {Object}
|
* `options` {Object}
|
||||||
* `IncomingMessage` {http.IncomingMessage} Specifies the `IncomingMessage`
|
* `connectionsCheckingInterval`: Sets the interval value in milliseconds to
|
||||||
class to be used. Useful for extending the original `IncomingMessage`.
|
check for request and headers timeout in incomplete requests.
|
||||||
**Default:** `IncomingMessage`.
|
**Default:** `30000`.
|
||||||
* `ServerResponse` {http.ServerResponse} Specifies the `ServerResponse` class
|
|
||||||
to be used. Useful for extending the original `ServerResponse`. **Default:**
|
|
||||||
`ServerResponse`.
|
|
||||||
* `requestTimeout`: Sets the timeout value in milliseconds for receiving
|
|
||||||
the entire request from the client.
|
|
||||||
See [`server.requestTimeout`][] for more information.
|
|
||||||
**Default:** `300000`.
|
|
||||||
* `headersTimeout`: Sets the timeout value in milliseconds for receiving
|
* `headersTimeout`: Sets the timeout value in milliseconds for receiving
|
||||||
the complete HTTP headers from the client.
|
the complete HTTP headers from the client.
|
||||||
See [`server.headersTimeout`][] for more information.
|
See [`server.headersTimeout`][] for more information.
|
||||||
**Default:** `60000`.
|
**Default:** `60000`.
|
||||||
* `keepAliveTimeout`: 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.
|
|
||||||
See [`server.keepAliveTimeout`][] for more information.
|
|
||||||
**Default:** `5000`.
|
|
||||||
* `connectionsCheckingInterval`: Sets the interval value in milliseconds to
|
|
||||||
check for request and headers timeout in incomplete requests.
|
|
||||||
**Default:** `30000`.
|
|
||||||
* `insecureHTTPParser` {boolean} Use an insecure HTTP parser that accepts
|
* `insecureHTTPParser` {boolean} Use an insecure HTTP parser that accepts
|
||||||
invalid HTTP headers when `true`. Using the insecure parser should be
|
invalid HTTP headers when `true`. Using the insecure parser should be
|
||||||
avoided. See [`--insecure-http-parser`][] for more information.
|
avoided. See [`--insecure-http-parser`][] for more information.
|
||||||
**Default:** `false`
|
**Default:** `false`.
|
||||||
* `maxHeaderSize` {number} Optionally overrides the value of
|
* `IncomingMessage` {http.IncomingMessage} Specifies the `IncomingMessage`
|
||||||
[`--max-http-header-size`][] for requests received by this server, i.e.
|
class to be used. Useful for extending the original `IncomingMessage`.
|
||||||
the maximum length of request headers in bytes.
|
**Default:** `IncomingMessage`.
|
||||||
**Default:** 16384 (16 KiB).
|
|
||||||
* `noDelay` {boolean} If set to `true`, it disables the use of Nagle's
|
|
||||||
algorithm immediately after a new incoming connection is received.
|
|
||||||
**Default:** `true`.
|
|
||||||
* `keepAlive` {boolean} If set to `true`, it enables keep-alive functionality
|
* `keepAlive` {boolean} If set to `true`, it enables keep-alive functionality
|
||||||
on the socket immediately after a new incoming connection is received,
|
on the socket immediately after a new incoming connection is received,
|
||||||
similarly on what is done in \[`socket.setKeepAlive([enable][, initialDelay])`]\[`socket.setKeepAlive(enable, initialDelay)`].
|
similarly on what is done in \[`socket.setKeepAlive([enable][, initialDelay])`]\[`socket.setKeepAlive(enable, initialDelay)`].
|
||||||
@ -3182,13 +3163,32 @@ changes:
|
|||||||
* `keepAliveInitialDelay` {number} If set to a positive number, it sets the
|
* `keepAliveInitialDelay` {number} If set to a positive number, it sets the
|
||||||
initial delay before the first keepalive probe is sent on an idle socket.
|
initial delay before the first keepalive probe is sent on an idle socket.
|
||||||
**Default:** `0`.
|
**Default:** `0`.
|
||||||
* `uniqueHeaders` {Array} A list of response headers that should be sent only
|
* `keepAliveTimeout`: The number of milliseconds of inactivity a server
|
||||||
once. If the header's value is an array, the items will be joined
|
needs to wait for additional incoming data, after it has finished writing
|
||||||
using `; `.
|
the last response, before a socket will be destroyed.
|
||||||
|
See [`server.keepAliveTimeout`][] for more information.
|
||||||
|
**Default:** `5000`.
|
||||||
|
* `maxHeaderSize` {number} 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.
|
||||||
|
**Default:** 16384 (16 KiB).
|
||||||
|
* `noDelay` {boolean} If set to `true`, it disables the use of Nagle's
|
||||||
|
algorithm immediately after a new incoming connection is received.
|
||||||
|
**Default:** `true`.
|
||||||
|
* `requestTimeout`: Sets the timeout value in milliseconds for receiving
|
||||||
|
the entire request from the client.
|
||||||
|
See [`server.requestTimeout`][] for more information.
|
||||||
* `requireHostHeader` {boolean} It forces the server to respond with
|
* `requireHostHeader` {boolean} It forces the server to respond with
|
||||||
a 400 (Bad Request) status code to any HTTP/1.1 request message
|
a 400 (Bad Request) status code to any HTTP/1.1 request message
|
||||||
that lacks a Host header (as mandated by the specification).
|
that lacks a Host header (as mandated by the specification).
|
||||||
**Default:** `true`.
|
**Default:** `true`.
|
||||||
|
* `ServerResponse` {http.ServerResponse} Specifies the `ServerResponse` class
|
||||||
|
to be used. Useful for extending the original `ServerResponse`. **Default:**
|
||||||
|
`ServerResponse`.
|
||||||
|
**Default:** `300000`.
|
||||||
|
* `uniqueHeaders` {Array} 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 `; `.
|
||||||
|
|
||||||
* `requestListener` {Function}
|
* `requestListener` {Function}
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user