@zip.js/zip.js
    Preparing search index...

    Interface ZipReaderGetEntriesOptions

    Represents the options passed to ZipReader#getEntries and ZipReader#getEntriesGenerator.

    interface ZipReaderGetEntriesOptions {
        checkAmbiguity?: boolean;
        commentEncoding?: string;
        filenameEncoding?: string;
        decodeText?(value: Uint8Array, encoding: string): string | undefined;
        onprogress?(
            progress: number,
            total: number,
            entry: EntryMetaData,
        ): void | Promise<void>;
    }

    Hierarchy (View Summary)

    Index
    checkAmbiguity? commentEncoding? filenameEncoding?
    decodeText? onprogress?
    checkAmbiguity?: boolean

    true to throw an ERR_AMBIGUOUS_ARCHIVE error when the archive could be parsed differently by other tools. This detects data before or after the zip structure (e.g. a self-extracting archive stub or a concatenated archive), central directory records not accounted for by the end of central directory record, an end of central directory record disagreeing with its zip64 counterpart, and duplicate filenames. When reading the content of an entry, it also validates the local file header against the central directory record (see ZipReaderOptions#checkAmbiguity).

    false
    commentEncoding?: string

    The encoding of the comment of the entry.

    filenameEncoding?: string

    The encoding of the filename of the entry.

    • The function called for decoding the filename and the comment of the entry.

      Parameters

      • value: Uint8Array

        The raw text value.

      • encoding: string

        The encoding of the text.

      Returns string | undefined

      The decoded text value or undefined if the raw text value should be decoded by zip.js.

    • The function called each time an entry is read/written.

      Parameters

      • progress: number

        The entry index.

      • total: number

        The total number of entries.

      • entry: EntryMetaData

        The entry being read/written.

      Returns void | Promise<void>

      An empty promise or undefined.

    Settings
    Member Visibility

    On This Page
    Properties
    Methods