W3cubDocs

/Web APIs

ByteLengthQueuingStrategy

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

Specifications

Specification
Streams Standard
# blqs-class

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
ByteLengthQueuingStrategy 52 16 65 No 39 10.1 52 52 65 41 10.3 6.0
ByteLengthQueuingStrategy 52 16 65 No 39 10.1 52 52 65 41 10.3 6.0
highWaterMark 52 16 65 No 39 10.1 52 52 65 41 10.3 6.0
size 52 16 65 No 39 10.1 52 52 65 41 10.3 6.0

See also

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/ByteLengthQueuingStrategy