diff options
| author | Pranshu Srivastava <rexagod@gmail.com> | 2020-05-23 00:55:32 +0300 |
|---|---|---|
| committer | James M Snell <jasnell@gmail.com> | 2020-06-26 20:09:28 +0300 |
| commit | 074df495edf180dc58858208b40998a1e70db3c8 (patch) | |
| tree | b0ad70e4d6192a453cda05411bbe9afa2897ab36 /doc/api/http2.md | |
| parent | 870f0fc5e8d18d6a8343aa32a9e7197065ee3e62 (diff) | |
doc: specify maxHeaderCount alias for maxHeaderListPairs
Fixes: https://github.com/nodejs/node/issues/32388
PR-URL: https://github.com/nodejs/node/pull/33519
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Zeyu Yang <himself65@outlook.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc/api/http2.md')
| -rw-r--r-- | doc/api/http2.md | 14 |
1 files changed, 11 insertions, 3 deletions
diff --git a/doc/api/http2.md b/doc/api/http2.md index 3ad8b111672..737538c78f1 100644 --- a/doc/api/http2.md +++ b/doc/api/http2.md @@ -2055,7 +2055,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 @@ -2194,7 +2196,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 @@ -2307,7 +2311,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 @@ -3639,6 +3645,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 |