diff options
| author | Ruben Bridgewater <ruben@bridgewater.de> | 2019-03-24 23:37:12 +0100 |
|---|---|---|
| committer | Ruben Bridgewater <ruben@bridgewater.de> | 2019-03-27 17:14:38 +0100 |
| commit | fd992e6e36bb4b01a6ceb71cfeb3bae640b492a6 (patch) | |
| tree | 8b9091223ea90d7dee5e3771becab75319531c26 /doc | |
| parent | 115f0f5a57f50f6b039f28a56910207f92df116d (diff) | |
| download | android-node-v8-fd992e6e36bb4b01a6ceb71cfeb3bae640b492a6.tar.gz android-node-v8-fd992e6e36bb4b01a6ceb71cfeb3bae640b492a6.tar.bz2 android-node-v8-fd992e6e36bb4b01a6ceb71cfeb3bae640b492a6.zip | |
doc: mark settings as optional and add callback
The settings are currently not required and the callback was not
documented so far.
Refs: https://github.com/nodejs/node/pull/26811
PR-URL: https://github.com/nodejs/node/pull/26894
Refs: https://github.com/nodejs/node/pull/26811
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/http2.md | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/doc/api/http2.md b/doc/api/http2.md index 0f28124881..04a4972de7 100644 --- a/doc/api/http2.md +++ b/doc/api/http2.md @@ -572,12 +572,17 @@ Provides miscellaneous information about the current state of the An object describing the current status of this `Http2Session`. -#### http2session.settings(settings) +#### http2session.settings([settings][, callback]) <!-- YAML added: v8.4.0 --> * `settings` {HTTP/2 Settings Object} +* `callback` {Function} Callback that is called once the session is connected or + right away if the session is already connected. + * `err` {Error|null} + * `settings` {HTTP/2 Settings Object} The updated `settings` object. + * `duration` {integer} Updates the current local settings for this `Http2Session` and sends a new `SETTINGS` frame to the connected HTTP/2 peer. @@ -2232,7 +2237,7 @@ Returns an object containing the default settings for an `Http2Session` instance. This method returns a new object instance every time it is called so instances returned may be safely modified for use. -### http2.getPackedSettings(settings) +### http2.getPackedSettings([settings]) <!-- YAML added: v8.4.0 --> |