ByteLengthQueuingStrategy

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

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

Instance methods

• 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

Browser compatibility

See also

• Streams API
• Internal queues and queuing strategies
• ByteLengthQueuingStrategy() constructor