http-responder v2.3.1

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.

All you need to do is type into your terminal:

$ npm install --save http-responder

then into your code:

const { HttpResponder } = require('http-responder');

or:

import { HttpResponder } from 'http-responder';

and you're good to go!

To create a custom error: new HttpResponder(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 HttpResponder(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 HttpResponder(); on its own will give you a 500 status error default.)

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

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

Properties:

1. status | statusCode the error's status code.

2. statusDesc | statusText the default description for the given status code (readonly).

3. data | body the included data.

4. 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.

   • log() - a function to console.log the payload - for testing.

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

Methods:

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

end(res: Response) (or send() or json() for compability) to send the response payload back to the client (works in express 4.x).

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

Static methods:

HttpResponder.isHR(res) checks if the res object is of type HttpResponder.

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

Static response methods:

Each function here is used in the same manner: HttpResponder.<functionName>(message: string | undefined, data: any); or HttpResponder.<functionName>(data: any); (in the latter data cannot be of type string - otherwise the data will be inserted into the message param).

A Reminder: when using HttpResponder.noContent(data).end(res); express removes all fields from the response and returns only the status code (204)! So neither the data nor the default description will be returned.

Happy responding! ;)