Skip to content

pack ​

pack crea un archivo a partir de un archivo o de un directorio. La extensión del destino, en minúsculas, decide el formato: .zip, .tar, .tar.gz o .tgz.

Las entradas se escriben en un orden estable con separadores /, y el archivo se escribe primero en un archivo temporal junto al destino y luego se renombra a su nombre final, así que una falla nunca deja un archivo truncado. Cuando el destino está dentro del directorio de origen, queda fuera del archivo.

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

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

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();
}
OpciónTipoPor defectoEfecto
leveli326Nivel de compresión de 0 (solo almacena) a 9 (salida más pequeña). No se acepta para .tar.
overwritebooleanfalseReemplaza un archivo de destino existente. Un directorio nunca se reemplaza.
excludestring[]ningunoPatrones glob, relativos al origen, de archivos y directorios a dejar fuera. ** abarca cualquier cantidad de directorios.
prefixstringningunoDirectorio que contiene todas las entradas, como release-1.0.0.
reproduciblebooleanfalseEscribe fechas fijas y permisos normalizados, para que la misma entrada produzca los mismos bytes.
timeoutMsu64600000 (10 minutos)Desiste con ERR_ARCHIVE_TIMEOUT cuando la creación tarda más, sin dejar un archivo parcial. 0 falla con ERR_ARCHIVE_INVALID_OPTION.

Los enlaces simbólicos y archivos especiales del origen se rechazan con ERR_ARCHIVE_UNSUPPORTED_ENTRY, que indica la ruta en entry, en lugar de omitirse en silencio.

Manejo de errores ​

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

Un destino literal con una extensión desconocida o en mayúsculas, y un level literal que el formato no acepta, los señala el compilador antes de que el programa se ejecute.