KennisbankExamencentrum
NL · NLNederlands (Nederland)
Taal kiezen13

CKTIS / JavaScript

ReadableStream.getReader(): readers en streamvergrendeling

getReader() geeft een reader terug en vergrendelt de stream. Lezen gebeurt asynchroon; releaseLock() heft de vergrendeling op zonder de stream te annuleren.

Versie: 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() geeft synchroon een ReadableStreamDefaultReader terug. Door de vergrendeling kan er geen tweede reader worden verkregen; een poging daartoe veroorzaakt een TypeError.

reader.read() geeft een promise voor { value, done } terug. done: true betekent dat het lezen is voltooid; een afwijzing van de promise duidt op een fout. Hef de vergrendeling op met reader.releaseLock() in een finally-blok. Het opheffen ervan annuleert de stream niet.

stream.getReader({ mode: "byob" }) geeft een ReadableStreamBYOBReader terug: read(view) accepteert een bufferview. Voor de BYOB-modus is een leesbare bytestream nodig, ongeacht hoe die is gemaakt. Als je getReader() in deze modus aanroept op een stream die geen bytestream is, krijg je een TypeError. Met de optie type: "bytes" kun je zo’n stream maken. De body van een Fetch-respons kan, als die niet null is, al een leesbare bytestream zijn zonder dat je die zelf hoeft te maken. Alleen Uint8Array-chunks in de wachtrij plaatsen is niet voldoende.

Dit is een WHATWG Web API, geen functie van een bepaalde ECMAScript-editie. Controleer in de doelomgeving afzonderlijk of de standaardreader en BYOB beschikbaar zijn.

Voorbeelden

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);

Resultaat

AB
false

De getoonde code en het opgegeven resultaat zijn in een geïsoleerde omgeving geverifieerd met de methode die in het verificatiebewijs voor exact deze versie is vastgelegd.

Bronnen