@cloudpss/zstd


This is a pure esm package
contains the zstd n-api addon for node.js & wasm for browsers.

Installation

``bash
npm install @cloudpss/zstd
`

Usage

$3

`js
import { compress, decompress } from '@cloudpss/zstd';

const compressed = await compress(new TextEncoder().encode('Hello World!'));
const decompressed = await decompress(compressed);

console.log(new TextDecoder().decode(decompressed)); // Hello World!
`

To explicitly use the wasm or the n-api version, import @cloudpss/zstd/wasm and @cloudpss/zstd/napi respectively.

API

$3

#### compress(input: BufferSource | Blob, level?: number): Promise
compressSync(input: BufferSource, level?: number): Uint8Array

Compresses the input data with the given compression level (default: 4).

#### decompress(input: BufferSource | Blob): Promise
decompressSync(input: BufferSource): Uint8Array

Decompresses the input data.

#### TYPE: 'napi' | 'wasm'

The type of the current module.

#### ZSTD_VERSION(): string

The version of the zstd library.

$3

#### MAX_SIZE: number

The maximum size of the input/output buffer.

#### DEFAULT_LEVEL: number

The default compression level.

#### MIN_LEVEL: number

Minimum compression level.

#### MAX_LEVEL: number`

Maximum compression level.

License

MIT