ReadableByteStreamController: desiredSize-Eigenschaft

Hinweis: Dieses Feature ist verfügbar in Web Workers.

Die schreibgeschützte Eigenschaft desiredSize der Schnittstelle ReadableByteStreamController gibt die Anzahl der Bytes zurück, die erforderlich sind, um die interne Warteschlange des Streams auf ihre "gewünschte Größe" zu füllen.

Der Wert wird vom Stream verwendet, um eine bevorzugte Flussrate an die zugrunde liegende Quelle anzuzeigen. Quellen, die das Drosseln oder Pausieren ihres Datenzuflusses unterstützen (das tun nicht alle!), sollten den Zufluss so steuern, dass die desiredSize des Stream-Puffers positiv und so nahe wie möglich an null gehalten wird.

Die desiredSize wird verwendet, um Backpressure von nachgelagerten Verbrauchern anzuwenden.

Wert

Ein ganzzahliger Wert. Es ist zu beachten, dass dieser negativ sein kann, wenn die Warteschlange überfüllt ist.

Der Wert wird null sein, wenn der Stream fehlerhaft ist, und 0, wenn er geschlossen ist.

Beispiele

Das Beispiel Ein lesbarer Stream mit einer zugrunde liegenden Push-Quelle und Backpressure-Unterstützung in der Spezifikation bietet ein gutes Beispiel für die Verwendung von desiredSize, um manuell zu erkennen, wann der Stream voll ist und Backpressure anzuwenden.

Während das Beispiel eine Standardquelle verwendet, sind die Konzepte genau die gleichen wie für lesbare Bytequellen.

Spezifikationen

Specification
Streams Standard
# ref-for-rbs-controller-desired-size②

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch