Baza znanjaIzpitno središče
SLSlovenščina
Izberi jezik13

CKTIS / JavaScript

TransformStream: transform, flush in controller.enqueue

Obdeluj vhodne kose z `transform()`, oddajaj rezultate z `controller.enqueue()` in ob običajnem zapiranju izprazni medpomnilnik z `flush()`.

Različica: ECMAScript 2024 and the current web platform; runtime support varies

Sintaksa

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 povezuje vhodno stran (writable) z izhodno stranjo (readable). Konstruktor sprejme neobvezen objekt transformer. Naslednja neobvezna argumenta določata strategiji čakalnih vrst, najprej za zapisovalno, nato za bralno stran. To je del vmesnika Web Streams API, ne del ECMAScripta 2024; preveri podporo v ciljnem izvajalnem okolju.

transform(chunk, controller) se pokliče za vsak vhodni kos, ko je pripravljen za obdelavo. Z ustreznim številom klicev controller.enqueue(chunk) na prejetem objektu TransformStreamDefaultController lahko oddaš nič, enega ali več izhodnih kosov. Vrnjena vrednost funkcije ni izhod. Brez transform() se kosi posredujejo nespremenjeni.

Neobvezni flush(controller) se pokliče ob običajnem zapiranju zapisovalne strani, potem ko so vsi vhodni kosi uspešno obdelani. Lahko odda podatke, ki so ostali v medpomnilniku, preden API zapre bralno stran. Ni namenjen čiščenju ob preklicu ali prekinitvi. API počaka na obljubo, ki jo vrne katera koli od obeh funkcij. Izjema ali zavrnjena obljuba spravi tok v stanje napake, zato v vrnjeno obljubo vključi vse asinhrono delo.

enqueue() preda kos bralni strani, vrne undefined in sproži TypeError, če ta stran kosov ne sprejema več. Na porabnika ne čaka. Povratni pritisk (backpressure) lahko odloži obdelavo poznejših zapisov, vendar ne določa stroge omejitve števila klicev enqueue() v eni povratni funkciji. Priključi porabnika, preden začneš čakati na dokončanje zapisov.

Primeri

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

Rezultat

[[1,2],[3]]

Privzeto `pipeThrough()` prenese običajno zaprtje vira na zapisovalno stran pretvorbe, medtem ko `pipeTo()` sproti prevzema izhod. `transform()` odda par `[1,2]`, `flush()` pa preostali element kot `[3]`.

Povezane lekcije

  • JavaScript · Lekcija 4 · Napredna · Različica: 4

Viri