Get the gzipped size of a string or buffer
Package: gzip-size
Created by: sindresorhus
Last modified: Sat, 18 Jun 2022 18:32:42 GMT
Version: 7.0.0
License: MIT
Downloads: 43,743,189
Repository: https://github.com/sindresorhus/gzip-size
Install
npm install gzip-size
yarn add gzip-size
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.
Related
- 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.
Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.
