W3cubDocs

/DOM

ByteLengthQueuingStrategy.constructor

Draft
This page is not complete.

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

No compatibility data found. Please contribute data for "path.to.feature.NameOfTheConstructor" (depth: 1) to the MDN compatibility data repository.

© 2005–2018 Mozilla Developer Network and individual contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/ByteLengthQueuingStrategy/ByteLengthQueuingStrategy