https://github.com/lukeed/mrmime
A tiny (2.8kB) and fast utility for getting a MIME type from an extension or filename
https://github.com/lukeed/mrmime
Last synced: 10 months ago
JSON representation
A tiny (2.8kB) and fast utility for getting a MIME type from an extension or filename
- Host: GitHub
- URL: https://github.com/lukeed/mrmime
- Owner: lukeed
- License: mit
- Created: 2021-10-12T06:47:41.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2025-02-17T18:17:03.000Z (over 1 year ago)
- Last Synced: 2025-10-06T03:05:30.083Z (10 months ago)
- Language: TypeScript
- Homepage:
- Size: 119 KB
- Stars: 328
- Watchers: 4
- Forks: 8
- Open Issues: 3
-
Metadata Files:
- Readme: readme.md
- Funding: .github/FUNDING.yml
- License: license
Awesome Lists containing this project
README
A tiny (2.8kB) and fast utility for getting a MIME type from an extension or filename
## Features
* Lightweight – 2.8kB gzip
_Only includes standard mime types; all experimental and vendor-specific mimetypes removed._
* [Performant](#benchmarks)
_All lookups are O(1) with minimal processing._
* Comprehensive Dictionary
_Generated from [`mime-db`](https://github.com/jshttp/mime-db), which aggregates the IANA, NGINX, and Apache datasets._
* Customizable
_Exposes the `mimes` dictionary for easy additions or overrides._
* Supports Native ESM and [Deno](https://deno.land/x/mrmime)
_Ships with CommonJS and ESM support!_
## Install
```
$ npm install --save mrmime
```
## Usage
```js
import { lookup, mimes } from 'mrmime';
// Get a MIME type
// ---
lookup('txt'); //=> "text/plain"
lookup('.txt'); //=> "text/plain"
lookup('a.txt'); //=> "text/plain"
// Unknown extension
// ---
lookup('.xyz'); //=> undefined
// Add extension to dictionary
// ---
mimes['xyz'] = 'hello/world';
lookup('xyz'); //=> "hello/world"
```
## API
### lookup(input)
Returns: `string` or `undefined`
#### input
Type: `string`
The extension or filename to lookup.
> **Important:**
> * Any `input` value is cast to string, lowercased, and trimmed.
> * If a filename or filepath is provided, only the extension will be used.
## Benchmarks
> Running on Node v16.8.0
```
Load times:
mrmime 0.963ms
mime/lite 3.281ms
mime 6.751ms
Benchmark :: plain ("ext")
mime x 598,849 ops/sec ±0.28% (94 runs sampled)
mime/lite x 536,643 ops/sec ±0.11% (97 runs sampled)
mrmime x 835,885 ops/sec ±0.20% (97 runs sampled)
Benchmark :: leading (".ext")
mime x 368,656 ops/sec ±0.19% (99 runs sampled)
mime/lite x 368,318 ops/sec ±0.13% (97 runs sampled)
mrmime x 533,643 ops/sec ±0.10% (96 runs sampled)
Benchmark :: filename ("file.ext")
mime x 326,907 ops/sec ±0.17% (95 runs sampled)
mime/lite x 327,479 ops/sec ±0.12% (98 runs sampled)
mrmime x 512,823 ops/sec ±0.12% (99 runs sampled)
```
## Credits
Of course, a thank-you to [`mime`](https://github.com/broofa/mime) serving the community all these years & for being a all-encompassing MIME type library. I've only ever needed lookup/`getType` functionality – and now ESM support – so `mrmime` can only ever support 1/3 of what `mime` offers, at best.
This would not be possible without the team behind [`mime-db`](https://github.com/jshttp/mime-db), who have painstakingly maintained an amazing database for 7+ years.
Artwork created by [mintinol](https://www.deviantart.com/mintinol), which I found [here](https://www.deviantart.com/mintinol/art/Mr-Mime-373927920).
Finally, thanks to [Tim Branyen](https://github.com/tbranyen) for donating the package name :)
## License
MIT © [Luke Edwards](https://lukeed.com)