Class CDict

Prepared dictionary for compression.

Wraps ZSTD_CDict. The finalizer automatically calls ZSTD_freeCDict when this object is garbage collected.

Constructors

constructor

Methods

getDictID

Constructors

constructor

  • new CDict(dictBuf, level): CDict

  • Load a dictionary for compression from the bytes in dictBuf.

    The compression level must be given in level and will override any compression level set when this dictionary is used.

    Wraps ZSTD_createCDict.

    Parameters

    • dictBuf: Uint8Array
    • level: number

    Returns CDict

Methods

getDictID

  • getDictID(): number

  • Returns the ID for this dictionary.

    Wraps ZSTD_getDictID_fromCDict.

    Returns number

    The ID, or 0 if this is a non-standard/content-only dictionary

Settings

Member Visibility

On This Page

Constructors
Methods