Neatly Packaged Magic

    gzip-size
    TypeScript icon, indicating that this package has built-in type declarations

    7.0.0 • Public • Published

    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


    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.

    Install

    npm i gzip-size

    DownloadsWeekly Downloads

    10,391,380

    Version

    7.0.0

    License

    MIT

    Unpacked Size

    8.3 kB

    Total Files

    5

    Last publish

    Collaborators

    • sindresorhus