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

    Interface EntryGetDataCheckPasswordOptions

    Represents the options passed to FileEntry#getData and {@link ZipFileEntry}.get*.

    interface EntryGetDataCheckPasswordOptions {
        checkOverlappingEntry?: boolean;
        checkOverlappingEntryOnly?: boolean;
        checkPasswordOnly?: boolean;
        checkSignature?: boolean;
        passThrough?: boolean;
        password?: string;
        preventClose?: boolean;
        rawPassword?: Uint8Array<ArrayBufferLike>;
        signal?: AbortSignal;
        transferStreams?: boolean;
        useCompressionStream?: boolean;
        useWebWorkers?: boolean;
        onend?(computedSize: number): Promise<void> | undefined;
        onprogress?(progress: number, total: number): Promise<void> | undefined;
        onstart?(total: number): Promise<void> | undefined;
    }

    Hierarchy (View Summary)

    Index

    Properties

    checkOverlappingEntry? checkOverlappingEntryOnly? checkPasswordOnly? checkSignature? passThrough? password? preventClose? rawPassword? signal? transferStreams? useCompressionStream? useWebWorkers?

    Methods

    onend? onprogress? onstart?

    Properties

    checkOverlappingEntry?: boolean

    true to throw an ERR_OVERLAPPING_ENTRY error when calling FileEntry#getData if the entry overlaps with another entry on which FileEntry#getData has already been called (with the option checkOverlappingEntry or checkOverlappingEntryOnly set to true).

    false
    checkOverlappingEntryOnly?: boolean

    true to throw an ERR_OVERLAPPING_ENTRY error when calling FileEntry#getData if the entry overlaps with another entry on which FileEntry#getData has already been called (with the option checkOverlappingEntry or checkOverlappingEntryOnly set to true) without trying to read the content of the entry.

    false
    checkPasswordOnly?: boolean

    true to check only if the password is valid.

    false
    checkSignature?: boolean

    true to check the signature of the entry.

    false
    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 FileEntry#getData.

    false
    rawPassword?: Uint8Array<ArrayBufferLike>

    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 when ending compression/decompression.

      Parameters

      • computedSize: number

        The total number of bytes (computed).

      Returns Promise<void> | undefined

      An empty promise or undefined.

    • The function called during compression/decompression.

      Parameters

      • progress: number

        The current progress in bytes.

      • total: number

        The total number of bytes.

      Returns Promise<void> | undefined

      An empty promise or undefined.

    • The function called when starting compression/decompression.

      Parameters

      • total: number

        The total number of bytes.

      Returns Promise<void> | undefined

      An empty promise or undefined.

    Settings

    Member Visibility

    On This Page

    Properties
    Methods