super-stack v0.0.0

Error wrapping in Javascript.

Getting Started

NPM

npm install super-stack --save

var superStack = require('super-stack');

superStack.attachToErrorPrototype();

try {
    someAction()
} catch (err) {
    throw new RangeError('Object mode!').wrap(err);
}

Bower

bower install super-stack --save

<script type="text/javascript" src="bower_components/super-stack.min.js"></script>
<script type="text/javascript">
    try {
        someAction()
    } catch (err) {
        throw superStack.wrap(new TypeError('Wrap away!'), err);
    }

</script>

Browser

<script type="text/javascript" src="super-stack.min.js"></script>
<script type="text/javascript">
    try {
        someAction()
    } catch (err) {
        throw superStack.messageWrap('More readable message!', err);
    }

</script>

Function-based API

Actives the object-based API for one specific error superclass. Useful if you want to avoid modifying the prototype of standard Error objects.

Actives the object-based API for all Error objects. It is the equivalent to attachToPrototype(Error.prototype).

Returns the first child of the error or null.

Returns an array of wrapped errors from the outside in. The current error is included.

Returns an array of wrapped error messages from the outside in. The current error message is included.

Returns a delimited string of all wrapped error messages from the outside in. The current error message is included.

Returns an array of wrapped error stacks from the outside in. The current error stack is included.

Returns a delimited string of all wrapped error stacks from the outside in. The current error stack is included.

Wraps the error into an new error of the same type with the given message. This is a useful tool for storing a more context specific error message while still retaining the original error.

Returns the newly created error. Useful for returning directly to a throw statement.

Wraps the parent error around the child error.

Returns the parent error. Useful for returning directly to a throw statement.

Object-based API

Most of the function-based API can be optionally mapped onto the Error object prototype with the attachToErrorPrototype. Without activating this API the Error object modifications are kept down to a single variable that is namespaced to avoid collisions. An Error subclass can be activate instead by passing its prototype to attachToPrototype.

API Mapping

| Object-based | Function-based | |--------------------------------------|--------------------------------------------------------------| | err.child | superStack.getChild(err) | | err.errors | superStack.getErrors(err) | | err.messageArray | superStack.getMessageArray(err) | | err.messages | superStack.getMessages(err) | | err.stackArray | superStack.getStackArray(err) | | err.stacks | superStack.getStacks(err) | | throw new Error('message').wrap(err) | throw superStack.wrap(new Error('message'), err) | | throw err.messageWrap('message') | throw superStack.messageWrap('message', err) |