Skip to content

Latest commit

 

History

History
63 lines (44 loc) · 1.87 KB

README.md

File metadata and controls

63 lines (44 loc) · 1.87 KB

Crashpad

Express middleware for [Boom][boom] errors

NPM version Build Status MIT License

Usage

Install this middleware and stop explicitly responding with errors from your application code!

npm install crashpad
var crashpad = require('crashpad');
var Boom = require('boom');

app.get('/error', function(req, res, next) {
  throw Boom.expectationFailed();
});

app.use(crashpad());

Crashpad will handle:

  • Errors created by the Boom module. ([See Boom documentation for a list of these][boom].)
  • Error objects that have an integer "status" or "statusCode" attribute.
  • Generic error objects (will respond with 500).

Right now Crashpad just sends back JSON payloads. Eventually, we'll have support for fancy rendered error pages! If you need something like that now, check out express-error-handler.

Contributing

Please follow our Code of Conduct when contributing to this project.

$ git clone https://github.com/goodeggs/crashpad && cd crashpad
$ yarn install
$ yarn test

Releasing

To release a new version of this module, use yarn to bump the version in package.json and create a git tag, then push. This will automatically get published to the NPM registry via CI.

yarn version --new-version=<major|minor|patch|premajor|preminor|prepatch>
git push --follow-tags