Base de conocimientosCentro de exámenes
ESEspañol
Elegir idioma13

CKTIS / JavaScript

TransformStream: transform, flush y controller.enqueue

Procesa fragmentos de entrada con `transform()`, emite resultados con `controller.enqueue()` y vacía el búfer con `flush()` durante el cierre normal.

Versión: ECMAScript 2024 and the current web platform; runtime support varies

Sintaxis

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 conecta un lado de entrada (writable) con un lado de salida (readable). Pasa un objeto transformer opcional al constructor. Los dos argumentos opcionales siguientes definen las estrategias de cola para los lados de escritura y lectura, en ese orden. Es una API de Web Streams, no de ECMAScript 2024; comprueba su compatibilidad con el entorno de destino.

transform(chunk, controller) se ejecuta para cada fragmento de entrada cuando está listo para procesarse. Para emitir cero, uno o varios fragmentos de salida, llama a controller.enqueue(chunk) ese número de veces en el TransformStreamDefaultController recibido. El valor devuelto por la función no es un resultado de la transformación. Sin transform(), los fragmentos pasan sin cambios.

La función opcional flush(controller) se ejecuta al cerrar normalmente el lado de escritura, después de transformar correctamente todos los fragmentos de entrada. Puede emitir lo que quede en el búfer antes de que la API cierre el lado de lectura; no es una función de limpieza ante una cancelación o un aborto. La API espera la promesa que devuelva cualquiera de las dos funciones. Una excepción o una promesa rechazada pone el flujo en estado de error, así que vincula todo el trabajo asíncrono a la promesa que devuelvas.

enqueue() entrega un fragmento al lado de lectura, devuelve undefined y lanza TypeError si ese lado ya no acepta fragmentos. No espera a un consumidor. La contrapresión puede retrasar las escrituras posteriores, pero no impone un límite estricto de llamadas a enqueue() dentro de una misma función de devolución de llamada. Conecta un consumidor antes de esperar a que terminen las escrituras.

Ejemplos

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

Resultado

[[1,2],[3]]

De forma predeterminada, `pipeThrough()` propaga el cierre normal del origen al lado de escritura de la transformación, mientras `pipeTo()` consume la salida a medida que llega. `transform()` emite el par `[1,2]` y `flush()` emite el elemento restante como `[3]`.

Lecciones relacionadas

  • JavaScript · Lección 4 · Avanzado · Versión: 4

Fuentes