Skip to content

unpackStream ​

unpackStream extrai um arquivo TAR ou TAR.GZ de uma ReadableStream<u8[]> para um diretório enquanto os bytes chegam, com a mesma segurança de unpack: as entradas ficam dentro do destino, links e arquivos especiais são recusados, os limites valem e, numa falha, tudo o que a chamada criou é removido. O formato é identificado pelos primeiros bytes.

Um arquivo ZIP não pode ser extraído de uma stream: sua tabela de entradas fica no fim, e as entradas antes dela não são confiáveis até ela ser lida. Uma stream assim falha com ERR_ARCHIVE_ZIP_NOT_STREAMABLE; grave-a num arquivo e use unpack.

AssinaturaunpackStream(archive: ReadableStream<u8[]>, destination: string, options?: UnpackOptions): Promise<Result<ArchiveSummary, ArchiveError>>

Exemplo mínimo ​

tyrus
import { ArchiveError, ArchiveSummary, unpackStream } from "tyrus:archive";
import { FsError, readFileStream } from "tyrus:fs";
import { ReadableStream } from "tyrus:stream";

async function restore(): Promise<void> {
    try {
        const input: ReadableStream<u8[]> = readFileStream("./site.tgz");
        const summary = await unpackStream(input, "./restored") onfail {
            printError(summary.code);
            return;
        };
        print(summary.entries); // 3
    } catch (error: FsError) {
        printError(error.code);
    }
}

Todas as opções ​

tyrus
import { ArchiveError, ArchiveSummary, UnpackOptions, unpackStream } from "tyrus:archive";
import { ReadableStream } from "tyrus:stream";

async function extract(upload: ReadableStream<u8[]>): Promise<Result<void, ArchiveError>> {
    const summary: ArchiveSummary = await unpackStream(upload, "./workspace", {
        overwrite: true, // replace files that already exist; default false
        stripComponents: 1, // drop this many leading path components; default 0
        maxEntries: 1_000, // refuse archives with more entries; default 100000
        maxBytes: 50_000_000, // refuse more extracted bytes; default 4 GiB
        maxRatio: 100, // refuse a TAR.GZ expanding past this ratio; default 200
        timeoutMs: 30_000, // give up after this many milliseconds; default 600000 (10 minutes)
    })?;
    print(summary.entries); // 3
    return Ok();
}

A stream é emprestada: a chamada a lê até o fim do arquivo, e o programa mantém seu handle. Uma stream que falha durante a leitura resolve com ERR_ARCHIVE_IO, e uma em que ninguém escreve falha em timeoutMs.