Base de conhecimentoCentro de Exames
PT · PTPortuguês (Portugal)
Escolher idioma13

CKTIS / JavaScript

ReadableStream.getReader(): leitores e bloqueio do fluxo

getReader() devolve um leitor e bloqueia o fluxo. A leitura é assíncrona; releaseLock() liberta o bloqueio sem cancelar o fluxo.

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

Sintaxe

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

stream.getReader() devolve, de forma síncrona, um ReadableStreamDefaultReader. O bloqueio impede a obtenção de outro leitor; uma tentativa provoca um TypeError.

reader.read() devolve uma promessa para { value, done }. done: true significa que a leitura terminou; a rejeição da promessa assinala um erro. Liberta o bloqueio com reader.releaseLock() num bloco finally. Libertar o bloqueio não cancela o fluxo.

stream.getReader({ mode: "byob" }) devolve um ReadableStreamBYOBReader: read(view) aceita uma vista de um buffer. O modo BYOB requer um fluxo de bytes legível, independentemente da forma como foi criado. Chamar getReader() neste modo num fluxo que não seja de bytes provoca um TypeError. A opção type: "bytes" é uma forma de criar um fluxo deste tipo. O corpo de uma resposta do Fetch, se não for null, pode já ser um fluxo de bytes legível, sem que o código que faz a chamada tenha de o criar. Colocar apenas blocos Uint8Array na fila não é suficiente.

Esta é uma API Web WHATWG, não uma funcionalidade de uma edição específica de ECMAScript. Verifica separadamente a disponibilidade do leitor predefinido e de BYOB no ambiente de destino.

Exemplos

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

Resultado

AB
false

O código apresentado e o resultado declarado foram verificados num ambiente isolado pelo método registado na prova de verificação desta versão exata.

Fontes