Skip to content

Commit 1a6a054

Browse files
ryzokukenBethGriggs
authored andcommitted
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: nodejs/help#877 (comment) Backport-PR-URL: #22850
1 parent c7ba556 commit 1a6a054

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

doc/api/http2.md

+4-5
Original file line numberDiff line numberDiff line change
@@ -179,17 +179,16 @@ immediately following the `'frameError'` event.
179179
added: v8.4.0
180180
-->
181181

182-
The `'goaway'` event is emitted when a `GOAWAY` frame is received. When invoked,
183-
the handler function will receive three arguments:
184-
185182
* `errorCode` {number} The HTTP/2 error code specified in the `GOAWAY` frame.
186183
* `lastStreamID` {number} The ID of the last stream the remote peer successfully
187184
processed (or `0` if no ID is specified).
188185
* `opaqueData` {Buffer} If additional opaque data was included in the `GOAWAY`
189186
frame, a `Buffer` instance will be passed containing that data.
190187

191-
*Note*: The `Http2Session` instance will be shut down automatically when the
192-
`'goaway'` event is emitted.
188+
The `'goaway'` event is emitted when a `GOAWAY` frame is received.
189+
190+
The `Http2Session` instance will be shut down automatically when the `'goaway'`
191+
event is emitted.
193192

194193
#### Event: 'localSettings'
195194
<!-- YAML

0 commit comments

Comments
 (0)