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

    Interface ZipReaderConstructorOptions

    Represents the options passed to the constructor of ZipReader, and {@link ZipDirectory}#import*.

    interface ZipReaderConstructorOptions {
        checkPasswordOnly?: boolean;
        checkSignature?: boolean;
        commentEncoding?: string;
        extractAppendedData?: boolean;
        extractPrependedData?: boolean;
        filenameEncoding?: string;
        passThrough?: boolean;
        password?: string;
        preventClose?: boolean;
        rawPassword?: Uint8Array<ArrayBuffer>;
        signal?: AbortSignal;
        transferStreams?: boolean;
        useCompressionStream?: boolean;
        useWebWorkers?: boolean;
        decodeText(value: Uint8Array<ArrayBuffer>, encoding: string): string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    checkPasswordOnly? checkSignature? commentEncoding? extractAppendedData? extractPrependedData? filenameEncoding? passThrough? password? preventClose? rawPassword? signal? transferStreams? useCompressionStream? useWebWorkers?

    Methods

    decodeText?

    Properties

    checkPasswordOnly?: boolean

    true to check only if the password is valid.

    false
    checkSignature?: boolean

    true to check the signature of the entry.

    false
    commentEncoding?: string

    The encoding of the comment of the entry.

    extractAppendedData?: boolean

    true to extract the appended data into ZipReader#appendedData.

    false
    extractPrependedData?: boolean

    true to extract the prepended data into ZipReader#prependedData.

    false
    filenameEncoding?: string

    The encoding of the filename of the entry.

    passThrough?: boolean

    true to read the data as-is without decompressing it and without decrypting it.

    password?: string

    The password used to decrypt the content of the entry.

    preventClose?: boolean

    true to prevent closing of Writer#writable when calling Entry#getData.

    false
    rawPassword?: Uint8Array<ArrayBuffer>

    The password used to encrypt the content of the entry (raw).

    signal?: AbortSignal

    The AbortSignal instance used to cancel the decompression.

    transferStreams?: boolean

    true to transfer streams to web workers when decompressing data.

    true
    useCompressionStream?: boolean

    true to use the native API CompressionStream/DecompressionStream to compress/decompress data.

    true
    useWebWorkers?: boolean

    true to use web workers to compress/decompress data in non-blocking background processes.

    true

    Methods

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

      Parameters

      • value: Uint8Array<ArrayBuffer>

        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