Skip to content

doc: fix errors in Web Streams doc #42862

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
May 3, 2022
Merged

doc: fix errors in Web Streams doc #42862

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
941c56e
doc: fix errors in Web Streams doc
y1d7ng Apr 25, 2022
62203b1
doc: fix typo
y1d7ng Apr 25, 2022
440fc77
Update doc/api/webstreams.md
Trott May 2, 2022
c919a8f
Update doc/api/webstreams.md
Trott May 2, 2022
887ef9e
Update doc/api/webstreams.md
Trott May 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 8 additions & 9 deletions doc/api/webstreams.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down Expand Up @@ -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`
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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).

Expand Down