Baza wiedzyCentrum egzaminacyjne
PLPolski
Wybierz język13

CKTIS / JavaScript

TransformStream: transform, flush i controller.enqueue

Przetwarzaj kolejne porcje wejścia w `transform()`, przekazuj wyniki przez `controller.enqueue()` i opróżniaj własny bufor w `flush()` przy normalnym zamknięciu.

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

Składnia

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 łączy stronę zapisu (writable), która przyjmuje dane wejściowe, ze stroną odczytu (readable), która udostępnia wyniki. Przekaż opcjonalny obiekt transformer do konstruktora. Dwa kolejne opcjonalne argumenty określają strategie kolejkowania, najpierw dla zapisu, potem dla odczytu. To API platformy webowej, a nie część ECMAScript 2024; sprawdź obsługę w docelowym środowisku.

transform(chunk, controller) jest wywoływana dla każdej porcji wejścia, gdy można ją przetworzyć. Aby przekazać zero, jedną lub więcej porcji wyniku, wywołaj controller.enqueue(chunk) odpowiednią liczbę razy na otrzymanym obiekcie TransformStreamDefaultController. Zwrócona wartość nie jest wynikiem transformacji. Bez metody transform() porcje przechodzą bez zmian.

Opcjonalna metoda flush(controller) jest wywoływana przy normalnym zamknięciu strony zapisu, gdy wszystkie porcje zostały pomyślnie przetworzone. Może przekazać resztę bufora, zanim API zamknie stronę odczytu; nie jest procedurą sprzątania po anulowaniu ani przerwaniu. API czeka na obietnicę zwróconą przez każdą z tych metod. Zgłoszenie wyjątku lub odrzucenie obietnicy powoduje błąd strumienia, więc nie zostawiaj pracy asynchronicznej poza zwracaną obietnicą.

enqueue() przekazuje porcję stronie odczytu, zwraca undefined i zgłasza TypeError, jeśli strona odczytu nie przyjmuje już porcji. Nie czeka na odbiorcę. Mechanizm backpressure może wstrzymać przetwarzanie kolejnych zapisów, ale nie narzuca twardego limitu liczby wywołań enqueue() w jednej metodzie zwrotnej. Podłącz odbiorcę, zanim zaczniesz czekać na zakończenie zapisów.

Przykłady

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

Wynik

[[1,2],[3]]

Domyślnie `pipeThrough()` przekazuje normalne zamknięcie źródła na stronę zapisu transformacji, a `pipeTo()` odbiera wyniki na bieżąco. `transform()` przekazuje parę `[1,2]`, a `flush()` przekazuje pozostały element jako `[3]`.

Powiązane lekcje

  • JavaScript · Lekcja 4 · Zaawansowany · Wersja: 4

Źródła