snappy-stream

Compress data over a Stream using the snappy framing format

Installation

npm install snappy-stream

Benchmark

snappy is notably faster than gzip (as can be seen in benchmarks).

snappy-stream however is only slightly faster than gzip, because of the overhead of creating a Stream to begin with.

This is the result I'm seeing on my laptop (Macbook Air from 2012) running node benchmark (for now only testing compression)

  passthrough stream (no compression) x 644 ops/sec ±0.90% (84 runs sampled)
  zlib.createGzip() x 667 ops/sec ±0.50% (89 runs sampled)
  snappyStream.createCompressStream() x 690 ops/sec ±0.89% (86 runs sampled)

Example

Input

var snappyStream = require('snappy-stream')
  , compressStream = snappyStream.createCompressStream()
  , uncompressStream = snappyStream.createUncompressStream({
      asBuffer: false // optional option, asBuffer = false means that the stream emits strings, default: true
    })

compressStream.on('data', function (chunk) {
  console.log('Som data from the compressed stream', chunk)
  uncompressStream.write(chunk)
})

uncompressStream.on('data', function (chunk) {
  console.log('The data that was originally written')
  console.log(chunk)
})

compressStream.write('hello')
compressStream.write('world')
compressStream.end()

Output

Som data from the compressed stream <Buffer ff 06 00 00 73 4e 61 50 70 59>
Som data from the compressed stream <Buffer 01 09 00 00 bb 1f 82 a2 68 65 6c 6c 6f>
The data that was originally written
hello
Som data from the compressed stream <Buffer 01 09 00 00 2d 4e 1f a5 77 6f 72 6c 64>
The data that was originally written
world

Running tests

The tests are using the https://pypi.python.org/pypi/python-snappy library, so you need to install that first for it to work:

[sudo] pip install python-snappy

You also need to install the snappy library on your machine, using your favourite package manager (e.g. sudo apt-get install libsnappy-dev or brew install snappy).

Licence

Copyright (c) 2014 David Björklund

This software is released under the MIT license:

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.