WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / JavaScript

ReadableStream.pipeTo — in einen beschreibbaren Stream leiten

pipeTo() überträgt Datenblöcke an einen WritableStream, berücksichtigt den Rückstau und gibt ein Promise zurück, das den Abschluss der Operation anzeigt.

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

readable.pipeTo(destination, { preventClose: false, preventAbort: false, preventCancel: false, signal })

ReadableStream.pipeTo überträgt Datenblöcke an einen WritableStream. Die Methode gibt ein Promise zurück, das bei Erfolg mit undefined erfüllt wird. pipeThrough() dagegen gibt den vorhandenen lesbaren Stream aus dem übergebenen Paar zurück, ohne einen neuen Stream zu erzeugen.

Beim Weiterleiten wird der Rückstau berücksichtigt: Das Lesen richtet sich danach, ob das Ziel bereit ist. Beide Streams werden gesperrt und die Sperren nach Abschluss freigegeben. Ist einer der Streams bereits gesperrt, wird das Promise mit einem TypeError abgelehnt.

Standardmäßig schließt das Schließen der Quelle das Ziel, ein Fehler in der Quelle bricht das Ziel ab und ein Fehler im Ziel bricht die Quelle ab. preventClose, preventAbort und preventCancel deaktivieren jeweils diese Weitergabe; standardmäßig stehen alle auf false. Sie verhindern nicht, dass das Promise abgelehnt wird. signal akzeptiert ein AbortSignal; ein Abbruch bricht die Quelle ab und bricht das Ziel ab, vorbehaltlich dieser Optionen.

Behandle Ablehnungen mit await und try/catch oder mit .catch(). Dies ist eine Web-API aus dem WHATWG Streams-Standard und keine Funktion einer bestimmten ECMAScript-Version. Prüfe die Verfügbarkeit im Zielbrowser; Node 24 belegt keine Browser-Unterstützung.

Beispiele

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

Ergebnis

A|B|closed
false 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