@danielcobo/catcher v1.0.0
catcher
Error handler for failed promises
๐งญ Table of contents
- โจ Benefits
- ๐ Requierments
- ๐ Quickstart
- ๐ Documentation
- ๐ Troubleshooting
- ๐ค Contributing
- ๐งช Testing
- โ๏ธ License
โจ Benefits
- More readable than try/catch
- Preserves stack call for debugging
- Exits process
๐ Requierments
To use this package you will need:
๐ Quickstart
Install
npm install @danielcobo/catcher
Note: In case you're wondering, @danielcobo/ is just a namespace scope - an NPM feature. Scopes make it easier to name modules and improve security.
Require the module
const err = require('@danielcobo/catcher');
Example use
const result = await trySomething(param).catch(
err('Everyone fails sometime. Error:')
);
For details see documentation below.
๐ Documentation
๐ Troubleshooting
Only works in NodeJS since it will also exit process.
๐ค Contributing
Anyone can contribute
Contributions come in many shapes and sizes. All are welcome. You can contribute by:
- asking questions
- suggesting features
- sharing this repo with friends
- improving documentation (even fixing typos counts ๐)
- providing tutorials (if you do, please let me know, I would love to read them)
- improving tests
- contributing code (new features, performance boosts, code readability improvements..)
Rules for contributions
General guidelines:
- there are no dumb questions
- be polite and respectful to others
- do good
When coding remember:
- working > maintainability > performance
- best code is no code
- be descriptive when naming
- keep it DRY
- do test
Contribution licence: All contributions are considered to be under same license as this repository.
๐งช Testing
Testing suite: ๐ Jest | Test command: npm test
Mutation testing suite: ๐ฝ Stryker Mutator | Mutation test command: npm run mutation
If you intend to develop further or contribute code, then please ensure to write and use testing. Strive for 100% code coverage and high mutation scores. Mutation score 100 is great, but it's not always neccessary (if there are valid reasons).
โ๏ธ License
4 years ago