Skip to content

list ​

list lê as entradas de um arquivo ZIP, TAR ou TAR.GZ sem gravar nada em disco. O formato é identificado pelo conteúdo, nunca pelo nome do arquivo.

Use-o para inspecionar um arquivo não confiável antes de extraí-lo: entradas que o unpack recusaria, como links, aparecem com seu tipo, e os nomes são informados exatamente como o arquivo os guarda.

Assinaturalist(archive: string, options?: UnpackOptions): Promise<Result<ArchiveEntry[], ArchiveError>>

Exemplo mínimo ​

tyrus
import { ArchiveEntry, ArchiveError, list } from "tyrus:archive";

async function inspect(): Promise<Result<void, ArchiveError>> {
    const entries: ArchiveEntry[] = await list("./upload.zip")?;
    print(entries.length); // 3
    print(entries[0].name); // report.pdf
    return Ok();
}

Todas as opções ​

tyrus
import { ArchiveEntry, ArchiveEntryKind, ArchiveError, UnpackOptions, list } from "tyrus:archive";

async function inspect(): Promise<Result<void, ArchiveError>> {
    const entries: ArchiveEntry[] = await list("./upload.zip", {
        maxEntries: 1_000, // reject archives with more entries; default 100000
        timeoutMs: 30_000, // give up after this many milliseconds; default 600000 (10 minutes)
    })?;
    const first: ArchiveEntry = entries[0];
    print(first.name); // report.pdf
    print(first.kind === ArchiveEntryKind.File); // true
    print(first.size); // 20480
    print(first.compressedSize ?? 0); // 18311
    return Ok();
}

list lê apenas maxEntries e timeoutMs de UnpackOptions; as demais opções se aplicam à extração. Um arquivo com mais entradas falha com ERR_ARCHIVE_ENTRY_LIMIT, e um arquivo ZIP falha antes de sua tabela de entradas ser lida.