WritableStreamDefaultWriter: desiredSize-Eigenschaft

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since June 2022.

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

BCD tables only load in the browser