Security News
The Dark Side of Open Source
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.
gzip-size
Advanced tools
Package description
The gzip-size npm package allows you to easily calculate the compressed size of a string or buffer using gzip compression. This can be particularly useful for assessing the size of files or assets in web development, ensuring that your resources are optimized for performance by evaluating their size after compression.
Get the compressed size of a string
This feature allows you to calculate the gzip-compressed size of a string. It's useful for quickly assessing how much space a piece of text will take up after compression.
const gzipSize = require('gzip-size');
const string = 'Hello, world!';
gzipSize(string).then(size => {
console.log(`Compressed size: ${size} bytes`);
});
Get the compressed size of a file
This feature calculates the gzip-compressed size of a file's contents. It's particularly useful for web developers looking to optimize their assets for performance by understanding the size impact of compression.
const gzipSize = require('gzip-size');
const fs = require('fs');
fs.readFile('file.txt', 'utf8', (err, data) => {
if (err) {
throw err;
}
gzipSize(data).then(size => {
console.log(`Compressed size: ${size} bytes`);
});
});
Synchronous API for getting compressed size
gzip-size also offers a synchronous API, allowing for immediate calculation of the compressed size without dealing with promises. This can be handy for scripts and applications where asynchronous handling is not necessary or desired.
const gzipSize = require('gzip-size');
const string = 'Hello, world!';
const size = gzipSize.sync(string);
console.log(`Compressed size: ${size} bytes`);
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.
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.
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.
Readme
Get the gzipped size of a string or buffer
npm install gzip-size
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
Returns a Promise<number>
with the size.
Returns the size.
Type: string | Buffer
Type: object
Any zlib
option.
Returns a Promise<number>
with the size of the file.
Type: string
Returns the size of the file.
Returns a stream.PassThrough
. The stream emits a gzip-size
event and has a gzipSize
property.
FAQs
Get the gzipped size of a string or buffer
The npm package gzip-size receives a total of 10,671,090 weekly downloads. As such, gzip-size popularity was classified as popular.
We found that gzip-size demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.
Research
Security News
The Socket Research team found this npm package includes code for collecting sensitive developer information, including your operating system username, Git username, and Git email.
Security News
OpenJS is warning of social engineering takeovers targeting open source projects after receiving a credible attempt on the foundation.