lz4-napi

Node.js NAPI Binding for LZ4 compression algorithm, powered by Rust napi-rs and lz4-flex.

Pros:

• Fast! ⚡️
• Memory Safe! 🔒
• Uses libuv's threadpool! 🧵

Table of content

• Installation
• Usage
  • Compress
  • Uncompress
• APIs
  • Promises
    • compress
    • uncompress
  • Sync
    • compressSync
    • uncompressSync
• Benchmarks
• Performance
  • Hardware
  • Results
• Contributing
• License

Installation

1npm i lz4-napi
2# OR
3yarn add lz4-napi

Usage

Compress

1const { readFile } = require('fs/promises');
2const { compress } = require('lz4-napi');
3
4// if you support top-level await
5const buffer = await readFile("./bigFile.dat");
6const compressedBuffer = await compress(buffer)
7// Store compressed buffer somewhere

Uncompress

1const { uncompress } = require('lz4-napi');
2
3// if you support top-level await
4const compressedBuffer = await getFromSomeStorage();
5const uncompressedBuffer = await uncompress(compressedBuffer)
6// Do something with compressedBuffer!

APIs

Promise

compress

1(data: Buffer | string | ArrayBuffer | Uint8Array, dict?: string | Buffer) => Promise<Buffer>

uncompress

1(data: Buffer | string | ArrayBuffer | Uint8Array, dict?: string | Buffer) => Promise<Buffer>

compressFrame

1(data: Buffer | string | ArrayBuffer | Uint8Array) => Promise<Buffer>

decompressFrame

1(data: Buffer | string | ArrayBuffer | Uint8Array) => Promise<Buffer>

Sync

compressSync

1(data: Buffer | string | ArrayBuffer | Uint8Array, dict?: string | Buffer) => Buffer

uncompressSync

1(data: Buffer | string | ArrayBuffer | Uint8Array, dict?: string | Buffer) => Buffer

Performance

Hardware

Benchmarks runs on the following hardware:

• Processor Name: i9 9900K
• Total Number of Cores: 8
• Hyper-Threading Technology: Enabled
• Memory: 32 GB

Benchmark

1Running "Compress" suite...
2Progress: 100%
3
4  lz4:
5    911 ops/s, ±18.64%     | 54.68% slower
6
7  snappy:
8    2 010 ops/s, ±19.23%   | fastest
9
10  gzip:
11    78 ops/s, ±18.76%      | 96.12% slower
12
13  deflate:
14    118 ops/s, ±20.42%     | 94.13% slower
15
16  brotli:
17    6 ops/s, ±0.21%       | slowest, 99.7% slower
18
19Finished 5 cases!
20  Fastest: snappy
21  Slowest: brotli
22Running "Decompress" suite...
23Progress: 100%
24
25  lz4:
26    9 425 ops/s, ±12.50%   | fastest
27
28  snappy:
29    3 900 ops/s, ±13.39%   | 58.62% slower
30
31  gzip:
32    823 ops/s, ±20.48%     | slowest, 91.27% slower
33
34  deflate:
35    1 350 ops/s, ±12.52%   | 85.68% slower
36
37  brotli:
38    979 ops/s, ±11.55%     | 89.61% slower
39
40Finished 5 cases!
41  Fastest: lz4
42  Slowest: gzip
43Done in 61.20s.

Contributing

Project is pretty simple and straight forward for what is my needs, but if you have any idea you're welcome.

This projects uses conventional commit so be sure to use standard commit format or PR won't be accepted

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'feat(scope): some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Acknowledgments

• Brooooooklyn/snappy - Inspiration and project structure

License

Distributed under the MIT License. See LICENSE for more information.