Skip to content

Commit 074df49

Browse files
rexagodjasnell
authored andcommitted
doc: specify maxHeaderCount alias for maxHeaderListPairs
Fixes: #32388 PR-URL: #33519 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Zeyu Yang <[email protected]> Reviewed-By: James M Snell <[email protected]>
1 parent 870f0fc commit 074df49

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

doc/api/http2.md

+11-3
Original file line numberDiff line numberDiff line change
@@ -2055,7 +2055,9 @@ changes:
20552055
queued to be sent, and unacknowledged `PING` and `SETTINGS` frames are all
20562056
counted towards the current limit. **Default:** `10`.
20572057
* `maxHeaderListPairs` {number} Sets the maximum number of header entries.
2058-
The minimum value is `4`. **Default:** `128`.
2058+
This is similar to [`http.Server#maxHeadersCount`][] or
2059+
[`http.ClientRequest#maxHeadersCount`][]. The minimum value is `4`.
2060+
**Default:** `128`.
20592061
* `maxOutstandingPings` {number} Sets the maximum number of outstanding,
20602062
unacknowledged pings. **Default:** `10`.
20612063
* `maxSendHeaderBlockLength` {number} Sets the maximum allowed size for a
@@ -2194,7 +2196,9 @@ changes:
21942196
queued to be sent, and unacknowledged `PING` and `SETTINGS` frames are all
21952197
counted towards the current limit. **Default:** `10`.
21962198
* `maxHeaderListPairs` {number} Sets the maximum number of header entries.
2197-
The minimum value is `4`. **Default:** `128`.
2199+
This is similar to [`http.Server#maxHeadersCount`][] or
2200+
[`http.ClientRequest#maxHeadersCount`][]. The minimum value is `4`.
2201+
**Default:** `128`.
21982202
* `maxOutstandingPings` {number} Sets the maximum number of outstanding,
21992203
unacknowledged pings. **Default:** `10`.
22002204
* `maxSendHeaderBlockLength` {number} Sets the maximum allowed size for a
@@ -2307,7 +2311,9 @@ changes:
23072311
queued to be sent, and unacknowledged `PING` and `SETTINGS` frames are all
23082312
counted towards the current limit. **Default:** `10`.
23092313
* `maxHeaderListPairs` {number} Sets the maximum number of header entries.
2310-
The minimum value is `1`. **Default:** `128`.
2314+
This is similar to [`http.Server#maxHeadersCount`][] or
2315+
[`http.ClientRequest#maxHeadersCount`][]. The minimum value is `1`.
2316+
**Default:** `128`.
23112317
* `maxOutstandingPings` {number} Sets the maximum number of outstanding,
23122318
unacknowledged pings. **Default:** `10`.
23132319
* `maxReservedRemoteStreams` {number} Sets the maximum number of reserved push
@@ -3639,6 +3645,8 @@ following additional properties:
36393645
[`Http2Stream`]: #http2_class_http2stream
36403646
[`ServerHttp2Stream`]: #http2_class_serverhttp2stream
36413647
[`TypeError`]: errors.html#errors_class_typeerror
3648+
[`http.ClientRequest#maxHeadersCount`]: http.html#http_request_maxheaderscount
3649+
[`http.Server#maxHeadersCount`]: http.html#http_server_maxheaderscount
36423650
[`http2.SecureServer`]: #http2_class_http2secureserver
36433651
[`http2.Server`]: #http2_class_http2server
36443652
[`http2.createSecureServer()`]: #http2_http2_createsecureserver_options_onrequesthandler

0 commit comments

Comments
 (0)