ReadableStream: pipeThrough() Methode

Baseline Weitgehend verfügbar

Diese Funktion ist gut etabliert und funktioniert auf vielen Geräten und in vielen Browserversionen. Sie ist seit Juni 2022 browserübergreifend verfügbar.

Hinweis: Diese Funktion ist in Web Workers verfügbar.

Die pipeThrough() Methode der ReadableStream-Schnittstelle bietet eine kaskadierbare Möglichkeit, den aktuellen Stream durch einen Transform-Stream oder ein anderes schreibbares/lesbares Paar zu leiten.

Das Leiten eines Streams sperrt diesen in der Regel für die Dauer der Pipe, was verhindert, dass andere Leser ihn sperren können.

In diesem Artikel

Syntax

js
pipeThrough(transformStream)
pipeThrough(transformStream, options)

Parameter

transformStream

Ein TransformStream (oder ein Objekt mit der Struktur {writable, readable}), bestehend aus einem lesbaren und einem schreibbaren Stream, die zusammenarbeiten, um Daten von einer Form in eine andere zu transformieren. Daten, die in den writable Stream geschrieben werden, können in einem transformierten Zustand vom readable Stream gelesen werden. Beispielsweise werden in einen TextDecoder Bytes geschrieben und Zeichenketten ausgelesen, während ein Videodecoder codierte Bytes geschrieben und unkomprimierte Videoframes ausgelesen werden.

options Optional

Die Optionen, die beim Leiten zum writable Stream verwendet werden sollen. Verfügbare Optionen sind:

preventClose

Wenn dies auf true gesetzt ist, führt das Schließen des Quellen-ReadableStream nicht mehr dazu, dass der Ziel-WritableStream geschlossen wird.

preventAbort

Wenn dies auf true gesetzt ist, führen Fehler im Quellen-ReadableStream nicht mehr dazu, dass der Ziel-WritableStream abgebrochen wird.

preventCancel

Wenn dies auf true gesetzt ist, führen Fehler im Ziel-WritableStream nicht mehr dazu, dass der Quellen-ReadableStream abgebrochen wird.

signal

Wenn auf ein AbortSignal-Objekt gesetzt, können laufende Pipe-Operationen dann über den entsprechenden AbortController abgebrochen werden.

js
// Fetch the original image
fetch("png-logo.png")
  // Retrieve its body as ReadableStream
  .then((response) => response.body)
  .then((rs) => logReadableStream("Fetch Response Stream", rs))
  // Create a gray-scaled PNG stream out of the original
  .then((body) => body.pipeThrough(new PNGTransformStream()))
  .then((rs) => logReadableStream("PNG Chunk Stream", rs));