Skip to content

compressionStream ​

compressionStream retorna um TransformStream<u8[], u8[]>: os bytes escritos no lado writable saem comprimidos pelo lado readable, no formato informado. Ela nunca guarda a entrada nem a saída inteiras, então um arquivo de qualquer tamanho é comprimido com memória constante, e um leitor lento segura o escritor em vez de deixar os dados se acumularem.

AssinaturacompressionStream(format: CompressFormat, options?: CompressOptions): TransformStream<u8[], u8[]>

Exemplo mínimo ​

tyrus
import { CompressFormat, compressionStream } from "tyrus:compress";
import { readFileStream, writeFileStream } from "tyrus:fs";
import { TransformStream } from "tyrus:stream";

async function compressLog(): Promise<void> {
    try {
        const gzip: TransformStream<u8[], u8[]> = compressionStream(CompressFormat.Gzip);
        const feeding = readFileStream("./app.log").pipeTo(gzip.writable);
        const draining = gzip.readable.pipeTo(writeFileStream("./app.log.gz"));
        await feeding;
        await draining;
        print("compressed"); // compressed
    } catch (error: Error) {
        printError(error.message);
    }
}

Todas as opções ​

tyrus
import { CompressFormat, CompressOptions, compressionStream } from "tyrus:compress";
import { TransformStream } from "tyrus:stream";

async function compressChunks(): Promise<void> {
    const brotli: TransformStream<u8[], u8[]> = compressionStream(CompressFormat.Brotli, {
        level: 9, // 0 to 11 for Brotli, 0 to 9 for the others; default 6
    });
    await brotli.writable.write([116, 121, 114, 117, 115]);
    await brotli.writable.close();
    const first: u8[]? = await brotli.readable.read();
    print((first ?? []).length > 0); // true
}

Erros ​

Uma falha chega aos dois lados como um CompressError: read() na saída e write() ou close() na entrada rejeitam com ele, e catch (error: CompressError) o recebe. Um level fora do intervalo do formato faz a stream falhar no primeiro uso com ERR_COMPRESS_INVALID_LEVEL; um literal é recusado na compilação (E3312).