Base de connaissancesCentre d’examen
FRFrançais
Choisir la langue13

CKTIS / JavaScript

ReadableStream.getReader() : lecteurs et verrouillage du flux

getReader() renvoie un lecteur et verrouille le flux. La lecture est asynchrone ; releaseLock() libère le verrou sans annuler le flux.

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

Syntaxe

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

stream.getReader() renvoie de façon synchrone un ReadableStreamDefaultReader. Le verrou empêche d’obtenir un autre lecteur ; toute tentative déclenche une TypeError.

reader.read() renvoie une promesse pour { value, done }. done: true indique que la lecture est terminée ; le rejet de la promesse signale une erreur. Libérez le verrou avec reader.releaseLock() dans un bloc finally. Cette libération n’annule pas le flux.

stream.getReader({ mode: "byob" }) renvoie un ReadableStreamBYOBReader : read(view) accepte une vue de tampon. Le mode BYOB exige un flux d’octets lisible, quelle que soit la façon dont il a été créé. Appeler getReader() dans ce mode sur un flux qui n’est pas un flux d’octets déclenche une TypeError. L’option type: "bytes" est une façon de créer un tel flux. Le corps d’une réponse Fetch, s’il n’est pas null, peut déjà être un flux d’octets lisible, sans que le code appelant ait à le créer. Mettre simplement en file des blocs Uint8Array ne suffit pas.

Il s’agit d’une API Web WHATWG, et non d’une fonctionnalité d’une édition particulière d’ECMAScript. Vérifiez séparément la disponibilité du lecteur par défaut et de BYOB dans l’environnement cible.

Exemples

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

Résultat

AB
false

Le code affiché et le résultat déclaré ont été vérifiés dans un environnement isolé selon la méthode consignée dans la preuve de vérification de cette version exacte.

Sources