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

    Interface WorkerConfiguration

    Represents configuration passed to configure, the constructor of ZipReader, FileEntry#getData, the constructor of ZipWriter, and ZipWriter#add.

    The three options below are read as truthy values, they are not converted. Any non-empty string is therefore true, "false" and "0" included. This is deliberate, so that an expression such as useWebWorkers: supported && enabled keeps working, but it differs from the numeric options, which do accept the string a form control, a query string or an environment variable yields. A boolean read from one of those must be converted by the caller.

    interface WorkerConfiguration {
        transferStreams?: boolean;
        useCompressionStream?: boolean;
        useWebWorkers?: boolean;
    }

    Hierarchy (View Summary)

    Index
    transferStreams? useCompressionStream? useWebWorkers?
    transferStreams?: boolean

    true to transfer stream ownership to web workers.

    true
    useCompressionStream?: boolean

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

    When compressing, the native API is only used when level is undefined or equal to 6, see ZipWriterConstructorOptions#level.

    true
    useWebWorkers?: boolean

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

    true

    Settings
    Member Visibility

    On This Page
    Properties