Big update!Announcing Socket for GitHub 1.0. Learn more
Socket
BlogLoveFAQ
Install
Log in

mime

Package Overview
Dependencies
0
Maintainers
1
Versions
46
Issues
File Explorer

Advanced tools

mime

A comprehensive library for mime-type mapping

    3.0.0latest

Version published
Maintainers
1
Weekly downloads
51,244,110
increased by1.17%

Weekly downloads

Changelog

Source

3.0.0 (2021-11-03)

⚠ BREAKING CHANGES

  • drop support for node < 10.x

Bug Fixes

  • skypack.dev for direct browser import, fixes #263 (41db4c0)

update

  • drop support for node < 10.x (8857363)

Readme

Source

Mime

A comprehensive, compact MIME type module.

Build Status

Install

NPM

npm install mime

Browser

It is recommended that you use a bundler such as webpack or browserify to package your code. However, browser-ready versions are available via skypack.dev as follows:

// Full version <script type="module"> import mime from "https://cdn.skypack.dev/mime"; </script> // "lite" version <script type="module"> import mime from "https://cdn.skypack.dev/mime/lite"; </script>

Quick Start

For the full version (800+ MIME types, 1,000+ extensions):

const mime = require('mime'); mime.getType('txt'); //'text/plain' mime.getExtension('text/plain'); //'txt'

See Mime API below for API details.

Lite Version

The "lite" version of this module omits vendor-specific (*/vnd.*) and experimental (*/x-*) types. It weighs in at ~2.5KB, compared to 8KB for the full version. To load the lite version:

const mime = require('mime/lite');

Mime .vs. mime-types .vs. mime-db modules

For those of you wondering about the difference between these [popular] NPM modules, here's a brief rundown ...

mime-db is "the source of truth" for MIME type information. It is not an API. Rather, it is a canonical dataset of mime type definitions pulled from IANA, Apache, NGINX, and custom mappings submitted by the Node.js community.

mime-types is a thin wrapper around mime-db that provides an API drop-in compatible(ish) with mime @ < v1.3.6 API.

mime is, as of v2, a self-contained module bundled with a pre-optimized version of the mime-db dataset. It provides a simplified API with the following characteristics:

  • Intelligently resolved type conflicts (See mime-score for details)
  • Method naming consistent with industry best-practices
  • Compact footprint. E.g. The minified+compressed sizes of the various modules:
ModuleSize
mime-db18 KB
mime-typessame as mime-db
mime8 KB
mime/lite2 KB

Mime API

Both require('mime') and require('mime/lite') return instances of the MIME class, documented below.

Note: Inputs to this API are case-insensitive. Outputs (returned values) will be lowercase.

new Mime(typeMap, ... more maps)

Most users of this module will not need to create Mime instances directly. However if you would like to create custom mappings, you may do so as follows ...

// Require Mime class const Mime = require('mime/Mime'); // Define mime type -> extensions map const typeMap = { 'text/abc': ['abc', 'alpha', 'bet'], 'text/def': ['leppard'] }; // Create and use Mime instance const myMime = new Mime(typeMap); myMime.getType('abc'); // ⇨ 'text/abc' myMime.getExtension('text/def'); // ⇨ 'leppard'

If more than one map argument is provided, each map is define()ed (see below), in order.

mime.getType(pathOrExtension)

Get mime type for the given path or extension. E.g.

mime.getType('js'); //'application/javascript' mime.getType('json'); //'application/json' mime.getType('txt'); //'text/plain' mime.getType('dir/text.txt'); //'text/plain' mime.getType('dir\\text.txt'); //'text/plain' mime.getType('.text.txt'); //'text/plain' mime.getType('.txt'); //'text/plain'

null is returned in cases where an extension is not detected or recognized

mime.getType('foo/txt'); // ⇨ null mime.getType('bogus_type'); // ⇨ null

mime.getExtension(type)

Get extension for the given mime type. Charset options (often included in Content-Type headers) are ignored.

mime.getExtension('text/plain'); // ⇨ 'txt' mime.getExtension('application/json'); // ⇨ 'json' mime.getExtension('text/html; charset=utf8'); // ⇨ 'html'

mime.define(typeMap[, force = false])

Define [more] type mappings.

typeMap is a map of type -> extensions, as documented in new Mime, above.

By default this method will throw an error if you try to map a type to an extension that is already assigned to another type. Passing true for the force argument will suppress this behavior (overriding any previous mapping).

mime.define({'text/x-abc': ['abc', 'abcd']}); mime.getType('abcd'); // ⇨ 'text/x-abc' mime.getExtension('text/x-abc') // ⇨ 'abc'

Command Line

mime [path_or_extension]

E.g.

> mime scripts/jquery.js application/javascript

Markdown generated from src/README_js.md by RunMD Logo

Keywords

FAQs

What is mime?

A comprehensive library for mime-type mapping

Is mime popular?

The npm package mime receives a total of 41,678,439 weekly downloads. As such, mime popularity was classified as popular.

Is mime well maintained?

We found that mime demonstrated a healthy version release cadence and project activity. It has 1 open source maintainer collaborating on the project.

Last updated on 03 Nov 2021
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc