Interface ZipReaderOptions

Represents options passed to the constructor of ZipReader and Entry#getData.

interface ZipReaderOptions {
    checkPasswordOnly?: boolean;
    checkSignature?: boolean;
    passThrough?: boolean;
    password?: string;
    preventClose?: boolean;
    rawPassword?: Uint8Array<ArrayBufferLike>;
    signal?: AbortSignal;
    transferStreams?: boolean;
}

Hierarchy (View Summary)

Properties

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

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

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

Settings

Member Visibility

On This Page

Properties