Skip to content

Commit 183d8c2

Browse files
committed
doc: clarify writeable abort applies
Update to the documentation to confirm that 6.2.3 of the standard states: "A function called when the readable side is cancelled, or when the writable side is aborted."
1 parent ffa58ae commit 183d8c2

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

doc/api/webstreams.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1166,8 +1166,9 @@ added: v16.5.0
11661166
the transformation process.
11671167
* `controller` {TransformStreamDefaultController}
11681168
* Returns: A promise fulfilled with `undefined`.
1169-
* `cancel` {Function} A user-defined function that is called when the
1170-
readable side of the `TransformStream` is canceled.
1169+
* `cancel` {Function} A user-defined function that is called when either the
1170+
readable side of the `TransformStream` is canceled or the writable side is
1171+
aborted.
11711172
* `reason` {any}
11721173
* Returns: A promise fulfilled with `undefined`.
11731174
* `readableType` {any} the `readableType` option is reserved for future use

0 commit comments

Comments
 (0)