History

k_m_x 04c1a405c9 vision1		10 months ago
..
index.d.ts	vision1	10 months ago
index.js	vision1	10 months ago
license	vision1	10 months ago
package.json	vision1	10 months ago
readme.md	vision1	10 months ago

readme.md

gzip-size

Get the gzipped size of a string or buffer

Install

$ npm install gzip-size

Usage

const gzipSize = require('gzip-size');

const text = '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(text.length);
//=> 191

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

API

gzipSize(input, options?)

Returns a Promise<number> with the size.

gzipSize.sync(input, options?)

Returns the size.

input

Type: string | Buffer

options

Type: object

Any zlib option.

gzipSize.stream(options?)

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

gzipSize.file(path, options?)

Returns a Promise<number> with the size of the file.

path

Type: string

gzipSize.fileSync(path, options?)

Returns the size of the file.

gzip-size-cli - CLI for this module

Get professional support for this package with a Tidelift subscription
_{Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.}