diff options
| author | Ujjwal Sharma <usharma1998@gmail.com> | 2018-04-26 20:46:57 +0300 |
|---|---|---|
| committer | Beth Griggs <Bethany.Griggs@uk.ibm.com> | 2018-10-17 02:07:24 +0300 |
| commit | 1a6a054899f43cf4d8400d57615a3f24cb3d1d82 (patch) | |
| tree | 6f85f65a0dc68cbfdf188ba74023892912c53a84 /doc | |
| parent | c7ba5562640ee265b68c9bde5993359564c10bea (diff) | |
doc: improve parameters for Http2Session:goaway event
Improve parameters for the callback for the Http2Session:connect 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
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/http2.md | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/doc/api/http2.md b/doc/api/http2.md index 20d25cdbee6..d069562d58a 100644 --- a/doc/api/http2.md +++ b/doc/api/http2.md @@ -179,17 +179,16 @@ immediately following the `'frameError'` event. added: v8.4.0 --> -The `'goaway'` event is emitted when a `GOAWAY` frame is received. When invoked, -the handler function will receive three arguments: - * `errorCode` {number} The HTTP/2 error code specified in the `GOAWAY` frame. * `lastStreamID` {number} The ID of the last stream the remote peer successfully processed (or `0` if no ID is specified). * `opaqueData` {Buffer} If additional opaque data was included in the `GOAWAY` frame, a `Buffer` instance will be passed containing that data. -*Note*: The `Http2Session` instance will be shut down automatically when the -`'goaway'` event is emitted. +The `'goaway'` event is emitted when a `GOAWAY` frame is received. + +The `Http2Session` instance will be shut down automatically when the `'goaway'` +event is emitted. #### Event: 'localSettings' <!-- YAML |