Skip to content

Commit f5f92d7

Browse files
committed
http2: customSettings add documentation
Add an explanation to the documentation for Http2Settings to explain the usage of customSettings and its limitations.
1 parent 58f086f commit f5f92d7

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

doc/api/errors.md

+6
Original file line numberDiff line numberDiff line change
@@ -1712,6 +1712,12 @@ When setting the priority for an HTTP/2 stream, the stream may be marked as
17121712
a dependency for a parent stream. This error code is used when an attempt is
17131713
made to mark a stream and dependent of itself.
17141714

1715+
<a id="ERR_HTTP2_TOO_MANY_CUSTOM_SETTINGS"></a>
1716+
1717+
### `ERR_HTTP2_TOO_MANY_CUSTOM_SETTINGS`
1718+
1719+
The number of supported custom settings (10) has been exceeded.
1720+
17151721
<a id="ERR_HTTP2_TOO_MANY_INVALID_FRAMES"></a>
17161722

17171723
### `ERR_HTTP2_TOO_MANY_INVALID_FRAMES`

doc/api/http2.md

+8
Original file line numberDiff line numberDiff line change
@@ -3010,6 +3010,14 @@ properties.
30103010
meaningful if sent by the server. Once the `enableConnectProtocol` setting
30113011
has been enabled for a given `Http2Session`, it cannot be disabled.
30123012
**Default:** `false`.
3013+
* `customSettings` {Object} Specifies additional settings, yet not implemented
3014+
in node and the underlying libraries. The key of the object defines the
3015+
numeric value of the settings type (as defined in the "HTTP/2 SETTINGS"
3016+
registry established by \[RFC 7540\]) and the values the actual numeric value
3017+
of the settings.
3018+
It is only supported for sending SETTINGS.
3019+
Custom settings are not supported for the functions retrieving remote and
3020+
local settings as nghttp2 does not pass unknown HTTP/2 settings to Node.js.
30133021

30143022
All additional properties on the settings object are ignored.
30153023

0 commit comments

Comments
 (0)