Error handler for failed promises
- ✨ Benefits
- 🎒 Requierments
- 🚀 Quickstart
- 📘 Documentation
- 🆘 Troubleshooting
- 🤝 Contributing
- 🧪 Testing
- ⚖️ License
- More readable than try/catch
- Preserves stack call for debugging
- Exits process (in NodeJS)
No requierments, just works.
Install using the terminal:
npm install @danielcobo/err
Require the module:
const err = require('@danielcobo/err');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.
Declare it as a global variable named err by including this script before any script you want to use it in:
<script src="https://cdn.jsdelivr.net/npm/@danielcobo/err@1/dist/iife/err.min.js"></script>Or import it as an ECMAScript module:
import * as err from 'https://cdn.jsdelivr.net/npm/@danielcobo/err@1/dist/esm/err.min.js';Also, feel free to download the file if you prefer not to use jsdelivr. In that case just replace the url with the relative file path.
const result = await trySomething(param).catch(
err('Everyone fails sometime. Error:')
);For details see documentation below.
Set error message
| Name | Type | Default | Description |
|---|---|---|---|
| description | string |
Error description |
Source: src/index.js:18
If you run into trouble or have questions just submit an issue.
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..)
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 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).