Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tinyhttp/mime-types
`mime-types` rewrite in TypeScript compiled to ESM
https://github.com/tinyhttp/mime-types
esm node-js nodejs
Last synced: 3 months ago
JSON representation
`mime-types` rewrite in TypeScript compiled to ESM
- Host: GitHub
- URL: https://github.com/tinyhttp/mime-types
- Owner: tinyhttp
- License: mit
- Created: 2020-07-12T19:19:02.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-10-23T09:36:14.000Z (over 3 years ago)
- Last Synced: 2024-08-09T05:06:12.983Z (6 months ago)
- Topics: esm, node-js, nodejs
- Language: TypeScript
- Homepage:
- Size: 88.9 KB
- Stars: 8
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-list - es-mime-types - types` rewrite in TypeScript compiled to ESM | talentlessguy | 8 | (TypeScript)
README
# es-mime-types
![Top language][top-lang-image]
![Vulnerabilities][snyk-image]
[![Version][npm-v-image]][npm-url]
[![Node Version][node-version-image]][node-version-url]
![Last commit][last-commit-image]
> [`mime-types`](https://github.com/jshttp/mime-types) rewrite in TypeScript compiled to ESM
The ultimate javascript content-type utility.
Similar to [the `[email protected]` module](https://www.npmjs.com/package/mime), except:
- **No fallbacks.** Instead of naively returning the first available type,
`mime-types` simply returns `false`, so do
`const type = mime.lookup('unrecognized') || 'application/octet-stream'`.
- No `new Mime()` business, so you could do `var lookup = require('mime-types').lookup`.
- No `.define()` functionality
- Bug fixes for `.lookup(path)`
Otherwise, the API is compatible with `mime` 1.x.
## Install
```sh
pnpm i es-mime-types
```
## Adding Types
All mime types are based on [mime-db](https://www.npmjs.com/package/mime-db),
so open a PR there if you'd like to add mime types.
## API
```ts
import { lookup, contentType, extension, charset, types } from 'es-mime-types'
```
All functions return `false` if input is invalid or not found.
### `lookup(path)`
Lookup the content-type associated with a file.
```ts
lookup('json') // 'application/json'
lookup('.md') // 'text/markdown'
lookup('file.html') // 'text/html'
lookup('folder/file.js') // 'application/javascript'
lookup('folder/.htaccess') // false
lookup('cats') // false
```
### `contentType(type)`
Create a full content-type header given a content-type or extension.
When given an extension, `lookup` is used to get the matching
content-type, otherwise the given content-type is used. Then if the
content-type does not already have a `charset` parameter, `charset`
is used to get the default charset and add to the returned content-type.
```ts
contentType('markdown') // 'text/x-markdown; charset=utf-8'
contentType('file.json') // 'application/json; charset=utf-8'
contentType('text/html') // 'text/html; charset=utf-8'
contentType('text/html; charset=iso-8859-1') // 'text/html; charset=iso-8859-1'
// from a full path
contentType(path.extname('/path/to/file.json')) // 'application/json; charset=utf-8'
```
### `extension(type)`
Get the default extension for a content-type.
```ts
extension('application/octet-stream') // 'bin'
```
### `charset(type)`
Lookup the implied default charset of a content-type.
```ts
charset('text/markdown') // 'UTF-8'
```
### `types[extension]`
A map of extensions by content-type.
## License
MIT © [v1rtl](https://v1rtl.site)
[node-version-image]: https://img.shields.io/node/v/es-mime-types.svg?style=flat-square
[node-version-url]: https://nodejs.org
[top-lang-image]: https://img.shields.io/github/languages/top/talentlessguy/es-mime-types.svg?style=flat-square
[snyk-image]: https://img.shields.io/snyk/vulnerabilities/npm/es-mime-types.svg?style=flat-square
[npm-v-image]: https://img.shields.io/npm/v/es-mime-types.svg?style=flat-square
[npm-url]: https://www.npmjs.com/package/es-mime-types
[last-commit-image]: https://img.shields.io/github/last-commit/talentlessguy/es-mime-types.svg?style=flat-square