Draft
This page is not complete.
This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The desiredSize
getter property of the ReadableStreamDefaultController
interface returns the desired size required to fill the stream's internal queue.
Syntax
var desiredSize =
readableStreamDefaultControllerInstance.desiredSize;
Value
An integer. Note that this can be negative if the queue is over-full.
Examples
The A readable stream with an underlying push source and backpressure support example in the spec provides a good example of using desiredSize
to manually detect when the stream is full and apply backpressure, and also of using ReadablestreamDefaultController.error()
to manually trigger a stream error if another part of the system it relies on fails.
Specifications
Specification | Status | Comment |
---|---|---|
Streams The definition of 'desiredSize' in that specification. |
Living Standard | Initial definition. |
Browser compatibility
The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
No compatibility data found. Please contribute data for "path.to.feature.NameOfTheProperty" (depth: 1) to the MDN compatibility data repository.