Skip to content

Commit 726f4b2

Browse files
Add HWM and size algorithms to "set up a TransformStream"
1 parent e2f0705 commit 726f4b2

File tree

1 file changed

+17
-10
lines changed

1 file changed

+17
-10
lines changed

index.bs

+17-10
Original file line numberDiff line numberDiff line change
@@ -6819,7 +6819,7 @@ for="ReadableStream">locked</dfn> if ! [$IsReadableStreamLocked$](|stream|) retu
68196819
up"><var>writeAlgorithm</var></dfn>, an optional algorithm <dfn export for="WritableStream/set
68206820
up"><var>closeAlgorithm</var></dfn>, an optional algorithm <dfn export for="WritableStream/set
68216821
up"><var>abortAlgorithm</var></dfn>, an optional number <dfn export for="WritableStream/set
6822-
up"><var>highWaterMark</var></dfn> (default 1), an optional algorithm <dfn export
6822+
up"><var>highWaterMark</var></dfn> (default 1), and an optional algorithm <dfn export
68236823
for="WritableStream/set up"><var>sizeAlgorithm</var></dfn>, perform the following steps.
68246824
|writeAlgorithm| must be an algorithm that accepts a [=chunk=] object and returns a promise. If
68256825
given, |closeAlgorithm| and |abortAlgorithm| may return a promise. If given, |sizeAlgorithm| must
@@ -6900,14 +6900,22 @@ reason.
69006900
<div algorithm="create a TransformStream">
69016901
To <dfn export for="TransformStream" lt="set up|setting up">set up</dfn> a
69026902
newly-[=new|created-via-Web IDL=] {{TransformStream}} |stream| given an algorithm <dfn export
6903-
for="TransformStream/set up"><var>transformAlgorithm</var></dfn> and an optional algorithm <dfn
6904-
export for="TransformStream/set up"><var>flushAlgorithm</var></dfn>, perform the following steps.
6903+
for="TransformStream/set up"><var>transformAlgorithm</var></dfn>, an optional algorithm <dfn
6904+
export for="TransformStream/set up"><var>flushAlgorithm</var></dfn>, an optional number <dfn
6905+
export for="TransformStream/set up"><var>writableHighWaterMark</var></dfn> (default 1), an optional
6906+
algorithm <dfn export for="TransformStream/set up"><var>writableSizeAlgorithm</var></dfn>, an
6907+
optional number <dfn export for="TransformStream/set up"><var>readableHighWaterMark</var></dfn>
6908+
(default 0), and an optional algorithm <dfn export
6909+
for="TransformStream/set up"><var>readableSizeAlgorithm</var></dfn>, perform the following steps.
69056910
|transformAlgorithm| and, if given, |flushAlgorithm|, may return a promise.
6911+
If given, |writableSizeAlgorithm| and |readableSizeAlgorithm| must be algorithms accepting
6912+
[=chunk=] objects and returning a number; and if given, |writableHighWaterMark| and
6913+
|readableHighWaterMark| must be non-negative, non-NaN numbers.
69066914

6907-
1. Let |writableHighWaterMark| be 1.
6908-
1. Let |writableSizeAlgorithm| be an algorithm that returns 1.
6909-
1. Let |readableHighWaterMark| be 0.
6910-
1. Let |readableSizeAlgorithm| be an algorithm that returns 1.
6915+
1. If |writableSizeAlgorithm| was not given, let |writableSizeAlgorithm| be an algorithm that
6916+
returns 1.
6917+
1. If |readableSizeAlgorithm| was not given, let |readableSizeAlgorithm| be an algorithm that
6918+
returns 1.
69116919
1. Let |transformAlgorithmWrapper| be an algorithm that runs these steps given a value |chunk|:
69126920
1. Let |result| be the result of running |transformAlgorithm| given |chunk|. If this throws an
69136921
exception |e|, return [=a promise rejected with=] |e|.
@@ -6952,7 +6960,7 @@ reason.
69526960
The following algorithms must only be used on {{TransformStream}} instances initialized via the
69536961
above [=TransformStream/set up=] algorithm. Usually they are called as part of
69546962
<var>[=TransformStream/set up/transformAlgorithm=]</var> or
6955-
<var>[=TransformStream/set up/flushAlgorithm=]</var>.
6963+
<var ignore>[=TransformStream/set up/flushAlgorithm=]</var>.
69566964

69576965
<p algorithm>To <dfn export for="TransformStream">enqueue</dfn> the JavaScript value |chunk| into a
69586966
{{TransformStream}} |stream|, perform !
@@ -6995,8 +7003,7 @@ Including the {{GenericTransformStream}} mixin will give an IDL interface the ap
69957003
the behavior of the resulting interface, its constructor (or other initialization code) must set
69967004
each instance's [=GenericTransformStream/transform=] to a [=new=] {{TransformStream}}, and then
69977005
[=TransformStream/set up|set it up=] with appropriate customizations via the
6998-
<var>[=TransformStream/set up/transformAlgorithm=]</var> and optionally
6999-
<var>[=TransformStream/set up/flushAlgorithm=]</var> arguments.
7006+
<var>[=TransformStream/set up/transformAlgorithm=]</var> and any optional arguments.
70007007

70017008
Note: Existing examples of this pattern on the web platform include {{CompressionStream}} and
70027009
{{TextDecoderStream}}. [[COMPRESSION]] [[ENCODING]]

0 commit comments

Comments
 (0)