http2: customSettings add documentation

Add an explanation to the documentation for Htpp2Settings to explain the usage of customSettings and its limitations.
nodejs · Aug 21, 2023 · 2bfb762 · 2bfb762
1 parent 90fc0f2
commit 2bfb762
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/doc/api/http2.md b/doc/api/http2.md
@@ -3010,6 +3010,11 @@ properties.
   meaningful if sent by the server. Once the `enableConnectProtocol` setting
   has been enabled for a given `Http2Session`, it cannot be disabled.
   **Default:** `false`.
+* `customSettings` {object} Specifies additional settings, yet not implemented
+  in node and the underlying libraries. The key of the object define the 
+  numeric ids of the  settings and the values the numeric value of the settings.
+  This property is not supported for remote and local settings. It is only
+  supported for sending SETTINGS.
 
 All additional properties on the settings object are ignored.