Skip to content

Commit 24fd157

Browse files
rexagodcodebytere
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 69f9629 commit 24fd157

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
@@ -1991,7 +1991,9 @@ changes:
19911991
queued to be sent, and unacknowledged `PING` and `SETTINGS` frames are all
19921992
counted towards the current limit. **Default:** `10`.
19931993
* `maxHeaderListPairs` {number} Sets the maximum number of header entries.
1994-
The minimum value is `4`. **Default:** `128`.
1994+
This is similar to [`http.Server#maxHeadersCount`][] or
1995+
[`http.ClientRequest#maxHeadersCount`][]. The minimum value is `4`.
1996+
**Default:** `128`.
19951997
* `maxOutstandingPings` {number} Sets the maximum number of outstanding,
19961998
unacknowledged pings. **Default:** `10`.
19971999
* `maxSendHeaderBlockLength` {number} Sets the maximum allowed size for a
@@ -2127,7 +2129,9 @@ changes:
21272129
queued to be sent, and unacknowledged `PING` and `SETTINGS` frames are all
21282130
counted towards the current limit. **Default:** `10`.
21292131
* `maxHeaderListPairs` {number} Sets the maximum number of header entries.
2130-
The minimum value is `4`. **Default:** `128`.
2132+
This is similar to [`http.Server#maxHeadersCount`][] or
2133+
[`http.ClientRequest#maxHeadersCount`][]. The minimum value is `4`.
2134+
**Default:** `128`.
21312135
* `maxOutstandingPings` {number} Sets the maximum number of outstanding,
21322136
unacknowledged pings. **Default:** `10`.
21332137
* `maxSendHeaderBlockLength` {number} Sets the maximum allowed size for a
@@ -2241,7 +2245,9 @@ changes:
22412245
queued to be sent, and unacknowledged `PING` and `SETTINGS` frames are all
22422246
counted towards the current limit. **Default:** `10`.
22432247
* `maxHeaderListPairs` {number} Sets the maximum number of header entries.
2244-
The minimum value is `1`. **Default:** `128`.
2248+
This is similar to [`http.Server#maxHeadersCount`][] or
2249+
[`http.ClientRequest#maxHeadersCount`][]. The minimum value is `1`.
2250+
**Default:** `128`.
22452251
* `maxOutstandingPings` {number} Sets the maximum number of outstanding,
22462252
unacknowledged pings. **Default:** `10`.
22472253
* `maxReservedRemoteStreams` {number} Sets the maximum number of reserved push
@@ -3588,6 +3594,8 @@ following additional properties:
35883594
[`Http2Stream`]: #http2_class_http2stream
35893595
[`ServerHttp2Stream`]: #http2_class_serverhttp2stream
35903596
[`TypeError`]: errors.html#errors_class_typeerror
3597+
[`http.ClientRequest#maxHeadersCount`]: http.html#http_request_maxheaderscount
3598+
[`http.Server#maxHeadersCount`]: http.html#http_server_maxheaderscount
35913599
[`http2.SecureServer`]: #http2_class_http2secureserver
35923600
[`http2.Server`]: #http2_class_http2server
35933601
[`http2.createSecureServer()`]: #http2_http2_createsecureserver_options_onrequesthandler

0 commit comments

Comments
 (0)