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:
API
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
orapplication/*
. 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
orapplication/*+json
. The full mime type will be returned if matched.
Some examples to illustrate the inputs and returned value:
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.
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
orapplication/*
. 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
orapplication/*+json
. The full mime type will be returned if matched.
Some examples to illustrate the inputs and returned value:
Examples
Example body parser
License
Last updated