brotli
Advanced tools
Package description
The brotli npm package is a compression library that implements the Brotli compression algorithm. It provides methods for compressing and decompressing data using Brotli in Node.js applications.
Compression
This feature allows you to compress data using the Brotli algorithm. The code sample demonstrates how to read a file, compress its contents, and then write the compressed data to a new file with a .br extension.
const brotli = require('brotli');
const fs = require('fs');
const input = fs.readFileSync('input.txt');
const compressed = brotli.compress(input);
fs.writeFileSync('input.txt.br', compressed);Decompression
This feature allows you to decompress data that was previously compressed with the Brotli algorithm. The code sample shows how to read a compressed file, decompress its contents, and then write the decompressed data to a new file.
const brotli = require('brotli');
const fs = require('fs');
const compressed = fs.readFileSync('input.txt.br');
const decompressed = brotli.decompress(compressed);
fs.writeFileSync('output.txt', decompressed);zlib is a compression library that offers compression and decompression functionalities similar to brotli but using different algorithms like Deflate and Gzip. It is built into Node.js, making it readily available without additional installation.
snappy is a package that provides bindings to Google's Snappy compression library. It is known for its high-speed compression and decompression, although it typically achieves lower compression ratios compared to Brotli.
lz4 is a package that implements LZ4 compression, which is known for its extremely fast compression and decompression speeds, but like snappy, it may not achieve compression ratios as high as Brotli.
Readme
Brotli.js is port of the Brotli compression algorithm (as used in the WOFF2 font format) to JavaScript using Emscripten. The original C++ source code can be found here and in this repo as a submodule.
Install using npm.
npm install brotli
If you want to use brotli in the browser, you should use Browserify to build it.
In node, or in browserify, you can load brotli in the standard way:
var brotli = require('brotli');
Decompresses the given buffer to produce the original input to the compressor.
This function works best if you know the original size of the data (e.g. to decompressed size).
Inside a WOFF2 file, this is encoded as a field in the header of the binary file.
If you don't know the size of the input, don't include the outSize argument and
the function will guess a size that it thinks will be
big enough. If it guessed too small, or there was a decoding error, null is returned.
// decode a buffer where the output size is known
brotli.decode(compressedData, uncompressedLength);
// decode a buffer where the output size is not known
brotli.decode(fs.readFileSync('compressed.bin'));
Compresses the given buffer. Pass true as the second argument if the input
buffer is text data. Pass false or nothing if it is binary. This function
is known to be quite slow.
// encode a buffer of binary data
brotli.encode(fs.readFileSync('myfile.bin'));
// encode some text data
brotli.encode(fs.readFileSync('myfile.bin'), true);
MIT
FAQs
A port of the Brotli compression algorithm as used in WOFF2
The npm package brotli receives a total of 2,238,919 weekly downloads. As such, brotli popularity was classified as popular.
We found that brotli demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Socket is joining forces with CISA and other industry leaders at the RSA Conference to sign the Secure by Design pledge, committing to uphold the highest security standards in our products.
Research
The Socket research team breaks down a sampling of malicious packages that download and execute files, among other suspicious behaviors, targeting the popular Discord platform.
Security News
Socket CEO Feross Aboukhadijeh joins a16z partners to discuss how modern, sophisticated supply chain attacks require AI-driven defenses and explore the challenges and solutions in leveraging AI for threat detection early in the development life cycle.