Interface GetEntriesOptions

Represents options passed to the constructor of ZipReader, ZipReader#getEntries and ZipReader#getEntriesGenerator.

interface GetEntriesOptions {
    commentEncoding?: string;
    filenameEncoding?: string;
    decodeText(value: Uint8Array<ArrayBufferLike>, encoding: string): string;
}

Hierarchy (View Summary)

Properties

commentEncoding? filenameEncoding?

Methods

decodeText?

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<ArrayBufferLike>, encoding: string): string

  • Decodes the filename and the comment of the entry.

    Parameters

    • value: Uint8Array<ArrayBufferLike>

      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.

Settings

Member Visibility

On This Page

Properties
Methods