History

William Moore 06a625a183 Initial code commit		2024-05-14 09:54:12 -05:00
..
node_modules/duplexer	Initial code commit	2024-05-14 09:54:12 -05:00
index.d.ts	Initial code commit	2024-05-14 09:54:12 -05:00
index.js	Initial code commit	2024-05-14 09:54:12 -05:00
license	Initial code commit	2024-05-14 09:54:12 -05:00
package.json	Initial code commit	2024-05-14 09:54:12 -05:00
readme.md	Initial code commit	2024-05-14 09:54:12 -05:00

readme.md

gzip-size

Get the gzipped size of a string or buffer

Install

npm install gzip-size

Usage

import {gzipSize, gzipSizeSync} from '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(gzipSizeSync(text));
//=> 78

API

gzipSize(input, options?)

Returns a Promise<number> with the size.

gzipSizeSync(input, options?)

Returns the size.

input

Type: string | Buffer

options

Type: object

Any zlib option.

gzipSizeFromFile(path, options?)

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

path

Type: string

gzipSizeFromFileSync(path, options?)

Returns the size of the file.

gzipSizeStream(options?)

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

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.}