compressible

What is compressible?

The compressible npm package is used to determine if a given MIME type is compressible. This is useful when working with HTTP servers and clients to decide whether to apply compression to a particular resource based on its Content-Type.

What are compressible's main functionalities?

Check if MIME type is compressible

This feature allows you to check if a specific MIME type is generally considered compressible. Text-based formats like HTML are typically compressible, while binary formats like PNG are not.

const compressible = require('compressible');

console.log(compressible('text/html')); // true
console.log(compressible('image/png')); // false

Other packages similar to compressible

mime-types

The mime-types package provides a library for resolving a file's MIME type based on its extension. It can also look up the extension based on a MIME type. While it does not directly tell you if a MIME type is compressible, it can be used in conjunction with other libraries to make that determination.

compression

The compression package is an Express middleware for Node.js that provides response compression. It automatically determines if the response should be compressed or not, using a similar logic to what compressible provides, but it is more focused on the actual compression process rather than just the determination.

README

compressible

Compressible Content-Type / mime checking.

Installation

$ npm install compressible

API

var compressible = require('compressible')

compressible(type)

Checks if the given Content-Type is compressible. The type argument is expected to be a value MIME type or Content-Type string, though no validation is performed.

The MIME is looked up in the mime-db and if there is compressible information in the database entry, that is returned. Otherwise, this module will fallback to true for the following types:

• text/*
• */*+json
• */*+text
• */*+xml

If this module is not sure if a type is specifically compressible or specifically uncompressible, undefined is returned.

compressible('text/html') // => true
compressible('image/png') // => false

License

MIT