From 5ce49357bdc15404442212bccf7f4ba0b634f118 Mon Sep 17 00:00:00 2001 From: James M Snell Date: Mon, 6 Jul 2020 12:09:35 -0700 Subject: [PATCH] doc: document the ready event for Http2Stream Fixes: https://github.com/nodejs/node/issues/22804 PR-URL: https://github.com/nodejs/node/pull/34221 Reviewed-By: Luigi Pinca Reviewed-By: Anna Henningsen Reviewed-By: Trivikram Kamat --- doc/api/http2.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/doc/api/http2.md b/doc/api/http2.md index 3ff984a3e25e6a..382ef11a6edf0a 100644 --- a/doc/api/http2.md +++ b/doc/api/http2.md @@ -983,6 +983,15 @@ argument identifying the frame type, and an integer argument identifying the error code. The `Http2Stream` instance will be destroyed immediately after the `'frameError'` event is emitted. +#### Event: `'ready'` + + +The `'ready'` event is emitted when the `Http2Stream` has been opened, has +been assigned an `id`, and can be used. The listener does not expect any +arguments. + #### Event: `'timeout'`