Need help with gzip-size?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

sindresorhus
142 Stars 19 Forks MIT License 59 Commits 0 Opened issues

Description

Get the gzipped size of a string or buffer

Services available

!
?

Need anything else?

Contributors list

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
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
with the size of the file.

path

Type:

string

gzipSize.fileSync(path, options?)

Returns the size of the file.

Related


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.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.