WritableStreamDefaultWriter: desiredSize-Eigenschaft
Baseline
Weitgehend verfügbar
Diese Funktion ist gut etabliert und funktioniert auf vielen Geräten und in vielen Browserversionen. Sie ist seit Mai 2022 browserübergreifend verfügbar.
Hinweis: Diese Funktion ist in Web Workers verfügbar.
Die desiredSize schreibgeschützte Eigenschaft der WritableStreamDefaultWriter-Schnittstelle gibt die gewünschte Größe zurück, die benötigt wird, um die interne Warteschlange des Streams zu füllen.
Wert
Eine Zahl oder null.
Die Zahl kann negativ sein, wenn die Warteschlange überfüllt ist. Wenn eine benutzerdefinierte Warteschlangenstrategie verwendet wird, können deren Blockgrößen dazu führen, dass die Zahl eine dezimale Komponente hat. Der Wert ist null, wenn der Stream fehlerhaft ist oder ein Fehler aufgetreten ist, und 0, wenn er geschlossen ist.
Ausnahmen
TypeError-
Die Sperre des Writers ist freigegeben.
Beispiele
const writableStream = new WritableStream(
{
write(chunk) {
// …
},
close() {
// …
},
abort(err) {
// …
},
},
queuingStrategy,
);
// …
const writer = writableStream.getWriter();
// …
// return stream's desired size
const size = writer.desiredSize;
Spezifikationen
| Spezifikation |
|---|
| Streams # ref-for-default-writer-desired-size⑥ |