Permalink
Browse files

doc: add parameters for settings events

Add parameters for the callback for the Http2Session:localSettings event
and Http2Session:remoteSettings event inline with the pattern in the
rest of the documentation.

Refs: nodejs/help#877 (comment)

PR-URL: #20371
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
  • Loading branch information...
ryzokuken committed Apr 27, 2018
1 parent d3255ca commit e954aa0e0c5e97d2e9256e9145d13bb59ee6dfb1
Showing with 6 additions and 4 deletions.
  1. +6 −4 doc/api/http2.md
@@ -195,9 +195,10 @@ event is emitted.
added: v8.4.0
-->
* `settings` {HTTP/2 Settings Object} A copy of the `SETTINGS` frame received.
The `'localSettings'` event is emitted when an acknowledgment `SETTINGS` frame
has been received. When invoked, the handler function will receive a copy of
the local settings.
has been received.
When using `http2session.settings()` to submit new settings, the modified
settings do not take effect until the `'localSettings'` event is emitted.
@@ -215,9 +216,10 @@ session.on('localSettings', (settings) => {
added: v8.4.0
-->
* `settings` {HTTP/2 Settings Object} A copy of the `SETTINGS` frame received.
The `'remoteSettings'` event is emitted when a new `SETTINGS` frame is received
from the connected peer. When invoked, the handler function will receive a copy
of the remote settings.
from the connected peer.
```js
session.on('remoteSettings', (settings) => {

0 comments on commit e954aa0

Please sign in to comment.