1.0.4 • Published 4 years ago
request-json-errorhandler v1.0.4
request-json-errorhandler
Installation
You can download request-json-errorhandler
from NPM
$ npm install request-json-errorhandler --save
then in your project require request-json-errorhandler
const errorHandler = require('request-json-errorhandler');
or GitHub
$ git clone https://github.com/leonardofurnielis/request-json-errorhandler.git
Guide
In an Express-based application:
const express = require('express');
const errorHandler = require('request-json-errorhandler');
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:
Error Key | Purpose |
---|---|
status_code | HTTP status code for response. Default: 500 (Internal Server Error). |
message | Error details. |
code | Error code. |
HTTP JSON Error Example
{
"error": {
"status_code": 422,
"message": "Missing field(s): foo",
"code": "MISSING_REQUIRED_FIELDS"
}
}