TransformStreamDefaultController: desiredSize property

Note: This feature is available in Web Workers.

The desiredSize read-only property of the TransformStreamDefaultController interface returns the desired size to fill the queue of the associated ReadableStream.

The internal queue of a ReadableStream contains chunks that have been enqueued, but not yet read. The browser determines the desired size to fill the stream, and it is this value returned by the desiredSize property.

If the desiredSize is 0 then the queue is full. Therefore you can use this information to manually apply backpressure to manage the queue.

Value

The desired size.

Examples

In the next example the desiredSize is logged to the console.

js
console.log(controller.desiredSize);

Specifications

Specification
Streams
# ts-default-controller-desired-size

Browser compatibility

Report problems with this compatibility data on GitHub
desktopmobileserver
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
Deno
Node.js
desiredSize

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support