Draft
This page is not complete.
This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The desiredSize
read-only property of the WritableStreamDefaultWriter
interface returns the desired size required to fill the stream's internal queue.
Syntax
var desiredSize =
writableStreamDefaultWriter.desiredSize;
Value
An integer. Note that this can be negative if the queue is over-full.
The value will be null
if the stream cannot be successfully written to (due to either being errored, or having an abort queued up), and zero if the stream is closed.
Exceptions
- TypeError
- The writerβs lock is released.
Examples
const writableStream = new WritableStream({ write(chunk) { ... }, close() { ... }, abort(err) { ... } }, queuingStrategy); ...
const writer = writableStream.getWriter(); ...
// return stream's desired size let size = writer.desiredSize;
Specifications
Specification | Status | Comment |
---|---|---|
Streams The definition of 'desiredSize' in that specification. |
Living Standard | Initial definition. |
Browser compatibility
The compatibility table on 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.
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
desiredSize | Chrome Full support 59 | Edge Full support 16 | Firefox No support No | IE No support No | Opera Full support 46 | Safari ? | WebView Android Full support 59 | Chrome Android Full support 59 | Firefox Android No support No | Opera Android Full support 43 | Safari iOS ? | Samsung Internet Android Full support 7.0 |
Legend
- Full support
- Full support
- No support
- No support
- Compatibility unknown
- Compatibility unknown
- Experimental. Expect behavior to change in the future.
- Experimental. Expect behavior to change in the future.