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.

API

compressible(type)

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

compressible.get(type)

Returns the specifications object associated with the given Content-Type. Generates an object using the regex if none is found.

compressible.specs

Exports specifications.json.

compressible.regex

The regular expression that checks the Content-Type. However, you should use compressible(type) instead of this regular expression due to additional non-regex checks.

License

The MIT License (MIT)

Copyright (c) 2013 Jonathan Ong [e-mail]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.