api-error-handler icon indicating copy to clipboard operation
api-error-handler copied to clipboard

Express error handlers for JSON APIs

api-error-handler

NPM version Build status Test coverage Dependency Status License Downloads Gittip

An error handler for JSON APIs, meant to be used with http-errors-style errors.

Example

var errorHandler = require('api-error-handler');

var api = new express.Router();
api.get('/users/:userid', function (req, res, next) {

});

api.use(errorHandler());

app.use('/api', api);

API

.use(errorHandler([options]))

Currently no options.

Errors

4xx errors are exposed to the client. Properties exposed are:

  • message
  • type
  • name
  • code
  • status

5xx errors are not exposed to the client. Instead, they are given a generic message as well as the type.