1.0.0 โ€ข Published 4 years ago

@danielcobo/catcher v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
4 years ago

catcher

Error handler for failed promises

๐Ÿงญ Table of contents

โœจ 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

MIT License

1.0.0

4 years ago