HTTP Responder

A simple and easy way to create and use HTTP errors (extending the original Node.js Error) whilst giving you the control over what is seen. Also, it is traspiled to ECMAScript 2015, so nearly anyone can use it.

Type into your terminal:

$ npm install --save http-responder

then into your code:

const hr = require('http-responder');

and you're good to go!

To create a custom error: new hr(statusCode [, optionsOrError]);

1. statusCode: number your error's status code or an error message.

2. optionsOrError: Error | {} the options object may be a nodejs error, or include:

   1. message: string your custom error message.

   2. data: any whatever data you what to send (also shows up in the payload property) - has to be truthy.

Also, you can choose to use: new hr(message [, options]);

1. message: string your custom error message.

2. options: {} the options object may include:

   1. statusCode: number the error's status code (you can use status instead).

   2. data: any whatever data you what to send (also shows up in the payload property) - has to be truthy!

(new hr(); on its own will give you a 500 status error default.)

Or, you can create them by the pre-made static functions (hr.notFound() for example) - a full list below.

And then your imagination is the limit, i.e.: hr.notFound().end(res); (only in express 4.x).

Porperties:

1. status the same as 'statusCode' - for backwards compability.

2. statusDesc the default description for the given status code.

3. payload holds only a pretty version of the error (i.e., no stack), so no sensitive information will be leaked, including:

   • statusCode - the original status code.

   • statusDesc - the default status description.

   • message - the given message.

   • data - the given data.

4. All other Node.js's Error object properties.

Methods:

appendError(error: Error) to append an Error to your custom one.

end(res: Response) to send the response back to the client (works in express 4.x).

log() to console.log you object - for testing.

logPayload() to console.log you object's payload - for testing.

Static functions:

hr.isHR(res) checks if the res object is of type http-response.

hr.improve(err) creates a new HttpResponder based on the err: Error param (with a status code of 500 unless different in the err object).

Static response functions: