Skip to content

Commit

Permalink
doc: specify maxHeaderCount alias for maxHeaderListPairs
Browse files Browse the repository at this point in the history
Fixes: #32388

PR-URL: #33519
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Zeyu Yang <himself65@outlook.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
  • Loading branch information
rexagod authored and codebytere committed Jul 12, 2020
1 parent 69f9629 commit 24fd157
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions doc/api/http2.md
Original file line number Diff line number Diff line change
Expand Up @@ -1991,7 +1991,9 @@ changes:
queued to be sent, and unacknowledged `PING` and `SETTINGS` frames are all
counted towards the current limit. **Default:** `10`.
* `maxHeaderListPairs` {number} Sets the maximum number of header entries.
The minimum value is `4`. **Default:** `128`.
This is similar to [`http.Server#maxHeadersCount`][] or
[`http.ClientRequest#maxHeadersCount`][]. The minimum value is `4`.
**Default:** `128`.
* `maxOutstandingPings` {number} Sets the maximum number of outstanding,
unacknowledged pings. **Default:** `10`.
* `maxSendHeaderBlockLength` {number} Sets the maximum allowed size for a
Expand Down Expand Up @@ -2127,7 +2129,9 @@ changes:
queued to be sent, and unacknowledged `PING` and `SETTINGS` frames are all
counted towards the current limit. **Default:** `10`.
* `maxHeaderListPairs` {number} Sets the maximum number of header entries.
The minimum value is `4`. **Default:** `128`.
This is similar to [`http.Server#maxHeadersCount`][] or
[`http.ClientRequest#maxHeadersCount`][]. The minimum value is `4`.
**Default:** `128`.
* `maxOutstandingPings` {number} Sets the maximum number of outstanding,
unacknowledged pings. **Default:** `10`.
* `maxSendHeaderBlockLength` {number} Sets the maximum allowed size for a
Expand Down Expand Up @@ -2241,7 +2245,9 @@ changes:
queued to be sent, and unacknowledged `PING` and `SETTINGS` frames are all
counted towards the current limit. **Default:** `10`.
* `maxHeaderListPairs` {number} Sets the maximum number of header entries.
The minimum value is `1`. **Default:** `128`.
This is similar to [`http.Server#maxHeadersCount`][] or
[`http.ClientRequest#maxHeadersCount`][]. The minimum value is `1`.
**Default:** `128`.
* `maxOutstandingPings` {number} Sets the maximum number of outstanding,
unacknowledged pings. **Default:** `10`.
* `maxReservedRemoteStreams` {number} Sets the maximum number of reserved push
Expand Down Expand Up @@ -3588,6 +3594,8 @@ following additional properties:
[`Http2Stream`]: #http2_class_http2stream
[`ServerHttp2Stream`]: #http2_class_serverhttp2stream
[`TypeError`]: errors.html#errors_class_typeerror
[`http.ClientRequest#maxHeadersCount`]: http.html#http_request_maxheaderscount
[`http.Server#maxHeadersCount`]: http.html#http_server_maxheaderscount
[`http2.SecureServer`]: #http2_class_http2secureserver
[`http2.Server`]: #http2_class_http2server
[`http2.createSecureServer()`]: #http2_http2_createsecureserver_options_onrequesthandler
Expand Down

0 comments on commit 24fd157

Please sign in to comment.