brotli-js

Google brotli binding to Node.js via Rust and napi-rs

This library is mainly used to test the performance of napi-rs v2. For actual development, please use the zlib.brotliCompress() method that comes with Node.js.

• Cross-platform support, including Apple M1.
• No need for node-gyp and postinstall, the .node file has been compiled for you.

Installation

npm i @brotli/brotli-js
cnpm i @brotli/brotli-js
pnpm i @brotli/brotli-js

Support matrix

	node12	node14	node16	npm
Windows x64	✓	✓	✓
Windows x32	✓	✓	✓
Windows arm64	✓	✓	✓
macOS x64	✓	✓	✓
macOS arm64(M1)	✓	✓	✓
Linux x64 gnu	✓	✓	✓
Linux x64 musl	✓	✓	✓
Linux arm gnu	✓	✓	✓
Linux arm64 gnu	✓	✓	✓
Linux arm64 musl	✓	✓	✓
Android arm64	✓	✓	✓

benchmarks

npm run bench

Running "1024 Bytes" suite...
  zlib(Native):
    262 ops/s, ±6.68%   | fastest

  iltorb(C++):
    248 ops/s, ±3.40%   | 5.34% slower

  brotli-js(Rust):
    115 ops/s, ±1.74%   | slowest, 56.11% slower

Build

You can set the name of the generated .node file in napi.name of package.json.

After npm run build command, you can see brotlijs.[darwin|win32|linux].node file in project root. This is the native addon built from lib.rs.

Develop requirements

• Install latest Rust
• Install Node.js@10+ which fully supported Node-API
• Install [email protected]

Test in local

• yarn
• yarn build
• yarn test

And you will see:

$ ava --verbose

  ✔ sync function from native code
  ✔ sleep function from native code (201ms)
  ─

  2 tests passed
✨  Done in 1.12s.

Release package

We use GitHub actions to automatically publish npm packages.

# 1.0.0 => 1.0.1
npm version patch

# or 1.0.0 => 1.1.0
npm version minor

git push --follow-tags

License

MIT