function

zstdCompressSync

function zstdCompressSync(

data: string | ArrayBuffer | Buffer<ArrayBufferLike> | TypedArray<ArrayBufferLike>,

options?: { level: number }

): Buffer;

Compresses a chunk of data with the Zstandard (zstd) compression algorithm.

@param data

The buffer of data to compress

@param options

Compression options to use

@returns

The output buffer with the compressed data

Referenced types

class ArrayBuffer

Represents a raw buffer of binary data, which is used to store data for the different typed arrays. ArrayBuffers cannot be read from or written to directly, but can be passed to a typed array or DataView Object to interpret the raw buffer as needed.

readonly [Symbol.toStringTag]: string
readonly byteLength: number
Read-only. The length of the ArrayBuffer (in bytes).
resize(
newByteLength?: number
): void;
Resizes the ArrayBuffer to the specified size (in bytes).
MDN
resize(
byteLength: number
): ArrayBuffer;
Resize an ArrayBuffer in-place.
slice(
begin: number,
end?: number
): ArrayBuffer;
Returns a section of an ArrayBuffer.
transfer(
newByteLength?: number
): ArrayBuffer;
Creates a new ArrayBuffer with the same byte content as this buffer, then detaches this buffer.
MDN
transferToFixedLength(
newByteLength?: number
): ArrayBuffer;
Creates a new non-resizable ArrayBuffer with the same byte content as this buffer, then detaches this buffer.
MDN