node-exceptions/README.md

Extendable error class for nodejs to extend native errors

# Node Exceptions

[![NPM Version][npm-image]][npm-url]
[![Build Status][travis-image]][travis-url]
[![Appveyor][appveyor-image]][appveyor-url]
[![Coveralls][coveralls-image]][coveralls-url]

<a href="http://i1117.photobucket.com/albums/k594/thetutlage/poppins-1_zpsg867sqyl.png">
<img src="http://i1117.photobucket.com/albums/k594/thetutlage/poppins-1_zpsg867sqyl.png" width="300px" align="right" vspace="20px" />
</a>

Throwing errors in Javascript does not give much information about the error type as it is really hard to throw custom exceptions. Node Exceptions is a tiny wrapper which will let you extend the Error class and throw custom errors.

## Why custom errors
Errors are thrown anywhere inside the code and handling them properly is required. For example you have an HTTP application, which can throw multiple errors and in order to handle those errors gracefully, you need to know the error types or their names.

```javascript
switch (err.name) {
  case 'HttpException':
    // do something
  case 'RunTimeException':
    // do something else
}
```


## Install

```bash
npm i --save node-exceptions
```

## Creating custom errors

```javascript
const NE = require('node-exceptions')

class MyCustomError extends NE.LogicalException {}

try {
  throw new MyCustomError('Something bad happened')
} catch (e) {
  console.log(e.status) // equals 500
  console.log(e.name) // equals MyCustomError
  console.log(e.message) // Something bad happened
  console.log(e.stack) // Error stack with correct reference to filepath and linenum
  console.log(e.toString()) // MyCustomError: Something bad happened
}
```

## Custom error status
It is also possible to have a custom error status when throwing exceptions.

```javascript
const NE = require('node-exceptions')

class HttpException extends NE.LogicalException {}

try {
  throw new HttpException('Page not found', 404)
} catch (e) {
  console.log(e.status) // equals 404
}
```

## API Docs
Access complete API Docs [here](https://poppinss.github.io/node-exceptions/docs/index.html)

[appveyor-image]: https://img.shields.io/appveyor/ci/thetutlage/node-exceptions/master.svg?style=flat-square

[appveyor-url]: https://ci.appveyor.com/project/thetutlage/node-exceptions

[npm-image]: https://img.shields.io/npm/v/node-exceptions.svg?style=flat-square
[npm-url]: https://npmjs.org/package/node-exceptions

[travis-image]: https://img.shields.io/travis/poppinss/node-exceptions/master.svg?style=flat-square
[travis-url]: https://travis-ci.org/poppinss/node-exceptions

[coveralls-image]: https://img.shields.io/coveralls/poppinss/node-exceptions/develop.svg?style=flat-square

[coveralls-url]: https://coveralls.io/github/poppinss/node-exceptions%