From 98ed30f3f546ded9ff9c014bc5ba69d6222f1ffa Mon Sep 17 00:00:00 2001 From: Ujjwal Sharma Date: Tue, 24 Apr 2018 02:47:21 +0530 Subject: [PATCH] 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: https://github.com/nodejs/help/issues/877#issuecomment-381253464 Backport-PR-URL: https://github.com/nodejs/node/pull/22850 PR-URL: https://github.com/nodejs/node/pull/20236 Reviewed-By: Vse Mozhet Byt Reviewed-By: Trivikram Kamat Reviewed-By: Ruben Bridgewater --- doc/api/http2.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/doc/api/http2.md b/doc/api/http2.md index 93c7b8dff442ac..7d9cbadd1de917 100644 --- a/doc/api/http2.md +++ b/doc/api/http2.md @@ -159,18 +159,16 @@ an `Http2Session`. added: v8.4.0 --> +* `type` {integer} The frame type. +* `code` {integer} The error code. +* `id` {integer} The stream id (or `0` if the frame isn't associated with a + stream). + The `'frameError'` event is emitted when an error occurs while attempting to send a frame on the session. If the frame that could not be sent is associated with a specific `Http2Stream`, an attempt to emit `'frameError'` event on the `Http2Stream` is made. -When invoked, the handler function will receive three arguments: - -* An integer identifying the frame type. -* An integer identifying the error code. -* An integer identifying the stream (or 0 if the frame is not associated with - a stream). - If the `'frameError'` event is associated with a stream, the stream will be closed and destroyed immediately following the `'frameError'` event. If the event is not associated with a stream, the `Http2Session` will be shut down