Skip to content
Simple RFC 6838 media type parser and formatter
JavaScript
Branch: master
Clone or download

Latest commit

Latest commit 1332b73 Apr 25, 2019

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
test Add test(string) function Apr 24, 2019
.eslintignore build: use nyc for coverage testing Oct 15, 2018
.eslintrc.yml build: use yaml eslint configuration Jul 26, 2018
.gitignore build: use nyc for coverage testing Oct 15, 2018
.travis.yml build: support Node.js 12.x Apr 24, 2019
HISTORY.md 1.1.0 Apr 25, 2019
LICENSE docs: update copyright year Mar 20, 2017
README.md Add test(string) function Apr 24, 2019
index.js Add test(string) function Apr 24, 2019
package.json 1.1.0 Apr 25, 2019

README.md

media-typer

NPM Version NPM Downloads Node.js Version Build Status Test Coverage

Simple RFC 6838 media type parser.

This module will parse a given media type into it's 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 it's parameters in HTTP (for example, the Content-Type header), use the content-type module.

Installation

This is a Node.js module available through the npm registry. Installation is done using the npm install command:

$ npm install media-typer

API

var typer = require('media-typer')

typer.parse(string)

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)

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)

var valid = typer.test('image/svg+xml')

Validate a media type string. This will return true is the string is a well- formatted media type, or false otherwise.

License

MIT

You can’t perform that action at this time.