devongovett

brotli

  "description": "A port of the Brotli compression algorithm as used in WOFF2",

    "url": "https://github.com/devongovett/brotli.js.git"

  "author": "Devon Govett <devongovett@gmail.com>",

    "url": "https://github.com/devongovett/brotli.js/issues"

  "homepage": "https://github.com/devongovett/brotli.js"

Brotli.js is port of the [Brotli](http://tools.ietf.org/html/draft-alakuijala-brotli-01) compression algorithm (as used in the [WOFF2](http://www.w3.org/TR/WOFF2/) font format) to JavaScript using Emscripten.  The original C++ source code can be found

[here](https://code.google.com/p/font-compression-reference) and in this repo as a submodule.

If you want to use brotli in the browser, you should use [Browserify](http://browserify.org/) to build it.

In node, or in browserify, you can load brotli in the standard way:

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

brotli.decompress(compressedData, uncompressedLength);

// decode a buffer where the output size is not known

brotli.decode(fs.readFileSync('compressed.bin'));

brotli.decompress(fs.readFileSync('compressed.bin'));

### brotli.encode(buffer, isText = false)

### brotli.compress(buffer, isText = false)

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

brotli.encode(fs.readFileSync('myfile.bin'));

brotli.compress(fs.readFileSync('myfile.bin'));

brotli.encode(fs.readFileSync('myfile.bin'), true);

brotli.compress(fs.readFileSync('myfile.bin'), true);

		{
		"name": "brotli",
		"version": "1.0.0",
		"version": "1.0.1",
		"description": "A port of the Brotli compression algorithm as used in WOFF2",
		@@ -5,0 +5,0 @@ "main": "index.js",

New alerts

Worsened metrics

		@@ -22,3 +22,3 @@ # Brotli.js

		### brotli.decode(buffer, outSize)
		### brotli.decompress(buffer, outSize)

		@@ -34,9 +34,9 @@ Decompresses the given buffer to produce the original input to the compressor.
		// decode a buffer where the output size is known
		brotli.decode(compressedData, uncompressedLength);
		brotli.decompress(compressedData, uncompressedLength);

		// decode a buffer where the output size is not known
		brotli.decode(fs.readFileSync('compressed.bin'));
		brotli.decompress(fs.readFileSync('compressed.bin'));
		```

		### brotli.encode(buffer, isText = false)
		### brotli.compress(buffer, isText = false)

		@@ -49,6 +49,6 @@ Compresses the given buffer. Pass `true` as the second argument if the input
		// encode a buffer of binary data
		brotli.encode(fs.readFileSync('myfile.bin'));
		brotli.compress(fs.readFileSync('myfile.bin'));

		// encode some text data
		brotli.encode(fs.readFileSync('myfile.bin'), true);
		brotli.compress(fs.readFileSync('myfile.bin'), true);
		```
		@@ -55,0 +55,0 @@