type-is

Infer the content-type of a request.

Install

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

1$ npm install type-is

API

1var http = require('http')
2var typeis = require('type-is')
3
4http.createServer(function (req, res) {
5  var istext = typeis(req, ['text/*'])
6  res.end('you ' + (istext ? 'sent' : 'did not send') + ' me text')
7})

typeis(request, types)

Checks if the request is one of the types. If the request has no body, even if there is a Content-Type header, then null is returned. If the Content-Type header is invalid or does not matches any of the types, then false is returned. Otherwise, a string of the type that matched is returned.

The request argument is expected to be a Node.js HTTP request. The types argument is an array of type strings.

Each type in the types array can be one of the following:

• A file extension name such as json. This name will be returned if matched.
• A mime type such as application/json.
• A mime type with a wildcard such as */* or */json or application/*. The full mime type will be returned if matched.
• A suffix such as +json. This can be combined with a wildcard such as */vnd+json or application/*+json. The full mime type will be returned if matched.

Some examples to illustrate the inputs and returned value:

1// req.headers.content-type = 'application/json'
2
3typeis(req, ['json']) // => 'json'
4typeis(req, ['html', 'json']) // => 'json'
5typeis(req, ['application/*']) // => 'application/json'
6typeis(req, ['application/json']) // => 'application/json'
7
8typeis(req, ['html']) // => false

typeis.hasBody(request)

Returns a Boolean if the given request has a body, regardless of the Content-Type header.

Having a body has no relation to how large the body is (it may be 0 bytes). This is similar to how file existence works. If a body does exist, then this indicates that there is data to read from the Node.js request stream.

1if (typeis.hasBody(req)) {
2  // read the body, since there is one
3
4  req.on('data', function (chunk) {
5    // ...
6  })
7}

typeis.is(mediaType, types)

Checks if the mediaType is one of the types. If the mediaType is invalid or does not matches any of the types, then false is returned. Otherwise, a string of the type that matched is returned.

The mediaType argument is expected to be a media type string. The types argument is an array of type strings.

Each type in the types array can be one of the following:

• A file extension name such as json. This name will be returned if matched.
• A mime type such as application/json.
• A mime type with a wildcard such as */* or */json or application/*. The full mime type will be returned if matched.
• A suffix such as +json. This can be combined with a wildcard such as */vnd+json or application/*+json. The full mime type will be returned if matched.

Some examples to illustrate the inputs and returned value:

1var mediaType = 'application/json'
2
3typeis.is(mediaType, ['json']) // => 'json'
4typeis.is(mediaType, ['html', 'json']) // => 'json'
5typeis.is(mediaType, ['application/*']) // => 'application/json'
6typeis.is(mediaType, ['application/json']) // => 'application/json'
7
8typeis.is(mediaType, ['html']) // => false

typeis.match(expected, actual)

Match the type string expected with actual, taking in to account wildcards. A wildcard can only be in the type of the subtype part of a media type and only in the expected value (as actual should be the real media type to match). A suffix can still be included even with a wildcard subtype. If an input is malformed, false will be returned.

1typeis.match('text/html', 'text/html') // => true
2typeis.match('*/html', 'text/html') // => true
3typeis.match('text/*', 'text/html') // => true
4typeis.match('*/*', 'text/html') // => true
5typeis.match('*/*+json', 'application/x-custom+json') // => true

typeis.normalize(type)

Normalize a type string. This works by performing the following:

• If the type is not a string, false is returned.
• If the string starts with + (so it is a +suffix shorthand like +json), then it is expanded to contain the complete wildcard notation of */*+suffix.
• If the string contains a /, then it is returned as the type.
• Else the string is assumed to be a file extension and the mapped media type is returned, or false is there is no mapping.

This includes two special mappings:

• 'multipart' -> 'multipart/*'
• 'urlencoded' -> 'application/x-www-form-urlencoded'

Examples

Example body parser

1var express = require('express')
2var typeis = require('type-is')
3
4var app = express()
5
6app.use(function bodyParser (req, res, next) {
7  if (!typeis.hasBody(req)) {
8    return next()
9  }
10
11  switch (typeis(req, ['urlencoded', 'json', 'multipart'])) {
12    case 'urlencoded':
13      // parse urlencoded body
14      throw new Error('implement urlencoded body parsing')
15    case 'json':
16      // parse json body
17      throw new Error('implement json body parsing')
18    case 'multipart':
19      // parse multipart body
20      throw new Error('implement multipart body parsing')
21    default:
22      // 415 error code
23      res.statusCode = 415
24      res.end()
25      break
26  }
27})

License

MIT