Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/IonicaBizau/err
:boom: A tiny library to create custom errors in JavaScript.
https://github.com/IonicaBizau/err
hacktoberfest
Last synced: about 2 months ago
JSON representation
:boom: A tiny library to create custom errors in JavaScript.
- Host: GitHub
- URL: https://github.com/IonicaBizau/err
- Owner: IonicaBizau
- License: mit
- Created: 2015-11-23T05:24:50.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2020-08-09T11:06:10.000Z (about 4 years ago)
- Last Synced: 2024-07-28T07:07:25.940Z (about 2 months ago)
- Topics: hacktoberfest
- Language: JavaScript
- Homepage:
- Size: 21.5 KB
- Stars: 11
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](#)
# err
[![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [](https://github.com/IonicaBizau/ama) [](https://www.npmjs.com/package/err) [](https://www.npmjs.com/package/err) [](https://www.codementor.io/johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)
> A tiny library to create custom errors in JavaScript.
## :cloud: Installation
```sh
# Using npm
npm install --save err
# Using yarn
yarn add err
```
## :clipboard: Example
```js
const Err = require("err");
// Basic usage
let e1 = new Err("Some nasty stuff happened");
console.log(e1);
// => [Error: Some nasty stuff happened]
// Provide the error code
let e2 = new Err("Some nasty stuff happened", "NASTY_STUFF_HAPPENED");
console.log(e2);
// => {
// [Error: Some nasty stuff happened]
// code: 'NASTY_STUFF_HAPPENED'
// }
// Provide the error code and some data
let e3 = new Err("Some nasty stuff happened", "NASTY_STUFF_HAPPENED", {
additional: "data"
});
console.log(e3);
// => {
// [Error: Some nasty stuff happened]
// additional: 'data'
// , code: 'NASTY_STUFF_HAPPENED'
// }
// Provide the error data (including the code as well)
let e4 = new Err("Some nasty stuff happened", {
additional: "data"
, code: "NASTY_STUFF_HAPPENED"
});
console.log(e4);
// => {
// [Error: Some nasty stuff happened]
// additional: 'data'
// , code: 'NASTY_STUFF_HAPPENED'
// }
// Wrap an existing error
let existingError = new Error("Some nasty stuff happened");
let e5 = new Err(existingError, {
additional: "data"
, code: "NASTY_STUFF_HAPPENED"
, and: "some more data"
});
console.log(e5);
// => {
// [Error: Some nasty stuff happened]
// additional: 'data'
// , code: 'NASTY_STUFF_HAPPENED'
// , and: 'some more data'
// }
let e6 = new Err({
message: "Something went really wrong!!!"
, additional: "data"
, code: "NASTY_STUFF_HAPPENED"
, and: "some more data"
});
console.log(e6);
// => {
// [Error: Something went really wrong!!!]
// additional: 'data'
// , code: 'NASTY_STUFF_HAPPENED'
// , and: 'some more data'
// }
let e7 = new Err("Invalid option ''.", {
option: "test"
});
console.log(e7);
// { [Error: Invalid option 'test'.] option: 'test' }
```
## :question: Get Help
There are few ways to get help:
1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.
2. For bug reports and feature requests, open issues. :bug:
3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:
## :memo: Documentation
### `Err(error, code, data)`
Create a custom error object.
#### Params
- **String|Error|Object** `error`: The error message or an existing `Error` instance or the `data` object where the `message` is the error message.
- **String|Object** `code`: The error code or the data object.
- **Object** `data`: The data object (its fields will be appended to the `Error` object).
#### Return
- **Error** The custom `Error` instance.
## :yum: How to contribute
Have an idea? Found a bug? See [how to contribute][contributing].
## :sparkling_heart: Support my projects
I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously,
this takes time. You can integrate and use these projects in your applications *for free*! You can even change the source code and redistribute (even resell it).
However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:
- Starring and sharing the projects you like :rocket:
- [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book:
- [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
- [![Support me on Patreon][badge_patreon]][patreon]—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
- **Bitcoin**—You can send me bitcoins at this address (or scanning the code below): `1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6`
Thanks! :heart:
## :dizzy: Where is this library used?
If you are using this library in one of your projects, add it in this list. :sparkles:
- `scrape-it`
- `tilda`
- `emoji-logger`
- `@sphinxdoc/core`
- `bloggify-adapter`
- `python-env`
- `image-parser`
- `validated-base`
- `find-file-in-dirs`
- `@asserted/models`
- `git-package-json`
- `multithread-config`
- `@ecosystem/config`
- `mocha-ldjson`
- `engine-comp-crud-errors`
- `engine-composition-adapter`
- `fs-repo-url`
- `gh-fork-source`
- `lwip2`
- `validify`
- `sphinxdoc`
- `@gatsbydoc/core`
- `simple-cached-firestore`
- `payiota`
- `stringify-env`
- `scrape-it-plus`
- `@slikts/scrape-it`
- `do-task`
- `check-params`
- `love-you`
- `showalicense.com`
- `@sphinxdoc/cli`
- `trace-breaking-change`
- `@reactant/react-router`
- `@gatsbydoc/sphinx`
- `@gatsbydoc/cli`
- `vkbeautify-cli`
- `dotstow`
- `ts-gir`
- `simple-cached-datastore`
- `git-sync-all`
- `@ecosystem/core`
- `asrtd`
- `hunarcourses`
## :scroll: License
[MIT][license] © [Ionică Bizău][website]
[license]: /LICENSE
[website]: https://ionicabizau.net
[contributing]: /CONTRIBUTING.md
[docs]: /DOCUMENTATION.md
[badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg
[badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg
[badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg
[badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg
[patreon]: https://www.patreon.com/ionicabizau
[amazon]: http://amzn.eu/hRo9sIZ
[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW