Interface ZipReaderGetEntriesOptions

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

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

Hierarchy (View Summary)

Properties

commentEncoding? filenameEncoding?

Methods

decodeText? onprogress?

Properties

OptionalcommentEncoding

commentEncoding?: string

The encoding of the comment of the entry.

OptionalfilenameEncoding

filenameEncoding?: string

The encoding of the filename of the entry.

Methods

OptionaldecodeText

  • decodeText(value: Uint8Array, encoding: string): string

  • 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

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

Optionalonprogress

  • onprogress(progress: number, total: number, entry: EntryMetaData): Promise<void>

  • 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>

    An empty promise or undefined.

Settings

Member Visibility

On This Page

Properties
Methods