From 24fd15778a3b3589cc3f1014796af85c2ddd9ade Mon Sep 17 00:00:00 2001 From: Pranshu Srivastava Date: Sat, 23 May 2020 03:25:32 +0530 Subject: [PATCH] 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 Reviewed-By: Zeyu Yang Reviewed-By: James M Snell --- doc/api/http2.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/doc/api/http2.md b/doc/api/http2.md index b22fc04c40c140..40a107f7be2d6c 100644 --- a/doc/api/http2.md +++ b/doc/api/http2.md @@ -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 @@ -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 @@ -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 @@ -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