Interface EntryGetDataOptions

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

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

Hierarchy (view full)

Properties

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

Methods

onend? onprogress? onstart?

Properties

OptionalcheckPasswordOnly

checkPasswordOnly?: boolean

true to check only if the password is valid.

Default Value

false

OptionalcheckSignature

checkSignature?: boolean

true to check the signature of the entry.

Default Value

false

OptionalpassThrough

passThrough?: boolean

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

Optionalpassword

password?: string

The password used to decrypt the content of the entry.

OptionalpreventClose

preventClose?: boolean

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

Default Value

false

OptionalrawPassword

rawPassword?: Uint8Array

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

Optionalsignal

signal?: AbortSignal

The AbortSignal instance used to cancel the decompression.

OptionaltransferStreams

transferStreams?: boolean

true to transfer streams to web workers when decompressing data.

Default Value

true

OptionaluseCompressionStream

useCompressionStream?: boolean

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

Default Value

true

OptionaluseWebWorkers

useWebWorkers?: boolean

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

Default Value

true

Methods

Optionalonend

  • onend(computedSize): Promise<void>

  • The function called when ending compression/decompression.

    Parameters

    • computedSize: number

      The total number of bytes (computed).

    Returns Promise<void>

    An empty promise or undefined.

Optionalonprogress

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

  • The function called during compression/decompression.

    Parameters

    • progress: number

      The current progress in bytes.

    • total: number

      The total number of bytes.

    Returns Promise<void>

    An empty promise or undefined.

Optionalonstart

  • onstart(total): Promise<void>

  • The function called when starting compression/decompression.

    Parameters

    • total: number

      The total number of bytes.

    Returns Promise<void>

    An empty promise or undefined.

Settings

Member Visibility

On This Page

Properties
Methods