octopus-error-handler v1.0.3

octopus-error-handler

Installation

You can download octopus-error-handler from NPM

$ npm install octopus-error-handler --save

then in your project require octopus-error-handler

const errorHandler = require('octopus-error-handler');

or GitHub

$ git clone https://github.com/leonardofurnielis/octopus-error-handler.git

Guide

In an Express-based application:

const express = require('express');
const errorHandler =  require('octopus-error-handler');

const app = express();

// Your defined middlewares
...

// Your defined routes
app.get('/foo', (req, res, next) => {
    const error = new Error('Missing field(s): foo');
    error.code = 422;
    next(error);
});

// HTTP errorHandler
app.use(errorHandler({
  log: true, 
  debug: true 
}));

Options

{
  log: false; // Log errors using console.error(), Default: false
  debug: false; // Adds error.stack into output JSON, Default: false
}

Definition of a "Error"

The error could contain the following fields:

HTTP JSON Error Example

{
  "error": {
    "status_code": 422,
    "message": "Missing field(s): foo",
    "code": "MISSING_REQUIRED_FIELDS"
  }
}