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

Readme

Source

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

Keywords

FAQs

What is compressible?

Is compressible popular?

Is compressible well maintained?

Last updated on 06 Jan 2020

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.

Install