@dadi/format-error

Create API error objects for DADI applications

Stats

StarsIssuesVersionUpdatedCreatedSize
@dadi/format-error
201.7.03 years ago5 years agoMinified + gzip package size for @dadi/format-error in KB

Readme

DADI Error Formatter

Create JSON error objects for DADI applications

npm (scoped) coverage JavaScript Style Guide semantic-release

Overview

format-error is designed to streamline the process of creating errors to be returned from a DADI product.

Install

npm install @dadi/format-error

Usage

createApiError(code, params)

const formatError = require('@dadi/format-error')
let error = formatError.createApiError('0001', { field: 'publicationDate' })
{
  "code": "API-0001",
  "title": "Missing Index Key",
  "details": "'publicationDate' is specified as the primary sort field, but is missing from the index key collection.",
  "docLink": "http://docs.dadi.tech/errors/api/API-0001"
}

createError(product, code, params, codes)

const formatError = require('@dadi/format-error')
const codes = {
  "0001": {
    "code": "API-0001",
    "title": "Missing Index Key",
    "details": "'${field}' is specified as the primary sort field, but is missing from the index key collection.",
    "params": ["field"]
  },
  "0002": {
    "code": "API-0002",
    "title": "Hook Error",
    "details": "${hookName} - ${errorMessage}",
    "params": ["hookName", "errorMessage"]
  }
}

let error = formatError.createError('api', '0001', { field: 'publicationDate' }, codes)

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.