Skip to content

unpackStream ​

unpackStream extrae un archivo TAR o TAR.GZ de un ReadableStream<u8[]> a un directorio mientras llegan los bytes, con la misma seguridad que unpack: las entradas quedan dentro del destino, los enlaces y ficheros especiales se rechazan, los límites se aplican y, ante un fallo, todo lo que creó la llamada se elimina. El formato se identifica por los primeros bytes.

Un archivo ZIP no se puede extraer de un stream: su tabla de entradas está al final, y las entradas anteriores no son confiables hasta leerla. Un stream así falla con ERR_ARCHIVE_ZIP_NOT_STREAMABLE; escríbelo en un fichero y usa unpack.

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

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

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

El stream se toma prestado: la llamada lo lee hasta el final del archivo, y el programa conserva su handle. Un stream que falla durante la lectura se resuelve con ERR_ARCHIVE_IO, y uno en el que nadie escribe falla en timeoutMs.