compress-brotli

Compress/Decompress using Brotli in a simple way.

Highlights

• 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

1$ npm install compress-brotli --save

Usage

1const createCompress = require('compress-brotli')
2
3// It exposes compress/decompress methods
4const { compress, decompress } = createCompress()

using v8 serialization:

1const createCompress = require('compress-brotli')
2const v8 = require('v8')
3
4const { compress, decompress } = createCompress({
5  serialize: v8.serialize,
6  deserialize: v8.deserialize
7})

customizing compress options:

1const createCompress = require('compress-brotli')
2
3const {
4  constants: {
5    BROTLI_MODE_TEXT,
6    BROTLI_PARAM_MODE,
7    BROTLI_PARAM_QUALITY
8  }
9} = require('zlib')
10
11// Provide factory level default options
12const { compress, decompress } = createCompress({
13  compressOptions: {
14    chunkSize: 1024,
15    parameters: {
16      [BROTLI_PARAM_MODE]: BROTLI_MODE_TEXT
17    }
18  },
19  decompressOptions: {
20    chunkSize: 1024,
21    parameters: {
22      [BROTLI_PARAM_MODE]: BROTLI_MODE_TEXT
23    }
24  }
25})
26const data = 'whatever'
27
28// Override call level options (deep merge for parameters)
29const compressed = compress(data, {
30  parameters: {
31    [BROTLI_PARAM_QUALITY]: 7
32  }
33})
34decompress(compressed, {
35  chunkSize: 2048
36})

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.

compressOptions

Type: zlib.BrotliOptions
Default: {} i.e. default zlib.brotliCompress options will be used

It defines default options to be used in wrapped zlib.brotliCompress call

decompressOptions

Type: zlib.BrotliOptions
Default: {} i.e. default zlib.brotliDecompress options will be used

It defines default options to be used in wrapped zlib.brotliDecompress call

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