Document new min option in ReadableStreamBYOBReader.prototype.read(view, { min })

[MattiasBuelens]

Proposal

The Streams specification has been updated to add an optional min option to byobReader.read(view). When the min option is given, the read will only be fulfilled as soon as min number of elements are available in the stream.

Browser support

This feature was only just added to the Streams specification, so there aren't any browsers that support this yet. The following browser implementation bugs have been filed as part of whatwg/streams#1145:

• Chrome: https://bugs.chromium.org/p/chromium/issues/detail?id=1501771
• Firefox: https://bugzilla.mozilla.org/show_bug.cgi?id=1864406
• Safari: https://bugs.webkit.org/show_bug.cgi?id=264731
• Node.js: Web Streams: support ReadableStreamBYOBReader.prototype.read(view, { min }) nodejs/node#50706
• Deno: feat(streams): ReadableStream.read min option denoland/deno#20849

Tasks

No response

Dependencies

No response

Additional information

The specification change is whatwg/streams#1145

The specification text already has some documentation for the new min option in the "for web developers section". This can serve as a good starting point for MDN.

Are you willing to support this work?

I can support with reviews and feedback.