JSON API Errors

Create errors using JSON API errors format

![npm package][package]

![version][version]
![build][build]
![license][license]
![climate][climate]
![coverage][coverage]

$3

$ npm install json-api-errors

$3

#### Errors.createSingle(id, message, [meta])

Create a single errors object.

- id (String)
- required
- message (String)
- required
- meta (Object | String)
- optional

``javascript
const Errors = require('json-api-errors')

var errors = new Errors()
var err = errors.createSingle('CUSTOM_ERROR', 'Custom error message')

console.log(err)
// {
// errors: [{ id: 'CUSTOM_ERROR', message: 'Custom error message' }]
// }
`

#### Errors.add(id, message, [meta])

Add an error to the errors array

- id (String)
- required
- message (String)
- required
- meta (Object | String)
- optional

`javascript
const Errors = require('json-api-errors')

var errors = new Errors()
errors.add('CUSTOM_ERROR', 'Custom error message')
`

#### Errors.get()

Retreive all errors. Errors are returned in a JSON format

`javascript
const Errors = require('json-api-errors')

var errors = new Errors()
errors.add('CUSTOM_ERROR', 'Custom error message')

var errs = errors.get()
// {
// errors: [{ id: 'CUSTOM_ERROR', message: 'Custom error message' }]
// }
`

#### Errors.clear()

Remove all errors

`javascript
const Errors = require('json-api-errors')

var errList, errors = new Errors()

errors.add('CUSTOM_ERROR', 'Custom error message')

errList = errors.get()
console.log(errList.errors) // Length is 1

errors.clear()
errList = errors.get()

console.log(errList.errors) // Length is 0
`

$3

$ npm test`

[package]: https://nodei.co/npm/json-api-errors
[version]: https://www.npmjs.com/package/json-api-errors
[build]: https://travis-ci.org/theworkflow/api-util
[license]: https://raw.githubusercontent.com/theworkflow/json-api-errors/master/LICENSE
[climate]: https://codeclimate.com/github/theworkflow/json-api-errors
[coverage]: https://codeclimate.com/github/theworkflow/json-api-errors/coverage