sfcode An Online Competing and Development Environment

media-typer

Simple RFC 6838 media type parser

# Installation

$ npm install media-typer

# API

var typer = require('media-typer')

## typer.parse(string)

var obj = typer.parse('image/svg+xml; charset=utf-8')

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’`
- `parameters`: An object of the parameters in the media type (name of parameter always lower case). Example: ‘{charset: 'utf-8’}`

## typer.parse(req)

var obj = typer.parse(req)

Parse the `content-type` header from the given `req`. Short-cut for ‘typer.parse(req.headers['content-type’])`.

## typer.parse(res)

var obj = typer.parse(res)

Parse the `content-type` header set on the given `res`. Short-cut for ‘typer.parse(res.getHeader('content-type’))`.

## 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)`.

# License

[MIT](LICENSE)