@skhaz/zstd

[![][npm-version]][npm-url] [![][npm-downloads]][npm-url] [![license][license-img]][license-url] [![issues][issues-img]][issues-url] [![stars][stars-img]][stars-url] [![commits][commits-img]][commits-url]

Zstd (Zstandard) binding for Nodejs, with TypeScript, AMD64 & ARM64 support.

Installation

``sh
$ npm install @skhaz/zstd --save
`

Usage

$3

#### compress(buffer[, zstdCompressParams])

`ts
import { compress } from '@skhaz/zstd'

try {
const output = await compress(input)
} catch (err) {
// ...
}
`

#### decompress(buffer[, zstdDecompressParams])

`ts
import { decompress } from '@skhaz/zstd'

try {
const output = await decompress(input)
} catch (err) {
// ...
}
`

$3

#### compressSync(buffer[, zstdCompressParams])

`ts
import { compressSync } from '@skhaz/zstd'

try {
const output = compressSync(input)
} catch (err) {
// ...
}
`

#### decompressSync(buffer[, zstdCompressParams])

`ts
import { decompressSync } from '@skhaz/zstd'

try {
const output = decompressSync(input)
} catch (err) {
// ...
}
`

$3

#### compressStream([zstdCompressParams])

`ts
import { compressStream } from '@skhaz/zstd'
import { createReadStream, createWriteStream } from 'fs'

createReadStream('path/to/input').pipe(compressStream()).pipe(createWriteStream('path/to/output'))
`

#### decompressStream([zstdCompressParams])

`ts
import { decompressStream } from '@skhaz/zstd'
import { createReadStream, createWriteStream } from 'fs'

createReadStream('path/to/input').pipe(decompressStream()).pipe(createWriteStream('path/to/output'))
`

$3

The compress, compressSync and compressStream methods may accept an optional zstdCompressParams object to define compress level and/or dict.

`ts
const zstdCompressParams = {
level: 5, // default 1
dict: new Buffer('hello zstd'), // if dict null, left level only.
dictSize: dict.length, // if dict null, left level only.
}
`

The decompress, decompressSync and decompressStream methods may accept an optional zstdDecompressParams object to define dict.

`ts
const zdtdDecompressParams = {
dict: new Buffer('hello zstd'),
dictSize: dict.length,
}
`

Tests

`sh
$ npm test
``

License

MIT

[npm-version]: https://img.shields.io/npm/v/@skhaz/zstd.svg?style=flat-square
[npm-downloads]: https://img.shields.io/npm/dm/@skhaz/zstd.svg?style=flat-square
[npm-url]: https://www.npmjs.org/package/@skhaz/zstd
[license-img]: https://img.shields.io/github/license/skhaz/zstd?style=flat-square
[license-url]: LICENSE
[issues-img]: https://img.shields.io/github/issues/skhaz/zstd?style=flat-square
[issues-url]: https://github.com/skhaz/zstd/issues
[stars-img]: https://img.shields.io/github/stars/skhaz/zstd?style=flat-square
[stars-url]: https://github.com/skhaz/zstd/stargazers
[commits-img]: https://img.shields.io/github/last-commit/skhaz/zstd?style=flat-square
[commits-url]: https://github.com/skhaz/zstd/commits/master