Skip to content

TransformStream ​

TransformStream<TInput, TOutput> exposes a writable input and readable output with independent payload types. It carries no implicit codec or transform function. The native transforms that do have one, such as compressionStream and decompressionStream, return a TransformStream<u8[], u8[]> whose output is the transformed input.

SignatureTransformStream<TInput, TOutput>

Members ​

MemberSignaturePurpose
writableWritableStream<TInput>Sends input values.
readableReadableStream<TOutput>Receives output values.
close() => Promise<void>Closes both sides together.

Usage ​

tyrus
async function transform(stream: TransformStream<string, u8[]>): Promise<u8[]?> {
    await stream.writable.write("payload");
    return await stream.readable.read();
}

error

tyrus
async function invalid(stream: TransformStream<string, u8[]>): Promise<void> {
await stream.writable.write([1, 2, 3]); 
}

Errors ​

close() rejects with StreamError if either side fails. The type parameters prevent writing output values to the input side or reading input values from the output side.