Skip to content

Latest commit

 

History

History
67 lines (48 loc) · 2.48 KB

README.md

File metadata and controls

67 lines (48 loc) · 2.48 KB

@eggjs/compressible

NPM version Node.js CI Test coverage Known Vulnerabilities npm download Node.js Version PRs Welcome CodeRabbit Pull Request Reviews

Compressible Content-Type / mime checking.

Forked compressible for TypeScript and keep mime-db as same version as mime-types.

Installation

npm install @eggjs/compressible

API

import { compressible } from '@eggjs/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

Contributors

Contributors

Made with contributors-img.