http-errors

Create HTTP error objects

http-errors

Create HTTP errors for Express, Koa, Connect, etc. with ease.

Example

var createError = require('http-errors');
 
app.use(function (req, res, next) {
  if (!req.user) return next(createError(401, 'Please login to view this page.'));
  next();
})

API

This is the current API, currently extracted from Koa and subject to change.

Error Properties

  • message
  • status and statusCode - the status code of the error, defaulting to 500

createError([status], [message], [properties])

var err = createError(404, 'This video does not exist!');
  • status: 500 - the status code as a number
  • message - the message of the error, defaulting to node's text for that status code.
  • properties - custom properties to attach to the object

new createError[code || name]([msg]))

var err = new createError.NotFound();
  • code - the status code as a number
  • name - the name of the error as a "bumpy case", i.e. NotFound or InternalServerError.

License

MIT

Maintainers

Stats

Keywords

http, error

Dependencies (2)

inherits, statuses

Dependents

video-phash-service-client, requisition, fax, serve-index, express-param-objectid, connect-timeout, mgmt-images, http-assert, path-match, customerio, nexus-flux-socket.io, allow-methods, simgr, download-cache, osprey-resources, toa, sinopia-github, csurf, require-header, sinopia, and 10 more.