sindresorhus / gzip-size Goto Github PK

View Code? Open in Web Editor NEW

169.0 7.0 20.0 43 KB

Get the gzipped size of a string or buffer

License: MIT License

JavaScript 77.70% TypeScript 22.30%

gzip-size's Introduction

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

gzip-size's People

Contributors

Stargazers

Watchers

Forkers

okize paladox alex87 alihmden webin turbo87 tikotzky 4bos meghasfdc amagiddmxh richienb vltansky fairhopeweb semabigcorp dimied

gzip-size's Issues

Hello, what is the compression level?

Hello, what is the compression level? It feels different from the default compression level of compression.

Decompress string

How do you decompress?

Exposing Options

Would be nice if zlib options were exposed.
https://nodejs.org/api/zlib.html#zlib_options

In particular compression level would be nice. I assume since it's not set it's using the default gzip level of -6, when what I would like to see is -9.

Version 7 is incompatible with "commonjs" typescript compiler

I have an error when trying to compile code using this module on node v16.17.1 on MacOS 13.1 with following setup (version 6 working just fine):

Error [ERR_REQUIRE_ESM]: require() of ES Module .../my-project/node_modules/gzip-size/my-file.js from .../my-project/src/my-file.js not supported.
Instead change the require of index.js in .../my-project/src/my-file.js to a dynamic import() which is available in all CommonJS modules.

My setup (to reproduce):

// package.json
{
    ...
    "dependencies": {
        ...
        "gzip-size": "^7.0.0",
    },

// tsconfig.json (https://www.npmjs.com/package/@tsconfig/recommended)
{
    "compilerOptions": {
        "target": "ES2015",
        "module": "commonjs",
        "strict": true,
        "esModuleInterop": true,
        "skipLibCheck": true,
        "forceConsistentCasingInFileNames": true
    },
    "include": ["src"],
    "exclude": ["node_modules", "**/__tests__/*"]
}

// my-file.ts
import { gzipSizeSync } from "gzip-size";
console.log(gzipSizeSync)

gzipSize(input, options) has undocumented and unused second `cb` argument

According to https://github.com/sindresorhus/gzip-size/blob/v4.0.0/index.js#L9 the gzipSize function has a second parameter cb that is undocumented and also not used. This seems like a bug as it causes the options argument that is supposed to be the second argument to be ignored.

Original size and compression ratio

Would be great if along with the gzipped size it could show the original size and the compression ratio.

What do you think?

Add `.file()` method

I think it would be useful to add a path() method that did something like:

function path(path, options) {
  return new Promise((resolve, reject) => {
    let stream = fs.createReadStream(path);
    stream.on('error', reject);
    stream.pipe(gzipSize.stream(options)).on('gzip-size', resolve);
  });
}

Would that be a welcome PR?

Doesn't seem to work with ESM builds for nodejs env

Since it is using deprecated Duplexer library, (with 15M weekly downloads btw) which has only CJS build to it.

Building my package with tsup (goes through fine) and trying to run the "binary", I get the following error message:

throw Error('Dynamic require of "' + x + '" is not supported');
        ^
Error: Dynamic require of "stream" is not supported

First line of duplexer's build is:

var Stream = require("stream")

And it is causing problems.

My ts config uses NodeNext as module and moduleResolution, and I have "type": "module" in package.json.

Once I drop gzip-size import from my code, all builds and works fine.

Let me know how I can help and thank you for the library! ❤️

Seemingly related issue with esbuild. I use tsup but these are similar tools.