ByteLengthQueuingStrategy

Baseline 2022

Newly available

Since June 2022, this feature works across the latest devices and browser versions. This feature might not work in older devices or browsers.

Note: This feature is available in Web Workers.

The ByteLengthQueuingStrategy interface of the Streams API provides a built-in byte length queuing strategy that can be used when constructing streams.

Constructor

ByteLengthQueuingStrategy(): Creates a new ByteLengthQueuingStrategy object instance.

Instance properties

ByteLengthQueuingStrategy.highWaterMark Read only: The total number of bytes that can be contained in the internal queue before backpressure is applied.

Instance methods

ByteLengthQueuingStrategy.size(): Returns the given chunk's byteLength property.

Examples

const queueingStrategy = new ByteLengthQueuingStrategy({ highWaterMark: 1024 });

const readableStream = new ReadableStream(
  {
    start(controller) {
      // …
    },
    pull(controller) {
      // …
    },
    cancel(err) {
      console.log("stream error:", err);
    },
  },
  queueingStrategy,
);

const size = queueingStrategy.size(chunk);

Specifications

Specification
Streams Standard # blqs-class

Browser compatibility

BCD tables only load in the browser