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

constErrors=require('json-api-errors')varerrors=newErrors()varerr=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

constErrors=require('json-api-errors')varerrors=newErrors()errors.add('CUSTOM_ERROR','Custom error message')

Errors.get()

Retreive all errors. Errors are returned in a JSON format

constErrors=require('json-api-errors')varerrors=newErrors()errors.add('CUSTOM_ERROR','Custom error message')varerrs=errors.get()// {// errors: [{ id: 'CUSTOM_ERROR', message: 'Custom error message' }]// }

Errors.clear()

Remove all errors

constErrors=require('json-api-errors')varerrList,errors=newErrors()errors.add('CUSTOM_ERROR','Custom error message')errList=errors.get()console.log(errList.errors)// Length is 1errors.clear()errList=errors.get()console.log(errList.errors)// Length is 0

Tests

$ npm test