Znalostní bázeCentrum zkoušek
CSČeština
Vybrat jazyk13

CKTIS / JavaScript

TransformStream: transform, flush a controller.enqueue

Zpracovávejte vstupní bloky v `transform()`, předávejte výstup přes `controller.enqueue()` a při řádném uzavření vyprázdněte vyrovnávací paměť pomocí `flush()`.

Verze: ECMAScript 2024 and the current web platform; runtime support varies

Syntaxe

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

// Optional transformer methods:
transform(chunk, controller)
flush(controller)

// Output from either method:
controller.enqueue(chunk)

TransformStream propojuje stranu pro zápis (writable), která přijímá vstup, se stranou pro čtení (readable), která poskytuje výstup. Konstruktor přijímá volitelný objekt transformer. Další dva volitelné argumenty určují strategie řazení do fronty, nejdřív pro zápis a potom pro čtení. Jde o součást rozhraní Web Streams API, nikoli ECMAScriptu 2024; ověřte podporu v cílovém běhovém prostředí.

transform(chunk, controller) se volá pro každý vstupní blok, jakmile je připraven ke zpracování. Výsledných bloků může být nula, jeden nebo více: stačí odpovídající počet volání controller.enqueue(chunk) na předaném objektu TransformStreamDefaultController. Návratová hodnota funkce není výstup. Bez transform() procházejí bloky beze změny.

Volitelná metoda flush(controller) se volá při řádném uzavírání strany pro zápis, až po úspěšném zpracování všech vstupních bloků. Může předat zbytek z vyrovnávací paměti, než API uzavře stranu pro čtení; neslouží k úklidu při zrušení či přerušení. API čeká na příslib vrácený kteroukoli z těchto metod. Výjimka nebo zamítnutý příslib uvede proud do chybového stavu, proto zahrňte asynchronní práci do vraceného příslibu.

enqueue() předá blok straně pro čtení, vrátí undefined a vyvolá TypeError, pokud čtecí strana už bloky nepřijímá. Nečeká na odběratele. Zpětný tlak (backpressure) může pozdržet zpracování dalších zápisů, ale neurčuje pevný limit počtu volání enqueue() v rámci jednoho volání funkce transform() nebo flush(). Připojte odběratele, než začnete čekat na dokončení zápisů.

Příklady

(async () => {
  const input = new ReadableStream({
    start(sourceController) {
      for (const value of [1, 2, 3]) sourceController.enqueue(value);
      sourceController.close();
    },
  });

  let pending = [];
  const pairs = new TransformStream({
    transform(chunk, controller) {
      pending.push(chunk);
      if (pending.length === 2) {
        controller.enqueue(pending);
        pending = [];
      }
    },
    flush(controller) {
      if (pending.length > 0) controller.enqueue(pending);
    },
  });

  const output = [];
  await input.pipeThrough(pairs).pipeTo(new WritableStream({
    write(chunk) {
      output.push(chunk);
    },
  }));
  console.log(JSON.stringify(output));
})().catch((error) => console.error(error));

Výsledek

[[1,2],[3]]

Ve výchozím nastavení `pipeThrough()` přenese řádné uzavření zdroje na stranu transformace pro zápis a `pipeTo()` průběžně odebírá výstup. `transform()` předá dvojici `[1,2]` a `flush()` předá zbývající prvek jako `[3]`.

Související lekce

  • JavaScript · Lekce 4 · Pokročilá · Verze: 4

Zdroje