Skip to content

Tipos de tyrus:archive ​

Los tipos deben importarse por nombre

ArchiveEntry, ArchiveEntryKind, ArchiveError, ArchiveFormat, ArchiveSummary, PackOptions y UnpackOptions deben importarse explícitamente siempre que se usen sus campos, miembros o literales de objeto.

ArchiveSummary ​

ArchiveSummary lo devuelven pack y unpack.

CampoTipoDescripción
entriesu64Archivos y directorios escritos.
bytesu64Bytes de archivo sin comprimir escritos.

ArchiveEntry ​

ArchiveEntry lo devuelve list.

CampoTipoDescripción
namestringEl nombre de la entrada exactamente como el archivo lo guarda. Los nombres de directorio terminan en / en archivos ZIP.
kindArchiveEntryKindQué es la entrada.
sizeu64Tamaño sin comprimir en bytes.
compressedSizeu64?Tamaño comprimido en bytes para entradas ZIP; ausente para entradas TAR.

ArchiveEntryKind ​

MiembroSignificado
FileUn archivo regular.
DirectoryUn directorio.
SymlinkUn enlace simbólico. unpack lo rechaza.
HardLinkUn enlace duro. unpack lo rechaza.
OtherUn dispositivo, pipe u otra entrada especial. unpack la rechaza.
tyrus
import { ArchiveEntry, ArchiveEntryKind, ArchiveError, list } from "tyrus:archive";

async function hasLinks(): Promise<Result<boolean, ArchiveError>> {
    const entries: ArchiveEntry[] = await list("./upload.tar")?;
    return Ok(entries.some((entry: ArchiveEntry): boolean => entry.kind === ArchiveEntryKind.Symlink));
}

ArchiveFormat ​

El formato que escribe packStream, ya que un stream no tiene extensión que lo decida.

MiembroFormato
ZipZIP, con data descriptors.
TarTAR, sin compresión.
TarGzTAR comprimido con Gzip.

PackOptions ​

CampoTipoPor defecto
leveli32?6
overwriteboolean?false
excludestring[]?ninguno
prefixstring?ninguno
reproducibleboolean?false
timeoutMsu64?600000

Consulte en pack qué hace cada opción.

UnpackOptions ​

CampoTipoPor defecto
overwriteboolean?false
stripComponentsu32?0
maxEntriesu64?100000
maxBytesu64?4 GiB
maxRatiou32?200
timeoutMsu64?600000

Consulte en unpack qué hace cada opción.

ArchiveError ​

ArchiveError es el error recuperable de toda operación de archivo, entregado como el Err del Result con que resuelve cada función.

CampoTipoDescripción
codestringIdentificador estable, como ERR_ARCHIVE_PATH_ESCAPE. Consulte los códigos de error.
messagestringDescripción legible.
entrystring?La entrada del archivo o la ruta de origen que causó la falla, cuando la hay, truncada a 4 KiB.
tyrus
import { ArchiveError, ArchiveSummary, unpack } from "tyrus:archive";

async function extract(): Promise<void> {
    const result: Result<ArchiveSummary, ArchiveError> = await unpack("./upload.zip", "./out");
    match (result) {
        Ok(summary) => { print(summary.entries); }
        Err(error) => {
            printError(error.code); // ERR_ARCHIVE_UNSAFE_LINK
            printError(error.entry ?? ""); // docs/latest
        }
    }
}