Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit a8df2e2

Browse filesBrowse files
dev-scripttargos
authored andcommitted
doc: improve doc Http2Stream: FrameError, Timeout and Trailers
Document arguments for the 'frameError', 'timeout' and 'trailers' event. PR-URL: #30373 Fixes: nodejs/help#877 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
1 parent be97f71 commit a8df2e2
Copy full SHA for a8df2e2

File tree

Expand file treeCollapse file tree

1 file changed

+9
-0
lines changed
Open diff view settings
Filter options
Expand file treeCollapse file tree

1 file changed

+9
-0
lines changed
Open diff view settings
Collapse file

‎doc/api/http2.md‎

Copy file name to clipboardExpand all lines: doc/api/http2.md
+9Lines changed: 9 additions & 0 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -970,6 +970,11 @@ an `Http2Stream`.
970970
added: v8.4.0
971971
-->
972972

973+
* `type` {integer} The frame type.
974+
* `code` {integer} The error code.
975+
* `id` {integer} The stream id (or `0` if the frame isn't associated with a
976+
stream).
977+
973978
The `'frameError'` event is emitted when an error occurs while attempting to
974979
send a frame. When invoked, the handler function will receive an integer
975980
argument identifying the frame type, and an integer argument identifying the
@@ -984,12 +989,16 @@ added: v8.4.0
984989
The `'timeout'` event is emitted after no activity is received for this
985990
`Http2Stream` within the number of milliseconds set using
986991
`http2stream.setTimeout()`.
992+
Its listener does not expect any arguments.
987993

988994
#### Event: `'trailers'`
989995
<!-- YAML
990996
added: v8.4.0
991997
-->
992998

999+
* `headers` {HTTP/2 Headers Object} An object describing the headers
1000+
* `flags` {number} The associated numeric flags
1001+
9931002
The `'trailers'` event is emitted when a block of headers associated with
9941003
trailing header fields is received. The listener callback is passed the
9951004
[HTTP/2 Headers Object][] and flags associated with the headers.

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.