ReadableStreamDefaultController: close()-Methode

Baseline Weitgehend verfügbar

Diese Funktion ist gut etabliert und funktioniert auf vielen Geräten und in vielen Browserversionen. Sie ist seit Januar 2020 browserübergreifend verfügbar.

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

Die close()-Methode der ReadableStreamDefaultController-Schnittstelle schließt den zugehörigen Stream.

Leser können weiterhin alle zuvor in den Stream eingereihten Blöcke lesen, aber sobald diese gelesen wurden, wird der Stream geschlossen. Wenn Sie den Stream vollständig entfernen und alle eingereihten Blöcke verwerfen möchten, sollten Sie ReadableStream.cancel() oder ReadableStreamDefaultReader.cancel() verwenden.

In diesem Artikel

Syntax

close()

Parameter

Keine.

Rückgabewert

Keiner (undefined).

Ausnahmen

TypeError

Wird ausgelöst, wenn close() aufgerufen wird, während der Stream nicht lesbar ist — weil er bereits geschlossen, abgebrochen oder fehlerhaft ist — oder weil er vom zugrunde liegenden Quellobjekt gebeten wurde, sich zu schließen, es aber noch nicht getan hat, da noch eingereihte Blöcke zum Lesen vorhanden sind.

Beispiele

Im folgenden einfachen Beispiel wird ein benutzerdefinierter ReadableStream mithilfe eines Konstruktors erstellt (sehen Sie unser Einfaches Zufallsstrom-Beispiel für den vollständigen Code). Die start()-Funktion generiert jede Sekunde einen zufälligen Textstring und reiht ihn in den Stream ein. Eine cancel()-Funktion wird ebenfalls bereitgestellt, um die Generierung zu stoppen, wenn ReadableStream.cancel() aus irgendeinem Grund aufgerufen wird.

Wenn eine Schaltfläche gedrückt wird, wird die Generierung gestoppt, der Stream wird mit close() geschlossen und eine weitere Funktion wird ausgeführt, die die Daten wieder aus dem Stream liest.

js
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);
  },
});

Help improve MDN

War diese Übersetzung hilfreich?

Ja Nein

Erfahren Sie, wie Sie beitragen können Diese Seite wurde automatisch aus dem Englischen übersetzt.

Übersetzung auf GitHub anzeigen • Fehler mit dieser Übersetzung melden

Streams API
ReadableStreamDefaultController
Instanzeigenschaften
1. desiredSize
Instanzmethoden
Verwandte Seiten für Streams
Anleitungen
1. Streams API Konzepte
2. Verwendung von lesbaren Streams
3. Verwendung von lesbaren Bytestreams
4. Verwenden von beschreibbaren Streams