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

Similar packages

Other packages similar to gzip-size

compressing

The 'compressing' package is a comprehensive compression library that supports gzip, tar, zip, and tgz formats. While it offers broader functionality in terms of supported formats, it might be more complex to use when you only need to calculate gzip sizes.

zlib

Node's built-in 'zlib' module provides compression functionality, including gzip compression. While it is not an npm package, it serves a similar purpose. However, 'gzip-size' simplifies the process specifically for calculating the size of compressed content, making it more convenient for this specific use case.

brotli-size

Similar to 'gzip-size', 'brotli-size' calculates the size of a string or buffer after compression, but using the Brotli algorithm instead of gzip. This package is useful for those looking to compare or utilize Brotli compression, which can offer better compression ratios for certain types of content.