@fastify/accepts

Add an accepts parser to Fastify.

Install

npm i @fastify/accepts

Compatibility

Plugin version	Fastify version
^5.x	^5.x
^4.x	^4.x
^2.x	^3.x
^1.x	^2.x
^1.x	^1.x

Please note that if a Fastify version is out of support, then so are the corresponding version(s) of this plugin in the table above. See Fastify's LTS policy for more details.

Usage

1const fastify = require('fastify')
2const Boom = require('@hapi/boom')
3
4fastify.register(require('@fastify/accepts'))
5
6fastify.post('/', function (req, reply) {
7  const accept = req.accepts() // Accepts object
8  switch(accept.type(['json', 'html'])) {
9    case 'json':
10      reply.type('application/json').send({hello: 'world'})
11      break
12    case 'html':
13      reply.type('text/html').send('<b>hello, world!</b>')
14      break
15    default:
16      reply.send(Boom.notAcceptable('unacceptable'))
17      break
18  }
19})

See accepts package for all available APIs.

This plugin adds to Request object all Accepts object methods.

1fastify.post('/', function (req, reply) {
2  req.charset(['utf-8'])
3  req.charsets()
4  req.encoding(['gzip', 'compress'])
5  req.encodings()
6  req.language(['es', 'en'])
7  req.languages()
8  req.type(['image/png', 'image/tiff'])
9  req.types()
10})

Options

• decorateReply If true, the Reply object will be decorated with the requestAccepts, requestTypes, requestCharsets, requestEncodings, and requestLanguages methods, which will return the corresponding values from the Request object. Default: false.

License

Licensed under MIT.