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

    Interface CodecDefinition

    Represents a codec definition passed to registerCodec.

    interface CodecDefinition {
        codecURI?: string;
        compressionMethod: number;
        CompressionStream?: typeof CompressionStreamLike;
        DecompressionStream?: typeof DecompressionStreamLike;
        format: string;
        versionNeeded?: number;
    }
    Index
    codecURI? compressionMethod CompressionStream? DecompressionStream? format versionNeeded?
    codecURI?: string

    The URL of a module exporting the CompressionStream and/or DecompressionStream classes of the codec. Relative URLs are resolved against Configuration#baseURI; passing an absolute URL (e.g. via import.meta.resolve()) is recommended.

    The module is imported dynamically at runtime. Bundlers and single-file builds (e.g. deno compile) cannot follow this import, so the module must be included explicitly (e.g. with deno compile --include or the equivalent option of the bundler).

    compressionMethod: number

    The compression method stored in zip entry headers (e.g. 93 for Zstandard). The values 0 (store), 8 (deflate), 9 (deflate64) and 99 (AES) are reserved.

    CompressionStream?: typeof CompressionStreamLike

    The stream implementation used to compress data, constructed with (format, options), see CompressionStreamOptions.

    DecompressionStream?: typeof DecompressionStreamLike

    The stream implementation used to decompress data, constructed with (format, options), see DecompressionStreamOptions.

    format: string

    The format name identifying the codec (e.g. "zstd"). It is passed as the first argument to the constructors of CompressionStream and DecompressionStream.

    versionNeeded?: number

    The minimum "version needed to extract" value written in zip entry headers (e.g. 63 for Zstandard).

    Settings
    Member Visibility

    On This Page
    Properties