GeezerVison is showing github.com — doc: fix webstream close reject state state doc · nodejs/node@291fe63
File tree
Expand file treeCollapse file tree
Open diff view settings
Expand file treeCollapse file tree
Open diff view settings
Collapse file
Copy file name to clipboardExpand all lines: doc/api/webstreams.md +7-5Lines changed: 7 additions & 5 deletions - Display the source diff
- Display the rich diff
| Original file line number | Diff line number | Diff line change |
|---|
@@ -425,7 +425,8 @@ added: v16.5.0 |
425 | 425 | --> |
426 | 426 |
|
427 | 427 | * Type: {Promise} Fulfilled with `undefined` when the associated |
428 | | - {ReadableStream} is closed or this reader's lock is released. |
| 428 | + {ReadableStream} is closed or rejected if the stream errors or the reader's |
| 429 | + lock is released before the stream finishes closing. |
429 | 430 |
|
430 | 431 | #### `readableStreamDefaultReader.read()` |
431 | 432 |
|
@@ -552,7 +553,8 @@ added: v16.5.0 |
552 | 553 | --> |
553 | 554 |
|
554 | 555 | * Type: {Promise} Fulfilled with `undefined` when the associated |
555 | | - {ReadableStream} is closed or this reader's lock is released. |
| 556 | + {ReadableStream} is closed or rejected if the stream errors or the reader's |
| 557 | + lock is released before the stream finishes closing. |
556 | 558 |
|
557 | 559 | #### `readableStreamBYOBReader.read(view)` |
558 | 560 |
|
@@ -902,9 +904,9 @@ Closes the `WritableStream` when no additional writes are expected. |
902 | 904 | added: v16.5.0 |
903 | 905 | --> |
904 | 906 |
|
905 | | -* Type: A promise that is fulfilled with `undefined` when the |
906 | | - associated {WritableStream} is closed or this writer's lock is |
907 | | - released. |
| 907 | +* Type: {Promise} Fulfilled with `undefined` when the associated |
| 908 | + {WritableStream} is closed or rejected if the stream errors or the writer's |
| 909 | + lock is released before the stream finishes closing. |
908 | 910 |
|
909 | 911 | #### `writableStreamDefaultWriter.desiredSize` |
910 | 912 |
|
|