diff options
| author | Ujjwal Sharma <usharma1998@gmail.com> | 2018-04-27 22:49:32 +0300 |
|---|---|---|
| committer | Beth Griggs <Bethany.Griggs@uk.ibm.com> | 2018-10-17 02:07:24 +0300 |
| commit | 41e89316e6f12bd2d10604bdceca2913da081485 (patch) | |
| tree | 62d2da23378a0fbf83320fcc51155265a6c990c5 /doc | |
| parent | aa341d1d3d9c047ae9092f0888a16cced73d514a (diff) | |
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: https://github.com/nodejs/help/issues/877#issuecomment-381253464
Backport-PR-URL: https://github.com/nodejs/node/pull/22850
PR-URL: https://github.com/nodejs/node/pull/20371
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/http2.md | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/doc/api/http2.md b/doc/api/http2.md index d069562d58a..c2fa1de0228 100644 --- a/doc/api/http2.md +++ b/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. *Note*: When using `http2session.settings()` to submit new settings, the modified settings do not take effect until the `'localSettings'` event is @@ -216,9 +217,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) => { |