Interface GenerateOptions

The options for the EPUB generator.

interface GenerateOptions {
    checkPasswordOnly?: boolean;
    checkSignature?: boolean;
    commentEncoding?: string;
    extractAppendedData?: boolean;
    extractPrependedData?: boolean;
    filenameEncoding?: string;
    log?: Log;
    passThrough?: boolean;
    password?: string;
    preventClose?: boolean;
    rawPassword?: Uint8Array;
    signal?: AbortSignal;
    transferStreams?: boolean;
    useCompressionStream?: boolean;
    useWebWorkers?: boolean;
    decodeText?(value: Uint8Array, encoding: string): undefined | string;
}

Hierarchy

  • Omit<ZipReaderConstructorOptions, "keepOrder" | "level">
    • GenerateOptions

Properties

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

Methods

decodeText?

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

OptionalcommentEncoding

commentEncoding?: string

The encoding of the comment of the entry.

OptionalextractAppendedData

extractAppendedData?: boolean

true to extract the appended data into ZipReader#appendedData.

Default Value

false

OptionalextractPrependedData

extractPrependedData?: boolean

true to extract the prepended data into ZipReader#prependedData.

Default Value

false

OptionalfilenameEncoding

filenameEncoding?: string

The encoding of the filename of the entry.

Optionallog

log?: Log

The logger for logging messages.

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

OptionaldecodeText

  • decodeText(value, encoding): undefined | string

  • Decodes the filename and the comment of the entry.

    Parameters

    • value: Uint8Array

      The raw text value.

    • encoding: string

      The encoding of the text.

    Returns undefined | 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