From 9339f9f602e956fb4d40b67e42129b1a71a91bef Mon Sep 17 00:00:00 2001
From: James M Snell <jasnell@gmail.com>
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 <luigipinca@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
---
 doc/api/http2.md | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/doc/api/http2.md b/doc/api/http2.md
index 1d0befd6f7d0eb..e7f6c3293423a5 100644
--- a/doc/api/http2.md
+++ b/doc/api/http2.md
@@ -984,6 +984,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