Skip to content

Commit d61de30

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 a789474 commit d61de30

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
@@ -2053,7 +2053,9 @@ changes:
20532053
queued to be sent, and unacknowledged `PING` and `SETTINGS` frames are all
20542054
counted towards the current limit. **Default:** `10`.
20552055
* `maxHeaderListPairs` {number} Sets the maximum number of header entries.
2056-
The minimum value is `4`. **Default:** `128`.
2056+
This is similar to [`http.Server#maxHeadersCount`][] or
2057+
[`http.ClientRequest#maxHeadersCount`][]. The minimum value is `4`.
2058+
**Default:** `128`.
20572059
* `maxOutstandingPings` {number} Sets the maximum number of outstanding,
20582060
unacknowledged pings. **Default:** `10`.
20592061
* `maxSendHeaderBlockLength` {number} Sets the maximum allowed size for a
@@ -2190,7 +2192,9 @@ changes:
21902192
queued to be sent, and unacknowledged `PING` and `SETTINGS` frames are all
21912193
counted towards the current limit. **Default:** `10`.
21922194
* `maxHeaderListPairs` {number} Sets the maximum number of header entries.
2193-
The minimum value is `4`. **Default:** `128`.
2195+
This is similar to [`http.Server#maxHeadersCount`][] or
2196+
[`http.ClientRequest#maxHeadersCount`][]. The minimum value is `4`.
2197+
**Default:** `128`.
21942198
* `maxOutstandingPings` {number} Sets the maximum number of outstanding,
21952199
unacknowledged pings. **Default:** `10`.
21962200
* `maxSendHeaderBlockLength` {number} Sets the maximum allowed size for a
@@ -2301,7 +2305,9 @@ changes:
23012305
queued to be sent, and unacknowledged `PING` and `SETTINGS` frames are all
23022306
counted towards the current limit. **Default:** `10`.
23032307
* `maxHeaderListPairs` {number} Sets the maximum number of header entries.
2304-
The minimum value is `1`. **Default:** `128`.
2308+
This is similar to [`http.Server#maxHeadersCount`][] or
2309+
[`http.ClientRequest#maxHeadersCount`][]. The minimum value is `1`.
2310+
**Default:** `128`.
23052311
* `maxOutstandingPings` {number} Sets the maximum number of outstanding,
23062312
unacknowledged pings. **Default:** `10`.
23072313
* `maxReservedRemoteStreams` {number} Sets the maximum number of reserved push
@@ -3633,6 +3639,8 @@ following additional properties:
36333639
[`Http2Stream`]: #http2_class_http2stream
36343640
[`ServerHttp2Stream`]: #http2_class_serverhttp2stream
36353641
[`TypeError`]: errors.html#errors_class_typeerror
3642+
[`http.ClientRequest#maxHeadersCount`]: http.html#http_request_maxheaderscount
3643+
[`http.Server#maxHeadersCount`]: http.html#http_server_maxheaderscount
36363644
[`http2.SecureServer`]: #http2_class_http2secureserver
36373645
[`http2.Server`]: #http2_class_http2server
36383646
[`http2.createSecureServer()`]: #http2_http2_createsecureserver_options_onrequesthandler

0 commit comments

Comments
 (0)