npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

gzip-isize

v1.0.2

Published

Gets GZIP compressed size, uncompressed size, and compression ratio without extraction. TypeScript-friendly.

Downloads

232

Readme

gzip-isize

Build Status Known Vulnerabilities

Get GZIP file size statistics without extracting the file.

This module uses the GZIP ISIZE record in order to get size and compression ratio statistics for a GZIPped file. This module is useful for validation when trying to get a sense of what a GZip file will decompress to without actually attempting to decompress it.

Other popular modules get the size by actually doing the work. On smaller systems with limited resources or when extracting untrusted GZIP files, you may inadvertently end up with resource exhaustion during the extraction process. This module's function makes a good first-line sanity check before deeper analysis during extraction.

Usage

gzip-isize is written in TypeScript, and thus works well with TypeScript-based applications. However, it is easy to use in the traditional Node.js way:

const isz = require('../dist/isize.js').ISize;

isz.get('../test/file.tgz')
    .then((result) => {
        console.log(result);
    });

TypeScript

import { ISize, GZipCompressionInfo, GZipError } from 'gzip-isize';

try {
    let fileInfo:GZipCompressionInfo = await ISize.get('/path/to/tarball.tgz');

    console.info(`Compression info for ${fileInfo.name}`);
    console.info(`Original file size: ${fileInfo.originalSize} bytes`);
    console.info(`Compressed size: ${fileInfo.compressedSize} bytes`);
    console.info(`Compression ratio: ${fileInfo.compressionRatio}`);
    console.info(`Compression ratio percent: ${fileInfo.compressionRatioPercent})%`);
}
catch (e:GZipError) {
    console.error(`Decompression error: ${e}`);
}

Additional Resources

  • https://www.forensicswiki.org/wiki/Gzip#File_header
  • https://tools.ietf.org/html/rfc1952

License

MIT. © 2019 rarecoil.