ByteLengthQueuingStrategy

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 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

js
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);