Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: mark settings as optional and add callback #26894

Closed
wants to merge 1 commit into from
Closed

doc: mark settings as optional and add callback #26894

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions doc/api/http2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
-->
Expand Down