ABOUT This is a very basic HTTP response handler for NodeJS applications.
These instructions will get you started on using the package
npm install --save request-response-handler
This package supports both ES6 e.g import and commonjs e.g require syntax
You can import some http statusCodes often used in projects:
Example
CREATED, //201
OK, // 200
BAD_REQUEST, // 400
CONFLICT, // 409
NOT_FOUND, // 404
UNAUTHORIZED, // 401
FORBIDDEN, // 403
SERVER_ERROR, // 500As enums
const {
SuccessStatusCodes,
ErrorStatusCodes
} = require('request-response-handler');or as constants
import { CREATED, BAD_REQUEST } from 'request-response-handler';Pass the errorHandler as a middleware to catch all errors in your app
Example
const { errorHandler } = require('request-response-handler');
app.use(errorHandler());Use customError to catch errors and return custom error messages in your app
Example
const { customError, ErrorStatusCodes } = require('request-response-handler');
/**
* Create new error
*
* @param {String} message
* @param {number} status
*
* @returns {object} error
*/
createError({
status: ErrorStatusCodes.CONFLICT,
message: 'User with email or username already exists',
}),Example handle 2XX responses with custom messages and response objects
const { success SuccessStatusCodes} = require('request-response-handler');
/**
*Create success response data format
*
* @param {object} res
* @param {object} statusCode
* @param {string} [message='successful']
* @param {object} body // optional
* @return {object}
*/
success(res, SuccessStatusCodes.CREATED, 'SignUp Successful', {
id: user.id, username, email, token, apiKey: user.apiKey,
});- Ulor Pascal - PascalUlor