ReadableStreamDefaultController
Baseline Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since January 2020.
Hinweis: Diese Funktion ist in Web Workers verfügbar.
Die ReadableStreamDefaultController-Schnittstelle der Streams-API repräsentiert einen Controller, der die Steuerung des Zustands und der internen Warteschlange eines ReadableStream ermöglicht. Standard-Controller dienen für Streams, die keine Byte-Streams sind.
Konstruktor
Keiner. ReadableStreamDefaultController-Instanzen werden automatisch während der ReadableStream-Konstruktion erstellt.
Instanz-Eigenschaften
ReadableStreamDefaultController.desiredSizeSchreibgeschützt-
Gibt die gewünschte Größe zurück, die erforderlich ist, um die interne Warteschlange des Streams zu füllen.
Instanz-Methoden
ReadableStreamDefaultController.close()-
Schließt den zugehörigen Stream.
ReadableStreamDefaultController.enqueue()-
Stellt ein gegebenes Chunk in die zugehörige Warteschlange des Streams.
ReadableStreamDefaultController.error()-
Verursacht, dass alle zukünftigen Interaktionen mit dem zugehörigen Stream zu einem Fehler führen.
Beispiele
Im folgenden einfachen Beispiel wird ein benutzerdefinierter ReadableStream mithilfe eines Konstruktors erstellt (siehe unser Einfaches Zufalls-Stream-Beispiel für den vollständigen Code). Die start()-Funktion generiert jede Sekunde eine zufällige Textzeichenfolge und stellt sie in die Warteschlange des Streams. Eine cancel()-Funktion wird ebenfalls bereitgestellt, um die Generierung zu stoppen, falls ReadableStream.cancel() aus irgendeinem Grund aufgerufen wird.
Beachten Sie, dass ein ReadableStreamDefaultController-Objekt als Parameter der start()- und pull()-Funktionen bereitgestellt wird.
Wenn eine Schaltfläche gedrückt wird, wird die Generierung gestoppt, der Stream mit ReadableStreamDefaultController.close() geschlossen und eine weitere Funktion ausgeführt, die die Daten aus dem Stream zurückliest.
let interval;
const stream = new ReadableStream({
start(controller) {
interval = setInterval(() => {
let string = randomChars();
// Add the string to the stream
controller.enqueue(string);
// show it on the screen
let listItem = document.createElement("li");
listItem.textContent = string;
list1.appendChild(listItem);
}, 1000);
button.addEventListener("click", () => {
clearInterval(interval);
fetchStream();
controller.close();
});
},
pull(controller) {
// We don't really need a pull in this example
},
cancel() {
// This is called if the reader cancels,
// so we should stop generating strings
clearInterval(interval);
},
});
Spezifikationen
| Specification |
|---|
| Streams # rs-default-controller-class |