Skip to content

Commit

Permalink
doc: fix errors in Web Streams doc
Browse files Browse the repository at this point in the history
PR-URL: nodejs/node#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>
  • Loading branch information
y1d7ng authored and guangwong committed Oct 10, 2022
1 parent 8e3ce8b commit d1a522c
Showing 1 changed file with 8 additions and 9 deletions.
17 changes: 8 additions & 9 deletions doc/api/webstreams.md
Original file line number Diff line number Diff line change
Expand Up @@ -210,10 +210,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 @@ -287,12 +287,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 @@ -323,7 +322,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 @@ -457,7 +456,7 @@ added: v16.5.0
-->

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

0 comments on commit d1a522c

Please sign in to comment.