@appyhigh/express-error-handler v1.0.6

express-error-handler

Installation

$ npm install @appyhigh/express-error-handler --save

Use

Check here for sample application

Methods

expressErrorHandler(options: Object) => (error, request, response, next)

This is a function which will work as a middleware for your express app so that your errors will response with an HTTP response. if you will pass database URL then your errors will be saved in database for future analytics.

You have to pass options objects as parameters (*options is optional*).

Example

const express = require('express');
const { expressErrorHandler } = require('@appyhigh/express-error-handler');

const app = express();

app.use(expressErrorHandler({
   environment : 'development',
   dbUrl: 'mongodb+srv://<username>:<password>@clustername.mongodb.net/test?retryWrites=true&w=majority&useNewUrlParser=true&useUnifiedTopology=true',
   dbName: 'test-1',
   appName: 'testing-1',
   errorLogs : false,
   trace : true,
   errorDescription : true,
   errorOrigin : true
}));

Options

Example

5xx error trace: true:

{
    "statusCode": 404,
    "error": {
        "stack": "Error\n at new AppError (/home/akumar/instore-dev/insta-downloader-backend/lib/errorClasses/appError.js:11:5)\n    at next (/home/akumar/instore-dev/insta-downloader-backend/node_modules/express/lib/router/index.js:260:14)",
        "errorDescription": "Error info for developer",
        "type": "Error_origin",
        "errorUserTitle": "Error title for user",
        "errorUserMsg": "Error message for user"
    }
}

Definition of a "Error"

The error could contain the following fields:

HTTP Code

HTTP Code Description

Example

const { AppError, httpCode, httpMessage } = require('@appyhigh/express-error-handler');

const knownError = {
  errorDescription: 'Error description for developer.',
  type: 'error origin place or module name',
  errorUserTitle: 'Error title for user',
  errorUserMsg: httpMessage[httpCode.INTERNAL_SERVER_ERROR],
  httpCode: httpCode.INTERNAL_SERVER_ERROR
};

try{
    //do something....
}
catch(error){
    throw new AppError(knownError,{});
}

License

MIT