From b709af31e0376d1cfe104ab41191796a0788d770 Mon Sep 17 00:00:00 2001 From: Luigi Pinca Date: Thu, 1 Dec 2022 18:37:50 +0100 Subject: [PATCH] doc: sort http.createServer() options alphabetically MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit PR-URL: https://github.com/nodejs/node/pull/45680 Reviewed-By: Yagiz Nizipli Reviewed-By: Antoine du Hamel Reviewed-By: Zeyu "Alex" Yang Reviewed-By: Rich Trott Reviewed-By: Tobias Nießen --- doc/api/http.md | 41 ++++++++++++++--------------------------- 1 file changed, 14 insertions(+), 27 deletions(-) diff --git a/doc/api/http.md b/doc/api/http.md index 7758504ad6334e..37e3dfe5adb38a 100644 --- a/doc/api/http.md +++ b/doc/api/http.md @@ -3121,39 +3121,20 @@ changes: --> * `options` {Object} - * `IncomingMessage` {http.IncomingMessage} Specifies the `IncomingMessage` - class to be used. Useful for extending the original `IncomingMessage`. - **Default:** `IncomingMessage`. - * `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`. + * `connectionsCheckingInterval`: Sets the interval value in milliseconds to + check for request and headers timeout in incomplete requests. + **Default:** `30000`. * `headersTimeout`: Sets the timeout value in milliseconds for receiving the complete HTTP headers from the client. See [`server.headersTimeout`][] for more information. **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 invalid HTTP headers when `true`. Using the insecure parser should be avoided. See [`--insecure-http-parser`][] for more information. - **Default:** `false` - * `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`. + **Default:** `false`. + * `IncomingMessage` {http.IncomingMessage} Specifies the `IncomingMessage` + class to be used. Useful for extending the original `IncomingMessage`. + **Default:** `IncomingMessage`. * `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])`]\[`socket.setKeepAlive(enable, initialDelay)`]. @@ -3161,6 +3142,13 @@ changes: * `keepAliveInitialDelay` {number} If set to a positive number, it sets the initial delay before the first keepalive probe is sent on an idle socket. **Default:** `0`. + * `requestTimeout`: Sets the timeout value in milliseconds for receiving + the entire request from the client. + See [`server.requestTimeout`][] for more information. + * `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 `; `. @@ -3755,7 +3743,6 @@ Set the maximum number of idle HTTP parsers. **Default:** `1000`. [`response.writeContinue()`]: #responsewritecontinue [`response.writeHead()`]: #responsewriteheadstatuscode-statusmessage-headers [`server.headersTimeout`]: #serverheaderstimeout -[`server.keepAliveTimeout`]: #serverkeepalivetimeout [`server.listen()`]: net.md#serverlisten [`server.requestTimeout`]: #serverrequesttimeout [`server.timeout`]: #servertimeout