error-naturals v0.1.0

error-naturals

Installation

$ npm install --save error-naturals
$ yarn add error-naturals

Usage

const ErrorNaturals = require('error-naturals');
const path = require('path');

const errorNaturals = new ErrorNaturals(path.join(__dirname, PATH_TO_YOUR_ERROR_CONFIG_JSON_FILE ));

errorNaturals.generateErrors(errorCode,errorType,customMessage, customResponse);

Error config json file

You need to create a json file in the following format.

{
  "YOUR_ERROR_CODE": {
    "error": {
      "meta": {
        "type": "error",
        "status": 400,
        "code": "INVALID_REQUEST",
        "context_info": {
          "ping": {
            "message": "A ping request was made without revelant content"
          }
        },
        "help_url": "http://developers.hootboard.com/docs/#errors",
        "message": "A ping request was made without one or more required parameters"
      }
    }
  }
}

License

MIT © soorajvnair