WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / JavaScript

ReadableStream.getReader(): Reader und Streamsperre

getReader() gibt einen Reader zurück und sperrt den Stream. Das Lesen erfolgt asynchron; releaseLock() gibt die Sperre frei, bricht den Stream aber nicht ab.

Version: ECMAScript and Web APIs; exact feature edition and browser support reviewed per entry; Node 24 in repository does not prove browser API support

Syntax

stream.getReader()
stream.getReader({ mode: "byob" })

stream.getReader() gibt synchron einen ReadableStreamDefaultReader zurück. Die Sperre verhindert, dass ein weiterer Reader bezogen wird; der Versuch löst einen TypeError aus.

reader.read() gibt ein Promise für { value, done } zurück. done: true bedeutet, dass der Stream abgeschlossen ist; eine Zurückweisung signalisiert einen Fehler. Gib die Sperre mit reader.releaseLock() in einem finally-Block frei. Das Freigeben bricht den Stream nicht ab.

stream.getReader({ mode: "byob" }) gibt einen ReadableStreamBYOBReader zurück: read(view) nimmt eine Buffer-Ansicht entgegen. Der BYOB-Modus setzt einen lesbaren Byte-Stream voraus, unabhängig davon, wie er erstellt wurde. Wird getReader() in diesem Modus für einen Stream aufgerufen, der kein Byte-Stream ist, wird ein TypeError ausgelöst. Die Option type: "bytes" ist eine Möglichkeit, einen solchen Stream zu erstellen. Der Body einer Fetch-Antwort kann, wenn er nicht null ist, bereits ein lesbarer Byte-Stream sein, ohne dass der aufrufende Code ihn selbst erstellen muss. Es reicht nicht aus, lediglich Uint8Array-Chunks einzureihen.

Dies ist eine WHATWG-Web-API, keine Funktion einer bestimmten ECMAScript-Edition. Prüfe die Verfügbarkeit des Standard-Readers und von BYOB in der Zielumgebung jeweils separat.

Beispiele

async function main() {
  const stream = new ReadableStream({
    start(controller) {
      controller.enqueue("A");
      controller.enqueue("B");
      controller.close();
    }
  });
  const reader = stream.getReader();
  let text = "";
  try {
    while (true) {
      const { value, done } = await reader.read();
      if (done) break;
      text += value;
    }
  } finally {
    reader.releaseLock();
  }
  console.log(text);
  console.log(stream.locked);
}
main().catch(console.error);

Ergebnis

AB
false

Der angezeigte Code und das angegebene Ergebnis wurden in einer isolierten Umgebung mit der im Prüfnachweis für genau diese Version dokumentierten Methode verifiziert.

Quellen