JSON API Errors
Create errors using JSON API errors format
Installation
$ npm install json-api-errors
Usage
Errors.createSingle(id, message, [meta])
Create a single errors object.
id
(String)- required
message
(String)- required
meta
(Object | String)- optional
const Errors = var errors = var err = errors console// {// 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
const Errors = var errors = errors
Errors.get()
Retreive all errors. Errors are returned in a JSON format
const Errors = var errors = errors var errs = errors// {// errors: [{ id: 'CUSTOM_ERROR', message: 'Custom error message' }]// }
Errors.clear()
Remove all errors
const Errors = var errList errors = errors errList = errorsconsole // Length is 1 errorsclearerrList = errors console // Length is 0
Tests
$ npm test