hapi-boom-decorators

hapi-boom-decorators

A plugin for hapi.js to make responding with boom errors a little less verbose by decorating the reply interface with equivilent functions. This module is tested against the latest versions of Node.js 4, 6 and 7.

Install

npm install hapi-boom-decorators --save

Register Plugin

server.register({
  register: require('hapi-boom-decorators')
}, err => {
  ...
})

API

Standard way of replying with boom response:

server.route({
  method: 'GET',
  path: '/resource/{id}',
  handler: (request, reply) => {
    reply(Boom.notFound())
  }
})

New way:

server.route({
  method: 'GET',
  path: '/resource/{id}',
  handler: (request, reply) => {
    reply.notFound()
  }
})

Check the boom documentation for all available functions. Every 4xx and 5xx error type has been implemented, and the parameters to each function in hapi-boom-decorators are the same as the parameters to the boom function. In addition:

• wrap - reply(Boom.wrap(err, 500, 'a message')) can be written as reply.boom(500, err, 'a message')
• create - reply(Boom.create(500, 'a message', {})) can be written as reply.boom(500, 'a message', {})

Changelog

[2.3.0] - 2017-04-19

Added

• Support for Boom.teapot()