1. Web
  2. Web APIs
  3. ByteLengthQueuingStrategy
  4. highWaterMark

ByteLengthQueuingStrategy: highWaterMark property

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since ⁨January 2019⁩.

Note: This feature is available in Web Workers.

The read-only ByteLengthQueuingStrategy.highWaterMark property returns the total number of bytes that can be contained in the internal queue before backpressure is applied.

Note: Unlike CountQueuingStrategy() where the highWaterMark property specifies a simple count of the number of chunks, with ByteLengthQueuingStrategy(), the highWaterMark parameter specifies a number of bytes — specifically, given a stream of chunks, how many bytes worth of those chunks (rather than a count of how many of those chunks) can be contained in the internal queue before backpressure is applied.

Values

An integer.

Examples

js
const queuingStrategy = new ByteLengthQueuingStrategy({
 highWaterMark: 1 * 1024,
});
const readableStream = new ReadableStream(
 {
 start(controller) {
 // ...
 },
 pull(controller) {
 // ...
 },
 cancel(err) {
 console.log("stream error:", err);
 },
 },
 queuingStrategy,
);
const size = queuingStrategy.size(chunk);
console.log(`highWaterMark value: ${queuingStrategy.highWaterMark}$`);

Specifications

Specification
Streams
# ref-for-blqs-high-water-mark1

Browser compatibility

See also

Help improve MDN

Learn how to contribute

This page was last modified on by MDN contributors.

AltStyle によって変換されたページ (->オリジナル) /