https://github.com/stringparser/mimext
mime type to extension and the reverse map
https://github.com/stringparser/mimext
Last synced: 11 months ago
JSON representation
mime type to extension and the reverse map
- Host: GitHub
- URL: https://github.com/stringparser/mimext
- Owner: stringparser
- Created: 2015-07-28T17:29:59.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2017-02-12T11:30:55.000Z (almost 9 years ago)
- Last Synced: 2025-02-09T08:16:09.438Z (12 months ago)
- Language: JavaScript
- Homepage:
- Size: 17.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# mimext [![NPM version][badge-version]][x-npm] [![downloads][badge-downloads]][x-npm]
[documentation](#documentation) -
[install](#install) -
[test](#test)
[![build][badge-build]][x-travis]
## sample
```js
var mimext = require('mimext');
console.log('%s %s %s\n%j\n',
mimext('js'),
mimext('.json'),
mimext('file.coffee'),
mimext('text/coffeescript'),
mimext(mimext('filename.mp3'))
);
// application/javascript application/json text/coffeescript
// {"extensions":["coffee","litcoffee"]}
// { source: 'iana',
// compressible: false,
// extensions: [ 'mpga', 'mp2', 'mp2a', 'mp3', 'm2a', 'm3a' ] }
```
## documentation
The `module.exports` a function
### mimext
```js
function mimext(string|object input)
```
_arguments_
- `input`, type string or object to check
_when_
- `input` is an object, it should have a property `extensions` with an array of the extensions for that mime type. Look at [mime-db](https://github.com/jshttp/mime-db) for more information.
- `input` is a string, can have a dot. If has a slash it will be mapped to a mime type directly
_returns_
- mime type of for the string|object given
- properties of the mime type given as string
### mimext properties
- `mimext.mimes` all mime types given by [mime-db][x-mimeDB]
- `mimext.extnames` the inverse mapping from extension to mime type
## install
With [npm][x-npm]
$ npm install mimext
## test
```sh
$ npm t
ext
✓ should map extension (no dot) to mimeType
✓ should map extension (with dot) to mimeType
filenames
✓ should map filename to mimeType
mime
✓ should map mimeType to its specs
✓ should map mimeType to extensions
5 passing (14ms)
```
### license
The MIT License (MIT)
Copyright (c) 2015-present Javier Carrillo
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
[x-npm]: https://npmjs.org/package/mimext
[x-mimeDB]: https://github.com/jshttp/mime-db
[x-travis]: https://travis-ci.org/stringparser/mimext/builds
[badge-build]: http://img.shields.io/travis/stringparser/mimext/master.svg?style=flat-square
[badge-version]: http://img.shields.io/npm/v/mimext.svg?style=flat-square
[badge-downloads]: http://img.shields.io/npm/dm/mimext.svg?style=flat-square