1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: mark settings as optional and add callback

Browse Source 
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>
This commit is contained in:
Ruben Bridgewater 2019-03-24 23:37:12 +01:00
parent 115f0f5a57
commit fd992e6e36
No known key found for this signature in database
GPG Key ID: F07496B3EB3C1762
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/api/http2.md
View File

@ -572,12 +572,17 @@ Provides miscellaneous information about the current state of the
An object describing the current status of this `Http2Session`. An object describing the current status of this `Http2Session`.
#### http2session.settings(settings) #### http2session.settings([settings][, callback])
<!-- YAML <!-- YAML
added: v8.4.0 added: v8.4.0
--> -->
* `settings` {HTTP/2 Settings Object} * `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 Updates the current local settings for this `Http2Session` and sends a new
`SETTINGS` frame to the connected HTTP/2 peer. `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 instance. This method returns a new object instance every time it is called
so instances returned may be safely modified for use. so instances returned may be safely modified for use.
### http2.getPackedSettings(settings) ### http2.getPackedSettings([settings])
<!-- YAML <!-- YAML
added: v8.4.0 added: v8.4.0
--> -->