Skip to content

Commit c89f9d3

Browse files
authored
doc: sort http.createServer() options alphabetically
PR-URL: #45680 Reviewed-By: Yagiz Nizipli <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Zeyu "Alex" Yang <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Tobias Nießen <[email protected]>
1 parent 5967881 commit c89f9d3

File tree

1 file changed

+27
-27
lines changed

1 file changed

+27
-27
lines changed

doc/api/http.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -3142,53 +3142,53 @@ changes:
31423142
-->
31433143

31443144
* `options` {Object}
3145-
* `IncomingMessage` {http.IncomingMessage} Specifies the `IncomingMessage`
3146-
class to be used. Useful for extending the original `IncomingMessage`.
3147-
**Default:** `IncomingMessage`.
3148-
* `ServerResponse` {http.ServerResponse} Specifies the `ServerResponse` class
3149-
to be used. Useful for extending the original `ServerResponse`. **Default:**
3150-
`ServerResponse`.
3151-
* `requestTimeout`: Sets the timeout value in milliseconds for receiving
3152-
the entire request from the client.
3153-
See [`server.requestTimeout`][] for more information.
3154-
**Default:** `300000`.
3145+
* `connectionsCheckingInterval`: Sets the interval value in milliseconds to
3146+
check for request and headers timeout in incomplete requests.
3147+
**Default:** `30000`.
31553148
* `headersTimeout`: Sets the timeout value in milliseconds for receiving
31563149
the complete HTTP headers from the client.
31573150
See [`server.headersTimeout`][] for more information.
31583151
**Default:** `60000`.
3152+
* `insecureHTTPParser` {boolean} Use an insecure HTTP parser that accepts
3153+
invalid HTTP headers when `true`. Using the insecure parser should be
3154+
avoided. See [`--insecure-http-parser`][] for more information.
3155+
**Default:** `false`.
3156+
* `IncomingMessage` {http.IncomingMessage} Specifies the `IncomingMessage`
3157+
class to be used. Useful for extending the original `IncomingMessage`.
3158+
**Default:** `IncomingMessage`.
3159+
* `keepAlive` {boolean} If set to `true`, it enables keep-alive functionality
3160+
on the socket immediately after a new incoming connection is received,
3161+
similarly on what is done in \[`socket.setKeepAlive([enable][, initialDelay])`]\[`socket.setKeepAlive(enable, initialDelay)`].
3162+
**Default:** `false`.
3163+
* `keepAliveInitialDelay` {number} If set to a positive number, it sets the
3164+
initial delay before the first keepalive probe is sent on an idle socket.
3165+
**Default:** `0`.
31593166
* `keepAliveTimeout`: The number of milliseconds of inactivity a server
31603167
needs to wait for additional incoming data, after it has finished writing
31613168
the last response, before a socket will be destroyed.
31623169
See [`server.keepAliveTimeout`][] for more information.
31633170
**Default:** `5000`.
3164-
* `connectionsCheckingInterval`: Sets the interval value in milliseconds to
3165-
check for request and headers timeout in incomplete requests.
3166-
**Default:** `30000`.
3167-
* `insecureHTTPParser` {boolean} Use an insecure HTTP parser that accepts
3168-
invalid HTTP headers when `true`. Using the insecure parser should be
3169-
avoided. See [`--insecure-http-parser`][] for more information.
3170-
**Default:** `false`
31713171
* `maxHeaderSize` {number} Optionally overrides the value of
31723172
[`--max-http-header-size`][] for requests received by this server, i.e.
31733173
the maximum length of request headers in bytes.
31743174
**Default:** 16384 (16 KiB).
31753175
* `noDelay` {boolean} If set to `true`, it disables the use of Nagle's
31763176
algorithm immediately after a new incoming connection is received.
31773177
**Default:** `true`.
3178-
* `keepAlive` {boolean} If set to `true`, it enables keep-alive functionality
3179-
on the socket immediately after a new incoming connection is received,
3180-
similarly on what is done in \[`socket.setKeepAlive([enable][, initialDelay])`]\[`socket.setKeepAlive(enable, initialDelay)`].
3181-
**Default:** `false`.
3182-
* `keepAliveInitialDelay` {number} If set to a positive number, it sets the
3183-
initial delay before the first keepalive probe is sent on an idle socket.
3184-
**Default:** `0`.
3185-
* `uniqueHeaders` {Array} A list of response headers that should be sent only
3186-
once. If the header's value is an array, the items will be joined
3187-
using `; `.
3178+
* `requestTimeout`: Sets the timeout value in milliseconds for receiving
3179+
the entire request from the client.
3180+
See [`server.requestTimeout`][] for more information.
31883181
* `requireHostHeader` {boolean} It forces the server to respond with
31893182
a 400 (Bad Request) status code to any HTTP/1.1 request message
31903183
that lacks a Host header (as mandated by the specification).
31913184
**Default:** `true`.
3185+
* `ServerResponse` {http.ServerResponse} Specifies the `ServerResponse` class
3186+
to be used. Useful for extending the original `ServerResponse`. **Default:**
3187+
`ServerResponse`.
3188+
**Default:** `300000`.
3189+
* `uniqueHeaders` {Array} A list of response headers that should be sent only
3190+
once. If the header's value is an array, the items will be joined
3191+
using `; `.
31923192

31933193
* `requestListener` {Function}
31943194

0 commit comments

Comments
 (0)