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

    Interface Configuration

    Represents the configuration passed to configure.

    interface Configuration {
        chunkSize?: number;
        CompressionStream?: typeof TransformStreamLike;
        CompressionStreamZlib?: typeof TransformStreamLike;
        DecompressionStream?: typeof TransformStreamLike;
        DecompressionStreamZlib?: typeof TransformStreamLike;
        maxWorkers?: number;
        terminateWorkerTimeout?: number;
        useCompressionStream?: boolean;
        useWebWorkers?: boolean;
        wasmURI?: string;
        workerURI?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    chunkSize? CompressionStream? CompressionStreamZlib? DecompressionStream? DecompressionStreamZlib? maxWorkers? terminateWorkerTimeout? useCompressionStream? useWebWorkers? wasmURI? workerURI?

    Properties

    chunkSize?: number

    The size of the chunks in bytes during data compression/decompression.

    65536
    CompressionStream?: typeof TransformStreamLike

    The stream implementation used to compress data when useCompressionStream is set to true.

    CodecStream

    CompressionStreamZlib?: typeof TransformStreamLike

    The stream implementation used to compress data when useCompressionStream is set to false.

    CodecStream

    DecompressionStream?: typeof TransformStreamLike

    The stream implementation used to decompress data when useCompressionStream is set to true.

    CodecStream

    DecompressionStreamZlib?: typeof TransformStreamLike

    The stream implementation used to decompress data when useCompressionStream is set to false.

    CodecStream

    maxWorkers?: number

    The maximum number of web workers used to compress/decompress data simultaneously.

    navigator.hardwareConcurrency

    terminateWorkerTimeout?: number

    The delay in milliseconds before idle web workers are automatically terminated. You can call terminateWorkers() to terminate idle workers.

    5000
    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
    wasmURI?: string

    The URI of the WebAssembly module used by default implementations to compress/decompress data. It is ignored if useCompressionStream is set to true and CompressionStream/DecompressionStream are supported by the environment.

    "./core/streams/zlib/zlib-streams.wasm"
    workerURI?: string

    The URI of the web worker.

    It allows using alternative deflate implementations or specifying a URL to the worker script if the CSP of the page blocks scripts imported from a Data URI.

    Here is an example:

    configure({
      workerURI: "./custom-deflate.js"
    });

    "./core/web-worker.js"

    Settings

    Member Visibility

    On This Page

    Properties