conglomerate-error v1.0.3

conglomerate-error

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

Thanks

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

Thanks to Sauce Labs for providing the infrastructure that allows us to run our build in real browsers.

Documentation

create

src/index.js:91-93

Generates an Error object with decorations where:

Parameters

• statusCode Number an HTTP error code number. Must be greater or equal 400.
• message String= message string.
• data Object= additional error data set to error.data property.

Returns Error error

Error

src/index.js:197-217

Extends Error

A decorated error object (instance of Error) which includes the following properties:

Properties

• isError boolean if true, indicates this is a decorated Error object instance.
• isServer boolean convenience bool indicating status code >= 500.
• message string the error message
• output object the formatted response. Can be directly manipulated after object construction to return a custom error response.
  • output.statusCode number the HTTP status code (typically 4xx or 5xx).
  • output.headers object an object containing any HTTP headers where each key is a header name and value is the header content.
  • output.payload object the formatted object used as the response payload (stringified). Can be directly manipulated but any changes will be lost if reformat() is called.
    • output.payload.statusCode number the HTTP status code
    • output.payload.error string the HTTP status message (e.g. 'Bad Request', 'Internal Server Error')
    • output.payload.message string the error message
• reformat function rebuilds error.output.

warning

src/index.js:197-217

Prints a warning in the console if it exists.

Parameters

• message String The warning message.

Returns void

wrap

src/index.js:77-80

Decorates an error with the properties where:

Parameters

• error Error object to wrap. If error is already a decorated, returns back the same object.
• statusCode Number= optional HTTP status code (optional, default 500)
• message String= If the error already has a message, it adds the message as a prefix (optional, default '')

Returns Error error

License

conglomerate-error is released under the terms of the BSD-3-Clause license.