Skip to content

decompressionStream ​

decompressionStream devuelve un TransformStream<u8[], u8[]> que restaura datos Gzip, zlib, Deflate crudo o Brotli a medida que llegan. Sin format, identifica Gzip y Deflate por los primeros bytes; Brotli y Deflate crudo necesitan format.

La salida sale en trozos de como máximo 64 KiB, y cada uno espera espacio en la salida antes de que se produzca el siguiente, así que la memoria se mantiene constante incluso cuando una entrada pequeña se expande enormemente. Los límites se aplican al stream completo: superados maxOutputBytes o maxRatio, el stream falla en lugar de producir más.

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

Ejemplo 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 las opciones ​

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);
    }
}

Errores ​

Un fallo llega a ambos lados como un CompressError, con los mismos códigos que decompress: los datos que terminan antes de tiempo o tienen bytes después del final son ERR_COMPRESS_INVALID_DATA, y los límites son ERR_COMPRESS_OUTPUT_LIMIT y ERR_COMPRESS_RATIO_LIMIT. El maxOutputBytes por defecto de un stream es 4 GiB, ya que un stream nunca guarda su salida.