Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

gzipy

0.0.2 • Public • Published

gzipy

A basic GZip compress and decompress library

npm npm

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.

Install

npm i gzipy

DownloadsWeekly Downloads

3

Version

0.0.2

License

MIT

Last publish

Collaborators

  • avatar