CKTIS / JavaScript
TransformStream : transform, flush et controller.enqueue
Traitez les blocs d’entrée avec `transform()`, émettez les résultats avec `controller.enqueue()` et videz votre tampon avec `flush()` à la fermeture normale.
Version : 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 associe un côté écriture (writable), qui reçoit les données, à un côté lecture (readable), qui fournit les résultats. Le constructeur accepte un objet transformer facultatif. Les deux arguments facultatifs suivants définissent les stratégies de mise en file d’attente, d’abord en écriture, puis en lecture. Cette API Web Streams ne fait pas partie d’ECMAScript 2024 : vérifiez sa prise en charge dans l’environnement cible.
transform(chunk, controller) est appelée pour chaque bloc d’entrée dès qu’il peut être traité. Pour émettre zéro, un ou plusieurs blocs, appelez controller.enqueue(chunk) autant de fois sur le TransformStreamDefaultController fourni. La valeur renvoyée par la fonction n’est pas une donnée de sortie. Sans transform(), les blocs passent sans modification.
La méthode facultative flush(controller) s’exécute à la fermeture normale du côté écriture, une fois tous les blocs traités avec succès. Elle peut émettre les données encore en mémoire tampon avant que l’API ferme le côté lecture ; ce n’est pas une fonction de nettoyage en cas d’annulation ou d’interruption. L’API attend la promesse renvoyée par l’une ou l’autre fonction. Une exception ou une promesse rejetée met le flux en erreur : rattachez donc le travail asynchrone à la promesse renvoyée.
enqueue() transmet un bloc au côté lecture, renvoie undefined et lève TypeError si ce côté n’accepte plus de blocs. Elle n’attend pas le consommateur. La contre-pression peut retarder le traitement des écritures suivantes, mais elle ne fixe pas de limite stricte au nombre d’appels à enqueue() dans une même fonction de rappel. Connectez un consommateur avant d’attendre la fin des écritures.
Exemples
(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));Résultat
[[1,2],[3]]
Par défaut, `pipeThrough()` propage la fermeture normale de la source au côté écriture de la transformation, tandis que `pipeTo()` consomme les résultats au fur et à mesure. `transform()` émet la paire `[1,2]`, puis `flush()` émet l’élément restant sous la forme `[3]`.
Leçons associées
- JavaScript · Leçon 4 · Avancé · Version : 4