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 PR-URL: nodejs#41860 Co-Authored-By: Mattias Buelens <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Colin Ihrig <[email protected]>
bengl · Feb 21, 2022 · 291fe63 · 291fe63
1 parent 2b1dabf
commit 291fe63
Showing 1 changed file with 7 additions and 5 deletions.
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()`
 
@@ -552,7 +553,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.
 
 #### `readableStreamBYOBReader.read(view)`
 
@@ -902,9 +904,9 @@ Closes the `WritableStream` when no additional writes are expected.
 added: v16.5.0
 -->
 
-* Type: A promise that is fulfilled with `undefined` when the
-  associated {WritableStream} is closed or this writer's lock is
-  released.
+* Type: {Promise} Fulfilled with `undefined` when the associated
+  {WritableStream} is closed or rejected if the stream errors or the writer's
+  lock is released before the stream finishes closing.
 
 #### `writableStreamDefaultWriter.desiredSize`