# handy-error

> Makes error handling excruciatingly easy

Latest version **2.0.0** (published 2018-07-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install handy-error
pnpm add handy-error
yarn add handy-error
bun add handy-error
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2018-07-15 |
| First published | 2018-07-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 3.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Mateusz Sowiński-Smętny |
| Maintainers | judehunter |
| Keywords | error, handling, handy, throw |

## Links

- npm: https://www.npmjs.com/package/handy-error
- Repository: https://github.com/judehunter/handy-error
- Issues: https://github.com/judehunter/handy-error/issues
- npm.io page: https://npm.io/package/handy-error

## Alternatives

- [@sentry/react-native](https://npm.io/package/@sentry/react-native.md) — 2.6M weekly downloads
- [@ardatan/aggregate-error](https://npm.io/package/@ardatan/aggregate-error.md) — 708.1K weekly downloads
- [custom-error-generator](https://npm.io/package/custom-error-generator.md) — 2.0K weekly downloads
- [@technik-sde/prosemirror-recreate-transform](https://npm.io/package/@technik-sde/prosemirror-recreate-transform.md) — 1.5K weekly downloads
- [@suchipi/error-utils](https://npm.io/package/@suchipi/error-utils.md) — 78 weekly downloads

## Recent versions

- 2.0.0 (latest) — 2018-07-15
- 1.0.3 — 2018-07-06
- 1.0.2 — 2018-07-05
- 1.0.1 — 2018-07-03
- 1.0.0 — 2018-07-03

## README

# Handy Error
A lightweight module that makes error **hand**ling in Node.js excruciatingly *easy*:boom:.

Throw your errors with a single one-liner!

Also handy for e.g. Express.js error handling.

## Usage
Require the module with:
```javascript
var Err = require('handy-error');     //in a single file
global.Err = require('handy-error');  //globally
// tip: Name it something short, like Err or E
```
Now You can use it like your usual Error class, but on drugs:
```javascript
throw Err(errCode, errMsg, {extraInfo, ...});
```
Use the extra argument to pass some **handy** info to your error handler

### Config
You can set defaults for error code, message and extras:
```javascript
var Err = require('handy-error').config('defCODE', 'defMSG', 'defExtras');
// The config is static across all files. (only needs to be done once)
// tip: you can omit any of the arguments by setting them to undefined,
//      or just leaving them if they're not followed by any other arguments.
```

## Examples
No more doing this:
```javascript
if(!fileExists){
  var error = new Error('File Not Found');
  error.code = 'ENOENT';
  throw error;
  // so much mess just for error handling, isn't it?
}
```

You can now get used to **this**:
```javascript
if (!fileExists) throw Err('ENOENT', 'Not Found', extraInfo);   //*Handy!*
```

Handy error **hand**ling in express:
```javascript
app.get('/api', (req, res, next) => {
  if (!req.query.apikey) next(Err(429, 'Too many requests', {timeout}));
});
```

### Accessing extras

You can write anything to the extra object - 3rd argument.
Then You simply read/write to it like that:
```javascript
var e = Err(416, 'Range Not Satisfiable', {acceptableRange: 400});
console.log(e.extra.acceptableRange) // 400

//It doesn't have to be an object!
var e = Err(408, 'Request timeout', 'Some more handy info');
console.log(e.extra) // Some more handy info
```


## Install
Run this command in your command line:
```pwsh
npm i handy-error --save
```


And that's **it**!

---
_Source: https://npm.io/package/handy-error · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._