faulty
A utility function to create custom error objects in Javascript.
Installation
Install via npm:
% npm install faulty
Usage
var createError = ;// => [Function] var MyError = ;// => [Function: MyError] MyErrorname// => 'MyError' var err = 'something bad has just happened';// => [MyError: something bad has just happened] err instanceof Error// => true err instanceof MyError// => true errname// => 'MyError' errmessage// => 'something bad has just happened' errstack// => 'MyError: something bas has just happened\n at <...stack trace...>' var err2 = 'another error' foo: 'bar' baz: 123 ;// => [MyError: another error] err2foo// => 'bar' err2baz// => 'baz' var WrappedError = ; var err3 = 'see second arg' 'foo'// => [WrappedError: see second arg] err3originalError// => [Error: foo]
Contributing
Here's a quick guide:
-
Fork the repo and
make install
. -
Run the tests. We only take pull requests with passing tests, and it's great to know that you have a clean slate:
make test
. -
Add a test for your change. Only refactoring and documentation changes require no new tests. If you are adding functionality or are fixing a bug, we need a test!
-
Make the test pass.
-
Push to your fork and submit a pull request.
Licence
Released under The MIT License.