README
err
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 (in NodeJS)
๐ Requierments
No requierments, just works.
๐ Quickstart
Install
NodeJS
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.
Browser
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.
Example use
const result = await trySomething(param).catch(
err('Everyone fails sometime. Error:')
);
For details see documentation below.
๐ Documentation
@danielcobo/err()
Set error message
Name | Type | Default | Description |
---|---|---|---|
description | string |
Error description |
Source: src/index.js:18
๐ Troubleshooting
If you run into trouble or have questions just submit an issue.
๐ค 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).