Interface CompressParameters

Zstandard compression parameters.

Most applications will only need the compressionLevel parameter. See the Zstandard manual for a full description.

interface CompressParameters {
    chainLog?: number;
    checksumFlag?: boolean;
    compressionLevel?: number;
    contentSizeFlag?: boolean;
    dictIDFlag?: boolean;
    enableLongDistanceMatching?: boolean;
    hashLog?: number;
    jobSize?: number;
    ldmBucketSizeLog?: number;
    ldmHashLog?: number;
    ldmHashRateLog?: number;
    ldmMinMatch?: number;
    minMatch?: number;
    nbWorkers?: number;
    overlapLog?: number;
    searchLog?: number;
    strategy?:
        | "fast"
        | "dfast"
        | "greedy"
        | "lazy"
        | "lazy2"
        | "btlazy2"
        | "btopt"
        | "btultra";
    targetCBlockSize?: number;
    targetLength?: number;
    windowLog?: number;
}

Advanced compression options

chainLog? hashLog? minMatch? searchLog? strategy? targetCBlockSize? targetLength? windowLog?

Basic parameters

compressionLevel?

Frame parameters

checksumFlag? contentSizeFlag? dictIDFlag?

Long-distance matching

enableLongDistanceMatching? ldmBucketSizeLog? ldmHashLog? ldmHashRateLog? ldmMinMatch?

Multi-threading parameters

jobSize? nbWorkers? overlapLog?

Advanced compression options

OptionalchainLog

chainLog?: number

OptionalhashLog

hashLog?: number

OptionalminMatch

minMatch?: number

OptionalsearchLog

searchLog?: number

Optionalstrategy

strategy?:
    | "fast"
    | "dfast"
    | "greedy"
    | "lazy"
    | "lazy2"
    | "btlazy2"
    | "btopt"
    | "btultra"

OptionaltargetCBlockSize

targetCBlockSize?: number

OptionaltargetLength

targetLength?: number

OptionalwindowLog

windowLog?: number

Basic parameters

OptionalcompressionLevel

compressionLevel?: number

Compression level, where higher numbers compress better but are slower.

Typical values range from 1 to 9, with a default of 3, but values up to 22 are allowed, as are negative values (see binding.minCLevel). Zero is interpreted as "use the default".

Frame parameters

OptionalchecksumFlag

checksumFlag?: boolean

OptionalcontentSizeFlag

contentSizeFlag?: boolean

OptionaldictIDFlag

dictIDFlag?: boolean

Long-distance matching

OptionalenableLongDistanceMatching

enableLongDistanceMatching?: boolean

OptionalldmBucketSizeLog

ldmBucketSizeLog?: number

OptionalldmHashLog

ldmHashLog?: number

OptionalldmHashRateLog

ldmHashRateLog?: number

OptionalldmMinMatch

ldmMinMatch?: number

Multi-threading parameters

OptionaljobSize

jobSize?: number

OptionalnbWorkers

nbWorkers?: number

OptionaloverlapLog

overlapLog?: number

Settings

Member Visibility

On This Page

Advanced compression options
Basic parameters
Frame parameters
Long-distance matching
Multi-threading parameters