Package Exports

compress-brotli

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (compress-brotli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

compress-brotli

Last version

Simple cross Node.js inteface for using brotli compression

Highlights

No dependencies.
Handle edge cases (such as try to compress undefined).
JSON serialization/deserialization by default.
Auto detect Node.js brotli API (>=11.7.0).

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')

// It exposes compress/decompress methods
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