Skip to content
Simple cross Node.js inteface for using brotli compression
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
test test: add buffer test Nov 4, 2019
.bumpedrc
.editorconfig build: expose serialize and deserialize methods Apr 11, 2019
.gitattributes build(no-release): first commit Apr 6, 2019
.gitignore build(no-release): first commit Apr 6, 2019
.npmrc
.travis.yml
CHANGELOG.md chore(release): 1.2.1 Nov 4, 2019
LICENSE build(no-release): first commit Apr 6, 2019
README.md test: add buffer test Nov 4, 2019
index.js feat: use json-buffer Nov 4, 2019
package.json

README.md

compress-brotli

Last version Build Status Coverage Status Dependency status Dev Dependencies Status NPM Status

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

// 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

You can’t perform that action at this time.