Skip to content

985ch/base64zip

Repository files navigation

base64zip

node version NPM version build status Test coverage David deps npm download

This module encapsulates gzip compression and base64 encoding support.

Install

$ npm i base64zip --save

Usage

'use strict';

const { gzip, ungzip } = require('base64zip');

let zipped = await gzip('some text');
let unzipped = await ungzip(zipped);

More usage can be found in test.js

gzip(data, options)

  • data can be a string or any serializable object
  • In addition to the options that come with Node.js, options also support the extended option base64.
  • The buffer is returned by default, but the base64 string is returned when options.base64 is true.

ungzip(data, options)

  • data should be a valid buffer or base64 string
  • In addition to the options that come with Node.js, options also support the extended option parse.
  • The buffer is returned by default, but the result of JSON.parse is returned when options.parse is true.

Unit tests

npm test

License

MIT
This README was translate by google

About

A simple node.js compress/decompress module

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published