doc: improve parameters for Http2Session:goaway event · nodejs/node@b47044a · GitHub

nodejs / node Public

• Notifications You must be signed in to change notification settings
• Fork 36.6k
• Star 120k

• Code
• Issues 637
• Pull requests 746
• Actions
• Projects
• Security and quality
• Insights

Additional navigation options

Commit b47044a

Browse filesBrowse the repository at this point in the historyBrowse files

ryzokuken

authored and

MylesBorins

committed

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)

1 parent f0b2b26 commit b47044a
Copy full SHA for b47044a

1 file changed

+2-3Lines changed: 2 additions & 3 deletions

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

• doc/api
  • http2.md

Expand file treeCollapse file tree

Open diff view settings

Collapse file

‎doc/api/http2.md‎

Copy file name to clipboardExpand all lines: doc/api/http2.md

+2-3Lines changed: 2 additions & 3 deletions

• Display the source diff
• Display the rich diff

Original file line number	Diff line number	Diff line change
@@ -179,15 +179,14 @@ immediately following the `'frameError'` event.
179	179	added: v8.4.0
180	180	-->
181	181
182		- The `'goaway'` event is emitted when a `GOAWAY` frame is received. When invoked,
183		- the handler function will receive three arguments:
184		-
185	182	* `errorCode` {number} The HTTP/2 error code specified in the `GOAWAY` frame.
186	183	* `lastStreamID` {number} The ID of the last stream the remote peer successfully
187	184	processed (or `0` if no ID is specified).
188	185	* `opaqueData` {Buffer} If additional opaque data was included in the `GOAWAY`
189	186	frame, a `Buffer` instance will be passed containing that data.
190	187
	188	+ The `'goaway'` event is emitted when a `GOAWAY` frame is received.
	189	+
191	190	The `Http2Session` instance will be shut down automatically when the `'goaway'`
192	191	event is emitted.
193	192

0 commit comments

Comments

0 (0)