mime-types
Advanced tools
Package description
The mime-types npm package is a utility for resolving file extensions to MIME types and vice versa. It is based on the mime-db dataset, which is a comprehensive set of MIME type definitions.
Lookup MIME type for a file extension
This feature allows you to find the MIME type for a given file extension. If the extension has a MIME type in the database, it will return it as a string; otherwise, it will return false.
const mime = require('mime-types');
const mimeType = mime.lookup('json'); // 'application/json'Determine the default extension for a MIME type
This feature enables you to find the default file extension for a given MIME type. If the MIME type has an associated extension, it will return it as a string; otherwise, it will return false.
const mime = require('mime-types');
const extension = mime.extension('application/json'); // 'json'Lookup charset for a MIME type
This feature allows you to find the default charset for a given MIME type, which can be useful when setting the 'Content-Type' header in HTTP responses.
const mime = require('mime-types');
const charset = mime.charset('text/markdown'); // 'UTF-8'Content-Type parsing
This feature is used to build a full Content-Type header given a MIME type or extension. It will also append the charset parameter when appropriate.
const mime = require('mime-types');
const contentType = mime.contentType('markdown'); // 'text/markdown; charset=utf-8'The 'mime' package is similar to 'mime-types' and provides MIME type lookup and extension lookup. It differs in that it allows for custom MIME type definitions and has a slightly different API.
The 'file-type' package is used to detect the file type and MIME type of a Buffer/Uint8Array/ArrayBuffer. Unlike 'mime-types', it does not rely on file extensions and can detect the type of binary content.
Readme
The ultimate javascript content-type utility.
$ npm install mime-types
mime-types simply returns false, so do var type = mime.lookup('unrecognized') || 'application/octet-stream'.new Mime() business, so you could do var lookup = require('mime-types').lookup.Otherwise, the API is compatible.
If you'd like to add additional types,
simply create a PR adding the type to custom.json and
a reference link to the sources.
Do NOT edit mime.json or node.json.
Those are pulled using build.js.
You should only touch custom.json.
var mime = require('mime-types')
All functions return false if input is invalid or not found.
Lookup the content-type associated with a file.
mime.lookup('json') // 'application/json'
mime.lookup('.md') // 'text/x-markdown'
mime.lookup('file.html') // 'text/html'
mime.lookup('folder/file.js') // 'application/javascript'
mime.lookup('cats') // false
Create a full content-type header given a content-type or extension.
mime.contentType('markdown') // 'text/x-markdown; charset=utf-8'
mime.contentType('file.json') // 'application/json; charset=utf-8'
Get the default extension for a content-type.
mime.extension('application/octet-stream') // 'bin'
Lookup the implied default charset of a content-type.
mime.charset('text/x-markdown') // 'UTF-8'
A map of content-types by extension.
A map of extensions by content-type.
Globally add definitions.
types must be an object of the form:
{
"<content-type>": [extensions...],
"<content-type>": [extensions...]
}
See the .json files in lib/ for examples.
FAQs
The ultimate javascript content-type utility.
We found that mime-types demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
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.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.
Security News
Socket is joining forces with CISA and other industry leaders at the RSA Conference to sign the Secure by Design pledge, committing to uphold the highest security standards in our products.
Research
The Socket research team breaks down a sampling of malicious packages that download and execute files, among other suspicious behaviors, targeting the popular Discord platform.