snappy

Nodejs bindings to the snappy compression library

Installation

npm install snappy

Example

Input

var snappy = require('snappy')

snappy.compress('beep boop', function (err, compressed) {
  console.log('compressed is a Buffer', compressed)
  // return it as a string
  snappy.uncompress(compressed, { asBuffer: false }, function (err, original) {
    console.log('the original String', original)
  })
})

Output

compressed is a Buffer <SlowBuffer 09 20 62 65 65 70 20 62 6f 6f 70>
the original String beep boop

API

snappy.compress(input, callback)

Compress input, which can be a Buffer or a String.

The callback function will be called with a single error if the operation failed for any reason. If successful the first argument will be null and the second argument will be the value as a ``Buffer`.

snappy.compressSync(input)

The synchronous version of snappy.compress, returns the compressed value.