dom / latest / writablestreamdefaultwriter / desiredsize.html /

WritableStreamDefaultWriter.desiredSize

Experimental: 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.

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

{{jsxsref("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

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
desiredSize
59
16
100
99-100
No
46
14.1
59
59
100
43
14.5
7.0

© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/WritableStreamDefaultWriter/desiredSize