Error subclasses for returning HTTP errors. 

Error subclasses for returning HTTP errors

carsondarling

restdevices

node-http-error

// Use lazy loading of the HTTP module only if we need to look up status codes

var HTTPError = module.exports = function HTTPError(status, message) {

var HTTPError = module.exports = function HTTPError(status, message, properties) {

  // Make sure we're using the 'new' keyword

  if (!(this instanceof HTTPError)) return new HTTPError(status, message);

  // Do the argument shuffle. If a status code is given but no message, look up

  // the message from the Node.js HTTP module

    if (typeof message === 'undefined') {

      if (!http) { http = require('http'); }

      message = http.STATUS_CODES[status];

  Error.captureStackTrace(this, this.constructor);

HTTPError.prototype.toString = function() {

  return this.name + ': ' + this.status + ' ' + this.message;

  "description": "Error subclasses for returning HTTP errors",

  "author": "Carson Darling <carsondarling@gmail.com>",

    "url": "https://github.com/carsondarling/node-http-error"

Ever wanted to build an API with Node and constantly had to either use blocks to return errors so you could attach a status code, or you just use one type of status code for all errors? Now you can throw your errors in just one line.

[![Build Status](https://travis-ci.org/carsondarling/node-http-error.svg?branch=master)](https://travis-ci.org/carsondarling/node-http-errors)

var HTTPError = require('node-http-error');

app.get('/error', function(req, req, next) {

  return next(new HTTPError(500, 'Error by design.'));

Content-Type: application/json; charset=utf-8

- Treat it just like `Error`. `HTTPError`'s are throwable, have full stacktrace, and even print out their status code when they're thrown.

- Don't worry about accidentally forgetting the `new` operator, HTTPError works without it.

- Give it just the HTTP status code you want to return, and the error message is automatically generated.

#### `HTTPError(status, message, properties)`

Creates an error with the given status, message and properties. For example

       new HTTPError(404, 'Not found!', { path: '/something-missing' })

Creates an error message with the given status and message.

Creates an error message with the message and `500` as the status code (Internal Server Error).

Creates an error message with the given status. The error message is looked up from the default Node HTTP module. For example, `HTTPError(404)` is equivalent to `HTTPError(400, 'Not Found')`.

The Node HTTP module is not loaded unless needed to lookup the error message.

      throw new HTTPError(404, 'Not found')

  it('should be an instance of Error', function() {

    var err = new HTTPError(404, 'Not found!');

  it('should be safe without the new operator', function() {

    (err instanceof HTTPError).should.be.true;

  it('should have the correct message', function() {

    err.message.should.eql('Not found!');

  it('should have the correct status code', function() {

  it('should allow just a message', function() {

  it('should allow just a status code', function() {

  it('should look up the correct status codes', function() {

    var codes = Object.keys(http.STATUS_CODES);

    codes = codes.map(function(code) { return parseInt(code) });

      err.message.should.eql(http.STATUS_CODES[codes[i]]);

  it('should allow extra error properties', function() {

    var err = new HTTPError(404, 'Not found!', { path: '/something-missing' });

    err.should.have.property('status', 404);

    err.should.have.property('message', 'Not found!');

    err.should.have.property('path', '/something-missing');

		@@ -7,3 +7,3 @@ var util = require('util');

		var HTTPError = module.exports = function HTTPError(status, message) {
		var HTTPError = module.exports = function HTTPError(status, message, properties) {
		// Make sure we're using the 'new' keyword
		@@ -31,2 +31,3 @@ if (!(this instanceof HTTPError)) return new HTTPError(status, message);
		this.message = message \|\| '';
		util._extend(this, properties);
		};
		@@ -33,0 +34,0 @@

		{
		"name": "node-http-error",
		"version": "0.2.0",
		"version": "1.0.0",
		"description": "Error subclasses for returning HTTP errors",
		@@ -5,0 +5,0 @@ "main": "index.js",

		@@ -21,3 +21,3 @@ # Pretty HTTP Errors for Node
		app.use(function(err, req, res, next) {
		res.status(err.code);
		res.status(err.status);
		res.send(err.message);
		@@ -48,5 +48,11 @@ });
		- Give it just the HTTP status code you want to return, and the error message is automatically generated.
		- Assign extra properties to the error.

		## Usage

		#### `HTTPError(status, message, properties)`
		Creates an error with the given status, message and properties. For example

		new HTTPError(404, 'Not found!', { path: '/something-missing' })

		#### `HTTPError(status, message)`
		@@ -53,0 +59,0 @@ Creates an error message with the given status and message.

Fixed alerts

Improved metrics

		@@ -55,2 +55,9 @@ var HTTPError = require('../');

		});
		it('should allow extra error properties', function() {
		var err = new HTTPError(404, 'Not found!', { path: '/something-missing' });
		err.should.have.property('status', 404);
		err.should.have.property('message', 'Not found!');
		err.should.have.property('path', '/something-missing');
		});

		});