CKTIS / JavaScript
ReadableStream.pipeTo — doorsturen naar een schrijfbare stream
pipeTo() draagt chunks over aan een WritableStream, houdt rekening met backpressure en retourneert een promise die aangeeft wanneer de bewerking is voltooid.
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
readable.pipeTo(destination, { preventClose: false, preventAbort: false, preventCancel: false, signal })ReadableStream.pipeTo draagt chunks over aan een WritableStream. De methode retourneert een Promise die bij succes wordt vervuld met undefined. pipeThrough() daarentegen retourneert de bestaande leesbare stream uit het meegegeven paar, zonder een nieuwe stream aan te maken.
Het doorsturen houdt rekening met backpressure: het lezen hangt af van de gereedheid van de bestemming. Beide streams worden vergrendeld en de vergrendelingen worden na afloop vrijgegeven. Als een van beide streams al vergrendeld is, wordt de promise afgewezen met een TypeError.
Standaard sluit het sluiten van de bron de bestemming, breekt een fout in de bron de bestemming af en annuleert een fout in de bestemming de bron. preventClose, preventAbort en preventCancel schakelen deze doorgifte respectievelijk uit; standaard zijn ze alle drie false. Ze voorkomen niet dat de promise wordt afgewezen. signal accepteert een AbortSignal; afbreken annuleert de bron en breekt de bestemming af, afhankelijk van deze opties.
Verwerk afwijzingen met await en try/catch, of met .catch(). Dit is een Web API uit de WHATWG Streams-standaard, geen functie van een bepaalde ECMAScript-editie. Controleer de beschikbaarheid in de doelbrowser; Node 24 toont niet aan dat browsers dit ondersteunen.
Voorbeelden
(async () => {
const chunks = [];
const readable = new ReadableStream({
start(controller) {
controller.enqueue("A");
controller.enqueue("B");
controller.close();
}
});
const writable = new WritableStream({
write(chunk) {
chunks.push(chunk);
},
close() {
chunks.push("closed");
}
});
await readable.pipeTo(writable);
console.log(chunks.join("|"));
console.log(readable.locked, writable.locked);
})().catch(console.error);Resultaat
A|B|closed false 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.