Colibrio Reader Framework API - Cloud license
    Preparing search index...

    Interface IZipResourceProviderOptions

    Options for IZipResourceProvider

    interface IZipResourceProviderOptions {
        chunkCacheSize?: number;
        maxChunkSize?: number;
        preferredChunkSize?: number;
        transferBuffers?: boolean;
    }

    Properties

    chunkCacheSize?: number

    The size of the chunk cache in bytes. A value of less than or equal to 0 will disable caching of chunks.

    When streaming the Zip file over internet, it is recommended to increase this option to prevent downloading the same chunk twice.

    Defaults to 16 MB (16000000)

    16000000
    maxChunkSize?: number

    ZipResourceProvider tries to fit at least one file in a chunk. If a file is larger than "maxChunkSize" bytes, the file will be requested with multiple chunks.

    Defaults to 400kB

    400000
    preferredChunkSize?: number

    ZipResourceProvider reads the zip-archive in chunks. The chunks are aligned to match the one or more compressed files within the archive.

    The preferredChunkSize tells ZipResourceProvider how big each chunk should be in bytes. Note that the actual chunkSize value will be less or more than this value depending on how the files are laid out inside the archive.

    Defaults to 100kB

    100000
    transferBuffers?: boolean

    If true, ArrayBuffers returned by IRandomAccessDataSource will be "transferred" to the zip webworker which may increase performance. If false, ArrayBuffers will be copied to the webworker.

    Defaults to false.

    false
    Properties