Skip to content

packStream ​

packStream retorna uma ReadableStream<u8[]> com o arquivo de um arquivo ou diretório à medida que ele é escrito, no formato informado: nada é gravado em disco, então o arquivo pode ir direto para uma resposta HTTP, uma stream de compressão ou um arquivo. A stream guarda no máximo 64 KiB, e o arquivo só é produzido na velocidade em que é lido.

O ZIP é escrito com data descriptors depois de cada entrada, já que uma stream não pode voltar para preencher tamanhos; toda ferramenta atual o lê.

AssinaturapackStream(source: string, format: ArchiveFormat, options?: PackOptions): ReadableStream<u8[]>

Exemplo mínimo ​

tyrus
import { ArchiveError, ArchiveFormat, packStream } from "tyrus:archive";
import { FsError, writeFileStream } from "tyrus:fs";
import { ReadableStream, WritableStream } from "tyrus:stream";

async function backup(): Promise<void> {
    try {
        const archive: ReadableStream<u8[]> = packStream("./site", ArchiveFormat.TarGz);
        const file: WritableStream<u8[]> = writeFileStream("./site.tgz");
        await archive.pipeTo(file);
        print("packed"); // packed
    } catch (error: ArchiveError | FsError) {
        printError(error.code);
    }
}

Todas as opções ​

tyrus
import { ArchiveError, ArchiveFormat, PackOptions, packStream } from "tyrus:archive";
import { ReadableStream } from "tyrus:stream";

async function firstChunk(): Promise<void> {
    const archive: ReadableStream<u8[]> = packStream("./site", ArchiveFormat.Zip, {
        level: 9, // 0 (store only) to 9 (smallest output); default 6; not allowed for Tar
        exclude: ["**/*.map"], // glob patterns relative to the source to leave out; default none
        prefix: "site-1.0.0", // directory every entry is placed under; default none
        reproducible: true, // fixed timestamps and normalized permissions; default false
        timeoutMs: 60_000, // fail the stream after this many milliseconds; default 600000 (10 minutes)
    });
    try {
        const first: u8[]? = await archive.read();
        print((first ?? []).length > 0); // true
    } catch (error: ArchiveError) {
        printError(error.code);
    }
}

overwrite não tem efeito, já que não há destino. Uma falha, de uma origem inexistente ao limite de tempo, faz a stream falhar com o ArchiveError em vez de terminá-la, então um leitor nunca confunde um arquivo truncado com um completo: read() e pipeTo() rejeitam, e catch (error: ArchiveError) o recebe.