error-objects v1.2.0

HTTP-friendly error objects

hapijs/boom for browsers. Supports all modern browsers, tested on IE 9+, Chrome 16+, FireFox 5+, Safari 6+, Opera 12+.

error-objects

error-objects provides a set of utilities for returning errors. Each utility returns error response object (instance of Error) which includes the following properties:

• isBoom - if true, indicates this is a errorObjects instance.
• isServer - convenience bool indicating status code >= 500.
• message - the error message.
• output - the formatted response. Can be directly manipulated after object construction to return a custom error response. Allowed root keys:
  • statusCode - the HTTP status code (typically 4xx or 5xx).
  • headers - an object containing any HTTP headers where each key is a header name and value is the header content.
  • payload - the formatted object used as the response payload (stringified). Can be directly manipulated but any changes will be lost if reformat() is called. Any content allowed and by default includes the following content:
    • statusCode - the HTTP status code, derived from error.output.statusCode.
    • error - the HTTP status message (e.g. 'Bad Request', 'Internal Server Error') derived from statusCode.
    • message - the error message derived from error.message.
• reformat() - rebuilds error.output using the other object properties.
• inherited Error properties.

wrap(error, [statusCode], [message])

Decorates an error with the errorObjects properties where:

• error - the error object to wrap. If error is already a errorObjects object, returns back the same object.
• statusCode - optional HTTP status code. Defaults to 500.
• message - optional message string. If the error already has a message, it adds the message as a prefix. Defaults to no message.

var error = new Error('Unexpected input');
errorObjects.wrap(error, 400);

create(statusCode, [message], [data])

Generates an Error object with the errorObjects decorations where:

• statusCode - an HTTP error code number. Must be greater or equal 400.
• message - optional message string.
• data - additional error data set to error.data property.

var error = errorObjects.create(400, 'Bad request', { timestamp: Date.now() });

Thanks

Thanks to Eran Hammer and @hapijs community for the quality engineering behind hapi.