node-gzip
DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/node-gzip package

1.1.2 • Public • Published

node-gzip

Gzip and ungzip in Node.js

Tiny and easy to use wrapper around zlib.gzip and zlib.gunzip to support promises.

const compressed = await gzip('Hello World');

Install

npm install node-gzip --save

Examples

With Promises

const {gzip, ungzip} = require('node-gzip');
 
gzip('Hello World')
  .then((compressed) => {
    return ungzip(compressed);
  })
  .then((decompressed) => {
    console.log(decompressed.toString());     //Hello World
  });

With async / await

const {gzip, ungzip} = require('node-gzip');
 
const compressed = await gzip('Hello World');
 
const decompressed = await ungzip(compressed);
 
console.log(decompressed.toString());        //Hello World

Options

Pass options just like with Zlib. See all options.

await gzip('Hello World', {...});

Description

gzip(input[,options])

  • input: Buffer | TypedArray | DataView | ArrayBuffer | string
  • returns: Buffer

ungzip(input[,options])

  • input: Buffer | TypedArray | DataView | ArrayBuffer | string
  • returns: Buffer

Use toString() after ungzip to convert the Buffer into a string.

Supports Node.js version 0.12 and higher.


License

node-gzip is MIT licensed.

Package Sidebar

Install

npm i node-gzip

Weekly Downloads

201,717

Version

1.1.2

License

MIT

Unpacked Size

3.93 kB

Total Files

4

Last publish

Collaborators

  • rebs