TransformStream: TransformStream() Konstruktor

transformer Optional

Ein Objekt, das den transformer repräsentiert. Wird es nicht angegeben, resultiert der Stream in einem Identity Transform Stream, der alle an die beschreibbare Seite geschriebenen Chunks unverändert an die lesbare Seite weiterleitet.

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

start(controller)

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

transform(chunk, controller)

Wird aufgerufen, wenn ein an die beschreibbare Seite geschriebener Chunk bereit ist, transformiert zu werden, und führt die Arbeit des Transformations-Streams aus. Es kann ein Promise zurückgeben, um den Erfolg oder Misserfolg der Schreiboperation anzuzeigen. Wenn keine transform()-Methode angegeben wird, wird der Identity Transform verwendet und der Chunk wird unverändert in die Warteschlange eingereiht.

flush(controller)

Wird aufgerufen, nachdem alle an die beschreibbare Seite geschriebenen Chunks erfolgreich transformiert wurden und die beschreibbare Seite kurz vor dem Schließen steht.

writableStrategy Optional

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

highWaterMark

Eine nicht-negative ganze Zahl. Diese definiert die maximale Anzahl von Chunks, die in der internen Warteschlange enthalten sein können, bevor Backpressure angewendet wird.

size(chunk)

Eine Methode mit einem Parameter chunk. Diese 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 umfasst zwei Parameter:

highWaterMark

Eine nicht-negative ganze Zahl. Diese definiert die maximale Anzahl von Chunks, die in der internen Warteschlange enthalten sein können, bevor Backpressure angewendet wird.

size(chunk)

Eine Methode mit einem Parameter chunk. Diese gibt die Größe an, die für jeden Chunk in Bytes verwendet werden soll.

Das folgende Beispiel transformiert Text in Großbuchstaben, Chunk für Chunk. Dieses Beispiel stammt aus dem Streams—Der definitive Leitfaden, der eine Reihe von Beispielen verschiedener 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)),
);

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

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