Skip to content

Commit b709af3

Browse files
lpincajuanarbol
authored andcommitted
doc: sort http.createServer() options alphabetically
PR-URL: #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>
1 parent 1e11247 commit b709af3

File tree

1 file changed

+14
-27
lines changed

1 file changed

+14
-27
lines changed

doc/api/http.md

+14-27
Original file line numberDiff line numberDiff line change
@@ -3121,46 +3121,34 @@ changes:
31213121
-->
31223122

31233123
* `options` {Object}
3124-
* `IncomingMessage` {http.IncomingMessage} Specifies the `IncomingMessage`
3125-
class to be used. Useful for extending the original `IncomingMessage`.
3126-
**Default:** `IncomingMessage`.
3127-
* `ServerResponse` {http.ServerResponse} Specifies the `ServerResponse` class
3128-
to be used. Useful for extending the original `ServerResponse`. **Default:**
3129-
`ServerResponse`.
3130-
* `requestTimeout`: Sets the timeout value in milliseconds for receiving
3131-
the entire request from the client.
3132-
See [`server.requestTimeout`][] for more information.
3133-
**Default:** `300000`.
3124+
* `connectionsCheckingInterval`: Sets the interval value in milliseconds to
3125+
check for request and headers timeout in incomplete requests.
3126+
**Default:** `30000`.
31343127
* `headersTimeout`: Sets the timeout value in milliseconds for receiving
31353128
the complete HTTP headers from the client.
31363129
See [`server.headersTimeout`][] for more information.
31373130
**Default:** `60000`.
3138-
* `keepAliveTimeout`: The number of milliseconds of inactivity a server
3139-
needs to wait for additional incoming data, after it has finished writing
3140-
the last response, before a socket will be destroyed.
3141-
See [`server.keepAliveTimeout`][] for more information.
3142-
**Default:** `5000`.
3143-
* `connectionsCheckingInterval`: Sets the interval value in milliseconds to
3144-
check for request and headers timeout in incomplete requests.
3145-
**Default:** `30000`.
31463131
* `insecureHTTPParser` {boolean} Use an insecure HTTP parser that accepts
31473132
invalid HTTP headers when `true`. Using the insecure parser should be
31483133
avoided. See [`--insecure-http-parser`][] for more information.
3149-
**Default:** `false`
3150-
* `maxHeaderSize` {number} Optionally overrides the value of
3151-
[`--max-http-header-size`][] for requests received by this server, i.e.
3152-
the maximum length of request headers in bytes.
3153-
**Default:** 16384 (16 KiB).
3154-
* `noDelay` {boolean} If set to `true`, it disables the use of Nagle's
3155-
algorithm immediately after a new incoming connection is received.
3156-
**Default:** `true`.
3134+
**Default:** `false`.
3135+
* `IncomingMessage` {http.IncomingMessage} Specifies the `IncomingMessage`
3136+
class to be used. Useful for extending the original `IncomingMessage`.
3137+
**Default:** `IncomingMessage`.
31573138
* `keepAlive` {boolean} If set to `true`, it enables keep-alive functionality
31583139
on the socket immediately after a new incoming connection is received,
31593140
similarly on what is done in \[`socket.setKeepAlive([enable][, initialDelay])`]\[`socket.setKeepAlive(enable, initialDelay)`].
31603141
**Default:** `false`.
31613142
* `keepAliveInitialDelay` {number} If set to a positive number, it sets the
31623143
initial delay before the first keepalive probe is sent on an idle socket.
31633144
**Default:** `0`.
3145+
* `requestTimeout`: Sets the timeout value in milliseconds for receiving
3146+
the entire request from the client.
3147+
See [`server.requestTimeout`][] for more information.
3148+
* `ServerResponse` {http.ServerResponse} Specifies the `ServerResponse` class
3149+
to be used. Useful for extending the original `ServerResponse`. **Default:**
3150+
`ServerResponse`.
3151+
**Default:** `300000`.
31643152
* `uniqueHeaders` {Array} A list of response headers that should be sent only
31653153
once. If the header's value is an array, the items will be joined
31663154
using `; `.
@@ -3755,7 +3743,6 @@ Set the maximum number of idle HTTP parsers. **Default:** `1000`.
37553743
[`response.writeContinue()`]: #responsewritecontinue
37563744
[`response.writeHead()`]: #responsewriteheadstatuscode-statusmessage-headers
37573745
[`server.headersTimeout`]: #serverheaderstimeout
3758-
[`server.keepAliveTimeout`]: #serverkeepalivetimeout
37593746
[`server.listen()`]: net.md#serverlisten
37603747
[`server.requestTimeout`]: #serverrequesttimeout
37613748
[`server.timeout`]: #servertimeout

0 commit comments

Comments
 (0)