onbjerg / micro-boom

Wraps errors in micro with Boom

micro-boom

Wraps errors in micro services Boom errors.

Example Responses

{
  "error": "Unauthorized", 
  "message": "Not authenticated", 
  "statusCode": 401
}

{
  "data": {
    "reason": "Username is wrong"
  }, 
  "error": "Unauthorized", 
  "message": "Not authenticated", 
  "statusCode": 401
}

---

Installation

npm install --save micro-boom

Or even better

yarn add micro-boom

Import and Usage Example

const { handleErrors, createError } = require('micro-boom')

module.exports = handleErrors(async function (req, res) {
  throw createError(401, 'Not authenticated', {
    reason: 'Bad password'
  })
})

API

handleErrors

Catches error from an async function, wraps them in a Boom error object and generates a JSON response.

The status code of an error is determined by three factors, in order:

• Status code is set to err.output.statusCode
• If not set, error is inferred from res.statusCode
• Default to HTTP 500 (also defaults to HTTP 500 if status is < 400)

🚨 TAKE NOTE 🚨
All HTTP 500 errors have their user provided message removed for security reasons.

Parameters

• fn Function Async function, your normal micro logic.
• dump Boolean Optional. Dumps err.stack to stderr if true

Examples

const { handleErrors } = require('micro-boom')

// Returns HTTP 500
module.exports = handleErrors(async function (req, res) {
  throw Error('Uh-oh, something bad happened.')
})

const { handleErrors } = require('micro-boom')

// Returns HTTP 401
module.exports = handleErrors(async function (req, res) {
  res.statusCode = 401
  throw Error('Unauthorized')
})

Returns an async Function.

createError

Alias for Boom#create(statusCode, [message], [data]).

Parameters

• statusCode Number HTTP status code, must be >= 400
• message String An optional error message.
• data [Any] Some optional error metadata, serialized with JSON.stringify.

Examples

const { handleErrors, createError } = require('micro-boom')

// Message defaults to what corresponds to the HTTP error code
module.exports = handleErrors(async function (req, res) {
  throw createError(500)
})

const { handleErrors, createError } = require('micro-boom')

// HTTP 401: Unauthorized
module.exports = handleErrors(async function (req, res) {
  throw createError(401, 'Unauthorized')
})

const { handleErrors, createError } = require('micro-boom')

// HTTP 401: Unauthorized with metadata,
// set in `.data` of the response.
module.exports = handleErrors(async function (req, res) {
  throw createError(401, 'Unauthorized', {
    reason: 'Bad password',
    foo: 'bar'
  })
})

Returns an async Function.

micro-boom's Issues

Update to newest `micro`

I haven't maintained this for a while, so I'm not sure how out of sync this repository is with micro

Replace `ava` with `tape`

No reason to use ava here.

Update Boom

Boom is 3 majors behind at the moment. The only change I've noted so far is that Boom.wrap is not Boom.boomify.

Working branch is greenkeeper/boom-7.2.1

An in-range update of boom is breaking the build 🚨

Version 4.3.0 of boom just got published.

Branch	Build failing 🚨
Dependency	boom
Current Version	4.2.0
Type	dependency

This version is covered by your current version range and after updating it in your project the build failed.

As boom is a direct dependency of this project this is very likely breaking your project right now. If other packages depend on you it’s very likely also breaking them.
I recommend you give this issue a very high priority. I’m sure you can resolve this 💪

---

Status Details

• ❌ continuous-integration/travis-ci/push The Travis CI build failed Details

Commits

The new version differs by 8 commits .

• cd6790e Cleanup for #139
• c803162 Adds support for Boom.someMethod(err), closes #138 (#139)
• 3aa4a8c Assert on extra arguments to wrap(). Closes #142
• 116ba7d Add Boom.teapot() method with documentation and tests (#78)
• 648acb1 Unauthorized extension for #146 (#147)
• 3896337 Update .travis.yml
• 78f64eb Fixed link in contributing doc (#137)
• dfde618 Remove duplicate test (#134)

See the full diff.

Not sure how things should work exactly?

There is a collection of frequently asked questions and of course you may always ask my humans.

---

Your Greenkeeper Bot 🌴

Update `standard` to the latest version

Remember to ensure that the lint still passes!