Skip to content

pack ​

pack cria um arquivo a partir de um arquivo ou de um diretório. A extensão do destino, em minúsculas, decide o formato: .zip, .tar, .tar.gz ou .tgz.

As entradas são gravadas em ordem estável com separadores /, e o arquivo é gravado primeiro num arquivo temporário ao lado do destino e depois renomeado para o nome final, então uma falha nunca deixa um arquivo truncado. Quando o destino fica dentro do diretório de origem, ele fica de fora do arquivo.

Assinaturapack(source: string, destination: string, options?: PackOptions): Promise<Result<ArchiveSummary, ArchiveError>>

Exemplo mínimo ​

tyrus
import { ArchiveError, ArchiveSummary, pack } from "tyrus:archive";

async function packRelease(): Promise<Result<ArchiveSummary, ArchiveError>> {
    return await pack("./release", "./release.tar.gz");
}

Todas as opções ​

tyrus
import { ArchiveError, ArchiveSummary, PackOptions, pack } from "tyrus:archive";

async function packRelease(): Promise<Result<void, ArchiveError>> {
    const summary: ArchiveSummary = await pack("./release", "./release-1.0.0.tar.gz", {
        level: 9, // 0 (store only) to 9 (smallest output); default 6
        overwrite: true, // replace an existing file; default false
        exclude: ["**/*.map", "tmp"], // globs relative to the source; default none
        prefix: "release-1.0.0", // directory that holds every entry; default none
        reproducible: true, // zero timestamps and normalize permissions; default false
        timeoutMs: 120_000, // give up after this many milliseconds; default 600000 (10 minutes)
    })?;
    print(summary.entries); // 42
    print(summary.bytes); // 1048576
    return Ok();
}
OpçãoTipoPadrãoEfeito
leveli326Nível de compressão de 0 (só armazena) a 9 (menor saída). Não é aceito para .tar.
overwritebooleanfalseSubstitui um arquivo de destino existente. Um diretório nunca é substituído.
excludestring[]nenhumPadrões glob, relativos à origem, de arquivos e diretórios a deixar de fora. ** abrange qualquer quantidade de diretórios.
prefixstringnenhumDiretório que contém todas as entradas, como release-1.0.0.
reproduciblebooleanfalseGrava datas fixas e permissões normalizadas, para que a mesma entrada produza os mesmos bytes.
timeoutMsu64600000 (10 minutos)Desiste com ERR_ARCHIVE_TIMEOUT quando a criação demora mais, sem deixar arquivo parcial. 0 falha com ERR_ARCHIVE_INVALID_OPTION.

Links simbólicos e arquivos especiais na origem são recusados com ERR_ARCHIVE_UNSUPPORTED_ENTRY, que informa o caminho em entry, em vez de serem ignorados em silêncio.

Tratamento de erro ​

error

tyrus
import { ArchiveError, ArchiveSummary, pack } from "tyrus:archive";

async function packTwice(): Promise<void> {
    const first = await pack("./release", "./release.zip");
    match (await pack("./release", "./release.zip")) {
        Ok(summary) => { print(summary.entries); }
        Err(error) => { printError(error.code); } // ERR_ARCHIVE_DESTINATION_EXISTS
    }
}

Um destino literal com extensão desconhecida ou em maiúsculas, e um level literal que o formato não aceita, são apontados pelo compilador antes de o programa rodar.