diff options
| author | OneNail <onenail@yeah.net> | 2022-05-03 05:07:43 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-05-03 05:07:43 +0300 |
| commit | 2be596604ac13a4dd68eb9cc38e54f2df438dd97 (patch) | |
| tree | fdc12ec3d396c0cba765a52247210f046833b47a /doc | |
| parent | f6f95bf61e84dae44b16c51ebb4a9c5b46194583 (diff) | |
doc: fix errors in Web Streams doc
PR-URL: https://github.com/nodejs/node/pull/42862
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: Mestery <mestery@protonmail.com>
Reviewed-By: Harshitha K P <harshitha014@gmail.com>
Reviewed-By: Akhil Marsonya <akhil.marsonya27@gmail.com>
Reviewed-By: Zeyu Yang <himself65@outlook.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/webstreams.md | 17 |
1 files changed, 8 insertions, 9 deletions
diff --git a/doc/api/webstreams.md b/doc/api/webstreams.md index 93effbdf0e4..d8301ae640f 100644 --- a/doc/api/webstreams.md +++ b/doc/api/webstreams.md @@ -206,10 +206,10 @@ added: v16.5.0 * `preventAbort` {boolean} When `true`, errors in this `ReadableStream` will not cause `transform.writable` to be aborted. * `preventCancel` {boolean} When `true`, errors in the destination - `transform.writable` is not cause this `ReadableStream` to be + `transform.writable` do not cause this `ReadableStream` to be canceled. * `preventClose` {boolean} When `true`, closing this `ReadableStream` - will no cause `transform.writable` to be closed. + does not cause `transform.writable` to be closed. * `signal` {AbortSignal} Allows the transfer of data to be canceled using an {AbortController}. * Returns: {ReadableStream} From `transform.readable`. @@ -283,12 +283,11 @@ added: v16.5.0 `ReadableStream`'s data will be written. * `options` {Object} * `preventAbort` {boolean} When `true`, errors in this `ReadableStream` - will not cause `transform.writable` to be aborted. - * `preventCancel` {boolean} When `true`, errors in the destination - `transform.writable` is not cause this `ReadableStream` to be - canceled. + will not cause `destination` to be aborted. + * `preventCancel` {boolean} When `true`, errors in the `destination` + will not cause this `ReadableStream` to be canceled. * `preventClose` {boolean} When `true`, closing this `ReadableStream` - will no cause `transform.writable` to be closed. + does not cause `destination` to be closed. * `signal` {AbortSignal} Allows the transfer of data to be canceled using an {AbortController}. * Returns: A promise fulfilled with `undefined` @@ -319,7 +318,7 @@ added: v16.5.0 * `options` {Object} * `preventCancel` {boolean} When `true`, prevents the {ReadableStream} from being closed when the async iterator abruptly terminates. - **Defaults**: `false` + **Default**: `false`. Creates and returns an async iterator usable for consuming this `ReadableStream`'s data. @@ -461,7 +460,7 @@ changes: --> The `ReadableStreamBYOBReader` is an alternative consumer for -byte-oriented {ReadableStream}'s (those that are created with +byte-oriented {ReadableStream}s (those that are created with `underlyingSource.type` set equal to `'bytes'` when the `ReadableStream` was created). |