doc: fix webstream close reject state state doc

The `closed` promise may reject. Document the states where it rejects based on the spec. Fixes: nodejs#41858
benjamingr · Feb 5, 2022 · b20b675 · b20b675
1 parent 217acb9
commit b20b675
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/doc/api/webstreams.md b/doc/api/webstreams.md
@@ -425,7 +425,8 @@ added: v16.5.0
 -->
 
 * Type: {Promise} Fulfilled with `undefined` when the associated
-  {ReadableStream} is closed or this reader's lock is released.
+  {ReadableStream} is closed or rejected if the stream errors or the reader's
+  lock is released before the stream finishes closing.
 
 #### `readableStreamDefaultReader.read()`