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

    Interface ZipReaderGetEntriesOptions

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

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

    Hierarchy (View Summary)

    Index

    Properties

    commentEncoding? filenameEncoding?

    Methods

    decodeText? onprogress?

    Properties

    commentEncoding?: string

    The encoding of the comment of the entry.

    filenameEncoding?: string

    The encoding of the filename of the entry.

    Methods

    • 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 Promise<void> | undefined

      An empty promise or undefined.

    Settings

    Member Visibility

    On This Page

    Properties
    Methods