gzip-size

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`);