compress-brotli
Simple cross Node.js inteface for using brotli compression
Highlights
- Auto detect Node.js brotli API (
>=11.7.0
). - Handle edge cases (such as try to compress
undefined
). - JSON serialization/deserialization with Buffer support by default.
- Easy tu customize (e.g., using v8 serialization).
Install
$ npm install compress-brotli --save
In case you are not targeting Node.js v11.7.0 or above, you need to install iltorb
as extra dependency:
$ npm install iltorb --save
Usage
const createCompress = require('compress-brotli')
const { compress, decompress } = createCompress()
API
compressBrotli([options])
enable
Type: boolean
Default: false
If pass disable, it will return a noop compress/decompress methods.
serialize
Type: function
Default: JSONB.stringify
It determines the serialize method to use before compress the data.
deserialize
Type: function
Default: JSONB.parse
It determines the deserialize method to use after decompress the data.
License
compress-brotli © Kiko Beats, released under the MIT License.
Authored and maintained by Kiko Beats with help from contributors.
kikobeats.com · GitHub Kiko Beats · Twitter @Kikobeats