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

Der TransformStream() Konstruktor erstellt ein neues TransformStream Objekt, das ein Paar von Streams darstellt: einen WritableStream, der die beschreibbare Seite repräsentiert, und einen ReadableStream, der die lesbare Seite repräsentiert.

Syntax

new TransformStream()
new TransformStream(transformer)
new TransformStream(transformer, writableStrategy)
new TransformStream(transformer, writableStrategy, readableStrategy)

Parameter

transformer Optional

Ein Objekt, das den transformer darstellt. Wenn es nicht angegeben wird, resultiert der Stream in einem Identitäts-Transform-Stream, der alle an seine beschreibbare Seite geschriebenen Chunks an seine lesbare Seite weiterleitet, ohne Änderungen vorzunehmen.

Das Transformer-Objekt kann eine der folgenden Methoden enthalten. In jeder Methode ist controller eine Instanz von TransformStreamDefaultController.

start(controller)

Wird aufgerufen, wenn der TransformStream konstruiert wird. Es wird typischerweise verwendet, um Chunks mit TransformStreamDefaultController.enqueue() in die Warteschlange zu stellen.

transform(chunk, controller)

Wird aufgerufen, wenn ein an die beschreibbare Seite geschriebener Chunk zur Transformation bereit ist, und führt die Arbeit des Transformationsstreams aus. Es kann ein Promise zurückgeben, um den Erfolg oder Misserfolg der Schreiboperation zu signalisieren. Wenn keine transform() Methode angegeben ist, wird die Identitäts-Transformation verwendet, und der Chunk wird ohne Änderungen in die Warteschlange gestellt.

flush(controller)

Wird aufgerufen, nachdem alle an die beschreibbare Seite geschriebenen Chunks erfolgreich transformiert wurden und die beschreibbare Seite geschlossen werden soll.

writableStrategy Optional

Ein Objekt, das optional eine Warteschlangenstrategie für den Stream definiert. Dies nimmt zwei Parameter:

highWaterMark

Eine nicht-negative Ganzzahl. Dies definiert die Gesamtzahl der Chunks, die in der internen Warteschlange enthalten sein können, bevor Gegendruck angewendet wird.

size(chunk)

Eine Methode, die einen Parameter chunk enthält. Dies gibt die Größe an, die für jeden Chunk in Bytes verwendet werden soll.

readableStrategy Optional

Ein Objekt, das optional eine Warteschlangenstrategie für den Stream definiert. Dies nimmt zwei Parameter:

highWaterMark

Eine nicht-negative Ganzzahl. Dies definiert die Gesamtzahl der Chunks, die in der internen Warteschlange enthalten sein können, bevor Gegendruck angewendet wird.

size(chunk)

Eine Methode, die einen Parameter chunk enthält. Dies gibt die Größe an, die für jeden Chunk in Bytes verwendet werden soll.

Hinweis: Sie könnten Ihre eigene benutzerdefinierte readableStrategy oder writableStrategy definieren, oder eine Instanz von ByteLengthQueuingStrategy oder CountQueuingStrategy für die Objektwerte verwenden.

Beispiele

Text in Großbuchstaben umwandeln

Das folgende Beispiel wandelt Text Stück für Stück in Großbuchstaben um. Dieses Beispiel stammt aus Streams—The Definitive Guide, das eine Reihe von Beispielen für verschiedene Arten von Streams enthält.

function upperCaseStream() {
  return new TransformStream({
    transform(chunk, controller) {
      controller.enqueue(chunk.toUpperCase());
    },
  });
}

function appendToDOMStream(el) {
  return new WritableStream({
    write(chunk) {
      el.append(chunk);
    },
  });
}

fetch("./lorem-ipsum.txt").then((response) =>
  response.body
    .pipeThrough(new TextDecoderStream())
    .pipeThrough(upperCaseStream())
    .pipeTo(appendToDOMStream(document.body)),
);

Erstellen eines Identitäts-Transformationsstreams

Wenn kein transformer Argument angegeben wird, resultiert dies in einem Identitäts-Transformationsstream, der alle an die beschreibbare Seite geschriebenen Chunks unverändert an die lesbare Seite weiterleitet. Im folgenden Beispiel wird ein Identitäts-Transformationsstream verwendet, um einer Pipe Pufferung hinzuzufügen.

const writableStrategy = new ByteLengthQueuingStrategy({
  highWaterMark: 1024 * 1024,
});
readableStream
  .pipeThrough(new TransformStream(undefined, writableStrategy))
  .pipeTo(writableStream);

Spezifikationen

Browser-Kompatibilität