Skip to content

Tipos do tyrus:archive ​

Tipos precisam ser importados pelo nome

ArchiveEntry, ArchiveEntryKind, ArchiveError, ArchiveFormat, ArchiveSummary, PackOptions e UnpackOptions precisam ser importados explicitamente sempre que seus campos, membros ou literais de objeto forem usados.

ArchiveSummary ​

ArchiveSummary é retornado por pack e unpack.

CampoTipoDescrição
entriesu64Arquivos e diretórios gravados.
bytesu64Bytes de arquivo descomprimidos gravados.

ArchiveEntry ​

ArchiveEntry é retornado por list.

CampoTipoDescrição
namestringO nome da entrada exatamente como o arquivo o guarda. Nomes de diretório terminam com / em arquivos ZIP.
kindArchiveEntryKindO que a entrada é.
sizeu64Tamanho descomprimido em bytes.
compressedSizeu64?Tamanho comprimido em bytes para entradas ZIP; ausente para entradas TAR.

ArchiveEntryKind ​

MembroSignificado
FileUm arquivo regular.
DirectoryUm diretório.
SymlinkUm link simbólico. O unpack o recusa.
HardLinkUm link físico. O unpack o recusa.
OtherUm dispositivo, pipe ou outra entrada especial. O unpack a recusa.
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 ​

O formato que packStream escreve, já que uma stream não tem extensão para decidi-lo.

MembroFormato
ZipZIP, com data descriptors.
TarTAR, sem compressão.
TarGzTAR comprimido com Gzip.

PackOptions ​

CampoTipoPadrão
leveli32?6
overwriteboolean?false
excludestring[]?nenhum
prefixstring?nenhum
reproducibleboolean?false
timeoutMsu64?600000

Veja em pack o que cada opção faz.

UnpackOptions ​

CampoTipoPadrão
overwriteboolean?false
stripComponentsu32?0
maxEntriesu64?100000
maxBytesu64?4 GiB
maxRatiou32?200
timeoutMsu64?600000

Veja em unpack o que cada opção faz.

ArchiveError ​

ArchiveError é o erro recuperável de toda operação de arquivo, entregue como o Err do Result com que cada função resolve.

CampoTipoDescrição
codestringIdentificador estável, como ERR_ARCHIVE_PATH_ESCAPE. Veja os códigos de erro.
messagestringDescrição legível.
entrystring?A entrada do arquivo ou o caminho de origem que causou a falha, quando houver, truncado em 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
        }
    }
}