2.3.0 • Published 7 years ago

httperrors v2.3.0

Weekly downloads
18,055
License
-
Repository
github
Last release
7 years ago

node-httperrors

Exposes HTTP 4xx and 5xx status codes as JavaScript Error objects. The error classes are created using the createError module.

The original use case for httpErrors is to use a custom express error handler that uses the statusCode property of the error instance as the status code for the response, and optionally logs further info from the error.

Installation

Make sure you have node.js and npm installed, then run:

npm install httperrors

Usage

var httpErrors = require('httperrors');

// Instatiate by status code:
var myError = httpErrors(412);

// Instantiate by name (UpperCamelCase):
var err = new httpErrors.NotFound('The thing you were looking for was not found');

console.warn(err.toString()); // NotFound [404]: The thing you were looking for was not found

if (identityCrisis) {
    throw new httpErrors.ImATeapot('Dude...');
}

The CamelCased error name is exposed as a true property on the instances, so your error handling code becomes quite readable (and you can avoid using instanceof):

if (err.NotFound) {
    // ...
} else if (err.BadGateway) {
    // ...
}

You can also create an error by status code (useful when proxying):

function fetchSomething(cb) {
    var request = require('request');
    request('http://example.com/thething', function (err, response) {
        if (err) {
            return cb(new (httpErrors[response.statusCode] || httpErrors.BadGateway)());
        }
        // ...
    });
}

License

3-clause BSD license -- see the LICENSE file for details.