verdaccio/node_modules/http-errors
Alex Kocharin 1cb1e91ca1 update deps 2014-10-02 18:07:01 +04:00
..
node_modules update deps 2014-10-02 18:07:01 +04:00
LICENSE importing all bundled deps to git 2014-09-14 18:28:17 +04:00
README.md update deps 2014-09-25 05:10:00 +04:00
index.js update deps 2014-09-25 05:10:00 +04:00
package.json update deps 2014-10-02 18:07:01 +04:00

README.md

http-errors

NPM Version NPM Downloads Node.js Version Build Status Test Coverage

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