BuildDocsReferenceGuidesBlog
Discord logo
Discord
GitHub logo
FzstdCompressSync
Bun

function

zlib.zstdCompressSync

buf: InputType,
options?: ZstdOptions
): NonSharedBuffer;

Compress a chunk of data with ZstdCompress.

Referenced types

type InputType = string | ArrayBuffer | NodeJS.ArrayBufferView

interface ZstdOptions

  • chunkSize?: number
  • dictionary?: ArrayBufferView<ArrayBufferLike>

    Optional dictionary used to improve compression efficiency when compressing or decompressing data that shares common patterns with the dictionary.

  • finishFlush?: number
  • flush?: number
  • info?: boolean

    If true, returns an object with buffer and engine.

  • maxOutputLength?: number
  • params?: {
    __index[
    key: number
    ]: number | boolean;
     }