doc: improve parameters for Http2Session:goaway event #20338
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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)
This comment has been minimized.
This comment has been minimized.
BridgeAR
reviewed
Apr 26, 2018
doc/api/http2.md
Outdated
| * `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. When invoked, | ||
| the handler function will receive three arguments: |
There was a problem hiding this comment.
The second sentence is now obsolete and should be removed.
There was a problem hiding this comment.
I have no idea why I missed this in the first place. Sorry, will do.
jasnell
approved these changes
Apr 27, 2018
|
@BridgeAR done. |
|
Leave a 👍 reaction to approve fast-tracking. |
vsemozhetbyt
approved these changes
Apr 27, 2018
addaleax
approved these changes
Apr 27, 2018
|
Landing this. |
|
Landed in db10473 |
targos
referenced
this pull request
Jun 16, 2018
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)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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)
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes/cc @mcollina @nodejs/http2 @vsemozhetbyt