Skip to content

Commit 98ed30f

Browse files
ryzokukenBethGriggs
authored andcommitted
doc: improve docs for Http2Session:frameError
Improve documentation regarding the callback parameters for the frameError event for instances of Http2Session, making it inline with the currently accepted structure, like the rest of the documentation. Refs: nodejs/help#877 (comment) Backport-PR-URL: #22850 PR-URL: #20236 Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>
1 parent b32cf8f commit 98ed30f

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

doc/api/http2.md

+5-7
Original file line numberDiff line numberDiff line change
@@ -159,18 +159,16 @@ an `Http2Session`.
159159
added: v8.4.0
160160
-->
161161

162+
* `type` {integer} The frame type.
163+
* `code` {integer} The error code.
164+
* `id` {integer} The stream id (or `0` if the frame isn't associated with a
165+
stream).
166+
162167
The `'frameError'` event is emitted when an error occurs while attempting to
163168
send a frame on the session. If the frame that could not be sent is associated
164169
with a specific `Http2Stream`, an attempt to emit `'frameError'` event on the
165170
`Http2Stream` is made.
166171

167-
When invoked, the handler function will receive three arguments:
168-
169-
* An integer identifying the frame type.
170-
* An integer identifying the error code.
171-
* An integer identifying the stream (or 0 if the frame is not associated with
172-
a stream).
173-
174172
If the `'frameError'` event is associated with a stream, the stream will be
175173
closed and destroyed immediately following the `'frameError'` event. If the
176174
event is not associated with a stream, the `Http2Session` will be shut down

0 commit comments

Comments
 (0)