@tesla-js/tslazip v1.0.1

Installation

npm install @tesla-js/tslazip

Example

Input

var tslazip = require('tslazip')

tslazip.compress('beep boop', function (err, compressed) {
  console.log('compressed is a Buffer', compressed)
  // return it as a string
  tslazip.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

tslazip.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`.

tslazip.compressSync(input)

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

tslazip.uncompress(compressed, options, callback)

Uncompress compressed and call callback with err and decompressed.

options

• 'asBuffer' (boolean, default: true): Used to determine whether to return the value of the entry as a String or a Node.js Buffer object. Note that converting from a Buffer to a String incurs a cost so if you need a String (and the value can legitimately become a UFT8 string) then you should fetch it as one with asBuffer: true and you'll avoid this conversion cost.

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 String or Buffer depending on the asBuffer option.

tslazip.uncompressSync(compressed, options)

The synchronous version of tslazip.uncompress, returns the uncompressed value.

tslazip.isValidCompressed(input, callback)

Check is input is a valid compressed Buffer.

The callback function will be called with a single error if the operation failed for any reason and the second argument will be true if input is a valid tslazip compressed Buffer, false otherwise.

tslazip.isValidCompressedSync(input)

The synchronous version of tslazip.isValidCompressed, returns a boolean indicating if input was correctly compressed or not.