❤
npm
Sign UpSign In

json-api-errors

0.3.0 • Public • Published

JSON API Errors

Create errors using JSON API errors format

npm package

version build license climate coverage

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 = 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
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

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

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

Tests

$ npm test

Readme

Keywords

Package Sidebar

Install

npm i json-api-errors

Repository

github.com/theworkflow/json-api-errors

Homepage

github.com/theworkflow/json-api-errors#readme

Weekly Downloads

0

Version

0.3.0

License

MIT

Last publish

Collaborators

  • harlanj
Try on RunKit
Report malware