TransformStream

A interface TransformStream faz parte da Streams API do Azion Runtime. Ela é uma implementação concreta do conceito de transform stream de uma pipe chain: você a passa para o método pipeThrough() de um ReadableStream para converter um stream de dados de um formato para outro. Use-a para decodificar ou codificar frames de vídeo, descompactar dados ou converter um stream de XML para JSON. TransformStream é um objeto transferível. Para mais informações, consulte TransformStream na MDN Web Docs.

Construtor

O construtor TransformStream() cria e retorna um objeto transform stream:

new TransformStream()

O construtor aceita um objeto de transformação opcional e estratégias de enfileiramento opcionais para os streams dele. Sem um objeto de transformação, os dados passam pelo stream sem alteração.

O objeto de transformação carrega o algoritmo de transformação. O método transform(chunk, controller) dele recebe cada chunk escrito no stream, e controller.enqueue() passa um chunk para o lado readable. Um objeto de transformação também pode definir os métodos start() e flush(), como mostra a seção Exemplo.

Como estratégia de enfileiramento, o Azion Runtime define CountQueuingStrategy, mas não ByteLengthQueuingStrategy: uma referência a ByteLengthQueuingStrategy lança ReferenceError: ByteLengthQueuingStrategy is not defined.

Propriedades

Um transform stream tem dois lados. Juntos, eles formam o par que pipeThrough() aceita:

Propriedade	Tipo	Descrição
`readable`	`ReadableStream`	O lado readable do transform stream. Ele retorna os chunks transformados.
`writable`	`WritableStream`	O lado writable do transform stream. Ele recebe os chunks a transformar.

Exemplo

Este handler define AnyToU8Stream, um transform stream que repassa cada chunk que recebe como um Uint8Array. Ele canaliza uma string, um array de números e um Uint16Array pelo stream e depois retorna os bytes de cada chunk de saída:

JavaScript

01export default {

02 async fetch(request, env, ctx) {

03 const transformContent = {

04 start() {}, // required.

05 async transform(chunk, controller) {

06 chunk = await chunk;

07 switch (typeof chunk) {

08 case 'object':

09 // just say the stream is done

10 if (chunk === null) {

11 controller.terminate();

12 } else if (ArrayBuffer.isView(chunk)) {

13 controller.enqueue(new Uint8Array(chunk.buffer, chunk.byteOffset, chunk.byteLength));

14 } else if (

15 Array.isArray(chunk) &&

16 chunk.every((value) => typeof value === 'number')

17 ) {

18 controller.enqueue(new Uint8Array(chunk));

19 } else if (

20 typeof chunk.valueOf === 'function' &&

21 chunk.valueOf() !== chunk

22 ) {

23 this.transform(chunk.valueOf(), controller); // hack

24 } else if ('toJSON' in chunk) {

25 this.transform(JSON.stringify(chunk), controller);

26 }

27 break;

28 case 'symbol':

29 controller.error("Cannot send a symbol as a chunk part")

30 break

31 case 'undefined':

32 controller.error("Cannot send undefined as a chunk part")

33 break

34 default:

35 controller.enqueue(this.textencoder.encode(String(chunk)))

36 break

37 }

38 },

39 flush() { /* do any destructor work here */ }

40 }

42 class AnyToU8Stream extends TransformStream {

43 constructor() {

44 super({...transformContent, textencoder: new TextEncoder()})

45 }

46 }

48 const stream = new ReadableStream({

49 start(c) {

50 c.enqueue('hi');

51 c.enqueue([1, 2]);

52 c.enqueue(new Uint16Array([65]));

53 c.close();

54 },

55 }).pipeThrough(new AnyToU8Stream());

57 const chunks = [];

58 for await (const chunk of stream) chunks.push(Array.from(chunk));

59 return Response.json(chunks);

60 },

61};

A function retorna estes bytes para os três chunks de saída. A string 'hi' se torna os bytes codificados dela, o array de números se torna um Uint8Array com os mesmos valores e o Uint16Array sai como os dois bytes do buffer dele:

JSON

01[

02 [

03 104,

04 105

05 ],

06 [

07 1,

08 2

09 ],

10 [

11 65,