Skip to content

Commit

Permalink
doc: improve parameters for Http2Session:goaway event
Browse files Browse the repository at this point in the history
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)
  • Loading branch information
ryzokuken committed Apr 27, 2018
1 parent 602ffd6 commit db10473
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions doc/api/http2.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,15 +179,14 @@ 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.

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.

Expand Down

1 comment on commit db10473

@targos
Copy link
Member

@targos targos commented on db10473 Jun 16, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR-URL: #20338

Please sign in to comment.