api-error-handler

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]))

Returns middleware that handle errors.

Options

The errorHandler function takes an option options object that may contain any of the following keys:

log

The log option, if supplied, is called as log(err, req, res) when errors with status 500 and above occur.

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.