From 941c56e75f2e293ecdef3b97b9f1007d79522929 Mon Sep 17 00:00:00 2001 From: OneNail Date: Mon, 25 Apr 2022 14:24:10 +0800 Subject: [PATCH 1/5] doc: fix errors in Web Streams doc --- doc/api/webstreams.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/doc/api/webstreams.md b/doc/api/webstreams.md index 93effbdf0e4f9d..aef8f0e3d79b65 100644 --- a/doc/api/webstreams.md +++ b/doc/api/webstreams.md @@ -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` + is not cause this `ReadableStream` to be canceled. * `preventClose` {boolean} When `true`, closing this `ReadableStream` - will no cause `transform.writable` to be closed. + will no 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). From 62203b12cb6a5801f40a8dcb9336db36f21b3209 Mon Sep 17 00:00:00 2001 From: OneNail Date: Mon, 25 Apr 2022 15:36:25 +0800 Subject: [PATCH 2/5] doc: fix typo --- doc/api/webstreams.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/api/webstreams.md b/doc/api/webstreams.md index aef8f0e3d79b65..30ab63a1861abb 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` will not cause this `ReadableStream` to be canceled. * `preventClose` {boolean} When `true`, closing this `ReadableStream` - will no cause `transform.writable` to be closed. + will 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`. @@ -285,9 +285,9 @@ added: v16.5.0 * `preventAbort` {boolean} When `true`, errors in this `ReadableStream` will not cause `destination` to be aborted. * `preventCancel` {boolean} When `true`, errors in the `destination` - is not cause this `ReadableStream` to be canceled. + will not cause this `ReadableStream` to be canceled. * `preventClose` {boolean} When `true`, closing this `ReadableStream` - will no cause `destination` to be closed. + will 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` From 440fc77763389bbbcc853474db1db47fc1916090 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Mon, 2 May 2022 14:15:01 -0700 Subject: [PATCH 3/5] Update doc/api/webstreams.md --- doc/api/webstreams.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/api/webstreams.md b/doc/api/webstreams.md index 30ab63a1861abb..cc628ee7c3cb47 100644 --- a/doc/api/webstreams.md +++ b/doc/api/webstreams.md @@ -206,7 +206,7 @@ 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` will not cause this `ReadableStream` to be + `transform.writable` do not cause this `ReadableStream` to be canceled. * `preventClose` {boolean} When `true`, closing this `ReadableStream` will not cause `transform.writable` to be closed. From c919a8fb530a106b229fdf4985a074e988049869 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Mon, 2 May 2022 14:15:33 -0700 Subject: [PATCH 4/5] Update doc/api/webstreams.md --- doc/api/webstreams.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/api/webstreams.md b/doc/api/webstreams.md index cc628ee7c3cb47..2818842559a41a 100644 --- a/doc/api/webstreams.md +++ b/doc/api/webstreams.md @@ -209,7 +209,7 @@ added: v16.5.0 `transform.writable` do not cause this `ReadableStream` to be canceled. * `preventClose` {boolean} When `true`, closing this `ReadableStream` - will not 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`. From 887ef9ec9b6ab43eac09e8778dc6cc09f7f9b111 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Mon, 2 May 2022 14:15:56 -0700 Subject: [PATCH 5/5] Update doc/api/webstreams.md --- doc/api/webstreams.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/api/webstreams.md b/doc/api/webstreams.md index 2818842559a41a..d8301ae640f2fa 100644 --- a/doc/api/webstreams.md +++ b/doc/api/webstreams.md @@ -287,7 +287,7 @@ added: v16.5.0 * `preventCancel` {boolean} When `true`, errors in the `destination` will not cause this `ReadableStream` to be canceled. * `preventClose` {boolean} When `true`, closing this `ReadableStream` - will not cause `destination` 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`