esrol-errors/readme.md

An Errors Class for esrol-server-app. It is used for registering new custom errors with numbers, can get a single or all errors in the registry, has a custom throw error method.

[![NPM version][npm-image]][npm-url]
[![Build Status][travis-image]][travis-url]
[![Test coverage][coveralls-image]][coveralls-url]

# esrol-errors
An Errors Class for esrol-server-app. It is used for registering new custom errors with numbers, can get a single or all errors in the registry, has a custom throw error method.

*Part of [Esrol](https://github.com/esrol/esrol)*

## Installation

```sh
$ npm install --save esrol-errors
```

## Usage

```js
'use strict';
let Errors = require('esrol-errors');
let errors = new Errors();

errors.registerErrorWithNumber('Some error message', 1);
let all = errors.getAllErrors();
let error = errors.getByNumber(1);
console.log (error); // Some error message
console.log (all); // { '1': 'Some error message' }
try {
  errors.error('the reason for this erros is to show some example', 1);
} catch(e) {
  console.log (e);
}
```

## Methods
<dl>
<dt><a href="#registerErrorWithNumber">registerErrorWithNumber(description, number)</a> ⇒ <code>boolean</code></dt>
<dd><p>Register / set an error with a number.</p>
</dd>
<dt><a href="#getByNumber">getByNumber(number)</a> ⇒ <code>object</code></dt>
<dd><p>Get an error by it&#39;s number.</p>
</dd>
<dt><a href="#getAllErrors">getAllErrors()</a> ⇒ <code>object</code></dt>
<dd><p>Get the whole registry with all the errors.</p>
</dd>
<dt><a href="#error">error(message, code)</a> ⇒ <code><a href="#error">error</a></code></dt>
<dd><p>Custom method for error handling.</p>
</dd>
</dl>
<a name="registerErrorWithNumber"></a>
## registerErrorWithNumber(description, number) ⇒ <code>boolean</code>
Add a new error message and corresponding number to the registry.

**Returns**: <code>boolean</code> - true - returns true if adding was successful
**Throws**:

- <code>[error](#error)</code> error - when incorrect arguments have been passed


| Param | Type | Description |
| --- | --- | --- |
| description | <code>string</code> | description text of the error |
| number | <code>int</code> | the number that the error will have |

<a name="getByNumber"></a>
## getByNumber(number) ⇒ <code>object</code>
Get an error by it's number.

**Returns**: <code>string</code> - - returns the message of the error

| Param | Type | Description |
| --- | --- | --- |
| number | <code>int</code> | the number of the error |

<a name="getAllErrors"></a>
## getAllErrors() ⇒ <code>object</code>
Get the whole registry with all the errors. This method returns
the output of getAll from the Register class.

**Returns**: <code>object</code> - - returns all the errors in the registry
<a name="error"></a>
## error(message, code) ⇒ <code>error</code>
Custom method for error handling.


| Param | Type | Description |
| --- | --- | --- |
| message | <code>string</code> | message / text of the error |
| code | <code>int</code> | the number that the error has |

## Contriubtion

Any contribution will be highly appreciated. Just make sure that:

1.Your code works.  
2. You have 100% successful tests coverage.  
3. You have comments in your code.  
4. Follows eslint config. Exceptions are possible where that make sense.  

## Tests

  To run the test suite, first install the dependencies, then run `npm test`:

```bash
$ npm install
$ npm test
```

## License

[MIT](https://github.com/esrol/esrol-autoloader/blob/master/LICENSE)


[npm-image]: https://badge.fury.io/js/esrol-errors.svg
[npm-url]: https://npmjs.org/package/esrol-errors
[travis-image]: https://travis-ci.org/esrol/esrol-errors.svg?branch=master
[travis-url]: https://travis-ci.org/esrol/esrol-errors
[coveralls-image]: https://coveralls.io/repos/esrol/esrol-errors/badge.svg
[coveralls-url]: https://coveralls.io/r/esrol/esrol-errors