WritableStreamDefaultWriter: desiredSize-Eigenschaft

Hinweis: Diese Funktion ist in Web Workers verfügbar.

Die schreibgeschützte Eigenschaft desiredSize des WritableStreamDefaultWriter-Interfaces gibt die gewünschte Größe zurück, die benötigt wird, um die interne Warteschlange des Streams zu füllen.

Wert

Ein Ganzzahlwert. Beachten Sie, dass dieser negativ sein kann, wenn die Warteschlange überfüllt ist.

Der Wert ist null, wenn in den Stream nicht erfolgreich geschrieben werden kann (entweder aufgrund eines Fehlers oder wegen einer anstehenden Abbruchoperation) und null, wenn der Stream geschlossen ist.

Ausnahmen

TypeError

Die Sperre des Writers ist freigegeben.

Beispiele

js
const writableStream = new WritableStream(
  {
    write(chunk) {
      // ...
    },
    close() {
      // ...
    },
    abort(err) {
      // ...
    },
  },
  queuingStrategy,
);

// ...

const writer = writableStream.getWriter();

// ...

// return stream's desired size
let size = writer.desiredSize;

Spezifikationen

Specification
Streams
# ref-for-default-writer-desired-size⑥

Browser-Kompatibilität

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