https://github.com/jshttp/media-typer
Simple RFC 6838 media type parser and formatter
https://github.com/jshttp/media-typer
javascript media mime nodejs type
Last synced: 6 months ago
JSON representation
Simple RFC 6838 media type parser and formatter
- Host: GitHub
- URL: https://github.com/jshttp/media-typer
- Owner: jshttp
- License: mit
- Created: 2014-06-13T18:47:23.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2024-04-29T07:37:56.000Z (over 1 year ago)
- Last Synced: 2025-03-09T13:02:33.044Z (7 months ago)
- Topics: javascript, media, mime, nodejs, type
- Language: JavaScript
- Homepage:
- Size: 85 KB
- Stars: 55
- Watchers: 12
- Forks: 11
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- License: LICENSE
Awesome Lists containing this project
README
# media-typer
[![NPM Version][npm-image]][npm-url]
[![NPM Downloads][downloads-image]][downloads-url]
[![Node.js Version][node-version-image]][node-version-url]
[![Build Status][ci-image]][ci-url]
[![Test Coverage][coveralls-image]][coveralls-url]
Simple RFC 6838 media type parser.
This module will parse a given media type into its component parts, like type,
subtype, and suffix. A formatter is also provided to put them back together and
the two can be combined to normalize media types into a canonical form.
If you are looking to parse the string that represents a media type and its
parameters in HTTP (for example, the `Content-Type` header), use the
[content-type module](https://www.npmjs.com/package/content-type).
## Installation
This is a [Node.js](https://nodejs.org/en/) module available through the
[npm registry](https://www.npmjs.com/). Installation is done using the
[`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally):
```sh
$ npm install media-typer
```
## API
```js
var typer = require('media-typer')
```
### typer.parse(string)
```js
var obj = typer.parse('image/svg+xml')
```
Parse a media type string. This will return an object with the following
properties (examples are shown for the string `'image/svg+xml; charset=utf-8'`):
- `type`: The type of the media type (always lower case). Example: `'image'`
- `subtype`: The subtype of the media type (always lower case). Example: `'svg'`
- `suffix`: The suffix of the media type (always lower case). Example: `'xml'`
If the given type string is invalid, then a `TypeError` is thrown.
### typer.format(obj)
```js
var obj = typer.format({ type: 'image', subtype: 'svg', suffix: 'xml' })
```
Format an object into a media type string. This will return a string of the
mime type for the given object. For the properties of the object, see the
documentation for `typer.parse(string)`.
If any of the given object values are invalid, then a `TypeError` is thrown.
### typer.test(string)
```js
var valid = typer.test('image/svg+xml')
```
Validate a media type string. This will return `true` if the string is a well-
formatted media type, or `false` otherwise.
## License
[MIT](LICENSE)
[ci-image]: https://img.shields.io/github/workflow/status/jshttp/media-typer/ci/master?label=ci
[ci-url]: https://github.com/jshttp/media-typer/actions/workflows/ci.yml
[npm-image]: https://img.shields.io/npm/v/media-typer.svg
[npm-url]: https://npmjs.org/package/media-typer
[node-version-image]: https://img.shields.io/node/v/media-typer.svg
[node-version-url]: https://nodejs.org/en/
[coveralls-image]: https://img.shields.io/coveralls/jshttp/media-typer/master.svg
[coveralls-url]: https://coveralls.io/r/jshttp/media-typer?branch=master
[downloads-image]: https://img.shields.io/npm/dm/media-typer.svg
[downloads-url]: https://npmjs.org/package/media-typer