http-errors

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

Install

This is a Node.js module available through the
npm registry. Installation is done using the
npm install command:

$ npm install http-errors

Example

var createError = require('http-errors')
var express = require('express')
var app = express()

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.

All errors inherit from JavaScript Error and the exported createError.HttpError.

Error Properties

• expose - can be used to signal if message should be sent to the client,
  defaulting to false when status >= 500
• headers - can be an object of header names to values to be sent to the
  client, defaulting to undefined. When defined, the key names should all
  be lower-cased
• message - the traditional error message, which should be kept short and all
  single line
• status - the status code of the error, mirroring statusCode for general
  compatibility
• 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.

List of all constructors

License

MIT