ByteLengthQueuingStrategy.ByteLengthQueuingStrategy()

Draft

This page is not complete.

Experimental

This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The ByteLengthQueuingStrategy() constructor creates and returns a ByteLengthQueuingStrategy object instance.

Syntax

var byteLengthQueuingStrategy = new ByteLengthQueuingStrategy({highWaterMark});

Parameters

{highWaterMark}
An object containing a highWaterMark property. This is a non-negative integer defining the total number of chunks that can be contained in the internal queue before backpressure is applied.

Return value

An instance of the ByteLengthQueuingStrategy object.

Exceptions

None.

Examples

const queuingStrategy = new ByteLengthQueuingStrategy({ highWaterMark: 1 });

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

var size = queuingStrategy.size(chunk);

Specifications

Specification Status Comment
Streams
The definition of 'ByteLengthQueuingStrategy()' in that specification.
Living Standard Initial definition.

Browser compatibility

BCD tables only load in the browser