doc: document the ready event for Http2Stream

Fixes: #22804 PR-URL: #34221 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]>
nodejs · Sep 22, 2020 · 2615e55 · 2615e55
1 parent fbb36ed
commit 2615e55
Showing 1 changed file with 9 additions and 0 deletions.
diff --git 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'`
+<!-- YAML
+added: v8.4.0
+-->
+
+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'`
 <!-- YAML
 added: v8.4.0