Skip to content

decompressionStream ​

decompressionStream retorna um TransformStream<u8[], u8[]> que restaura dados Gzip, zlib, Deflate cru ou Brotli à medida que chegam. Sem format, identifica Gzip e Deflate pelos primeiros bytes; Brotli e Deflate cru precisam de format.

A saída sai em pedaços de no máximo 64 KiB, e cada um espera espaço na saída antes que o próximo seja produzido, então a memória fica constante mesmo quando uma entrada pequena se expande enormemente. Os limites valem para a stream inteira: passado maxOutputBytes ou maxRatio, a stream falha em vez de produzir mais.

AssinaturadecompressionStream(options?: DecompressOptions): TransformStream<u8[], u8[]>

Exemplo mínimo ​

tyrus
import { CompressError, decompressionStream } from "tyrus:compress";
import { FsError, readFileStream, writeFileStream } from "tyrus:fs";
import { TransformStream } from "tyrus:stream";

async function restoreLog(): Promise<void> {
    try {
        const gunzip: TransformStream<u8[], u8[]> = decompressionStream();
        const feeding = readFileStream("./app.log.gz").pipeTo(gunzip.writable);
        const draining = gunzip.readable.pipeTo(writeFileStream("./restored.log"));
        await feeding;
        await draining;
        print("restored"); // restored
    } catch (error: FsError | CompressError) {
        printError(error.code);
    }
}

Todas as opções ​

tyrus
import { CompressError, CompressFormat, DecompressOptions, decompressionStream } from "tyrus:compress";
import { ReadableStream, TransformStream } from "tyrus:stream";

async function restore(source: ReadableStream<u8[]>): Promise<void> {
    const brotli: TransformStream<u8[], u8[]> = decompressionStream({
        format: CompressFormat.Brotli, // required for Brotli and DeflateRaw; default detected from the data
        maxOutputBytes: 1_000_000_000, // fail the stream past this much output; default 4 GiB
        maxRatio: 1_000, // fail the stream past this expansion once past 1 MiB; default 200
    });
    try {
        await source.pipeTo(brotli.writable);
        const first: u8[]? = await brotli.readable.read();
        print((first ?? []).length); // 5
    } catch (error: CompressError) {
        printError(error.code);
    }
}

Erros ​

Uma falha chega aos dois lados como um CompressError, com os mesmos códigos de decompress: dados que terminam antes da hora ou têm bytes depois do fim são ERR_COMPRESS_INVALID_DATA, e os limites são ERR_COMPRESS_OUTPUT_LIMIT e ERR_COMPRESS_RATIO_LIMIT. O maxOutputBytes padrão de uma stream é 4 GiB, já que uma stream nunca guarda sua saída.