website/node_modules/gzip-size/readme.md

In JohnCoene/chirp: 'Twitter' Networks Analyser

gzip-size

Get the gzipped size of a string or buffer

Install

$ npm install --save gzip-size

Usage

var gzipSize = require('gzip-size');
var string = 'Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus.';

console.log(string.length);
//=> 191

console.log(gzipSize.sync(string));
//=> 78

API

gzipSize(input, callback)

gzipSize.sync(input)

input

Type: string, buffer

callback(error, size)

Type: function

gzipSize.stream()

Returns a passthrough stream. The stream emits a gzip-size event and has a gzipSize property.

Related

• gzip-size-cli - CLI for this module

License

MIT © Sindre Sorhus

JohnCoene/chirp documentation built on May 25, 2021, 6:33 p.m.