gzipy
v0.0.2
Published
A basic GZip compress and decompress library
Downloads
44
Maintainers
Readme
gzipy
A basic GZip compress and decompress library
Install
You can install the latest version of the package using npm:
$ npm install --save gzipy
Usage
//Import gzipy
var gzipy = require('gzipy');
//Compress a file
gzipy.compress('./file.txt', './file.txt.gz', function(error)
{
//Handle the error
if(error){ /* Something went wrong... */ }
console.log('File compressed!');
});
//Decompress a file
gzipy.decompress('./document.pdf.gz', './document.pdf', function(error)
{
//Handle the error
if(error){ /* Something went wrong... */ }
console.log('File decompressed');
});
API
gzipy.compress(input, output, callback)
Compress the input
file and save it to output
. The callback method will be called when the process is completed or when there is an error.
gzipy.decompress(input, output, callback)
Decompress the input
file and save it to output
. The callback method will be called when the process is completed or when there is an error.
License
Under the MIT LICENSE.