error-handler-e2

Error Handler E2

   

This is a common page for:

• Error handler
• Http Status codes

1. Installation
2. Usage
3. Options

Installation

npm i error-handler-e2
// Or 
yarn add error-handler-e2

Usage

const { Errors: { BadRequestError } } = require('error-handler-e2');
// or
import { Errors } from 'error-handler-e2'

Options

1. Errors

• BadRequestError
• ConflictError
• CustomError
• DatabaseError
• InternalServerError
• NoContentError
• NotFoundError
• UnAuthenticatedError
• UnAuthorizedError
• UnProcessableEntityError

BadRequestError

const { Errors:{ BadRequestError }} = require('error-handler-e2');

throw new BadRequestError('Bad request error message', { time: new Date() });

ConflictError

const { Errors:{ ConflictError }} = require('error-handler-e2');

throw new ConflictError('conflict error message', { time: new Date() });

CustomError

const { Errors:{ CustomError }} = require('error-handler-e2');

throw new CustomError('Custom error message', { time: new Date() });

DatabaseError

const { Errors:{ DatabaseError }} = require('error-handler-e2');

throw new DatabaseError('Database error message', { time: new Date() });

InternalServerError

const { Errors:{ InternalServerError }} = require('error-handler-e2');

throw new InternalServerError('Internal Server error message', { time: new Date() });

NoContentError

const { Errors:{ NoContentError }} = require('error-handler-e2');

throw new NoContentError('NoContent error message', { time: new Date() });

NotFoundError

const { Errors:{ NotFoundError }} = require('error-handler-e2');

throw new NotFoundError('NotFound error message', { time: new Date() });

UnAuthenticatedError

const { Errors:{ UnAuthenticatedError }} = require('error-handler-e2');

throw new UnAuthenticatedError('UnAuthenticated error message', { time: new Date() });

UnAuthorizedError

const { Errors:{ UnAuthorizedError }} = require('error-handler-e2');

throw new UnAuthorizedError('UnAuthorized error message', { time: new Date() });

UnProcessableEntityError

const { Errors:{ UnProcessableEntityError }} = require('error-handler-e2');

throw new UnProcessableEntityError('UnProcessable Entity error message', { time: new Date() });

1. Http Status

• NO_CONTENT 204
• BAD_REQUEST 400
• UNAUTHENTICATED 401
• UNAUTHORIZED 403
• NOT_FOUND 404
• CONFLICT 409
• UNPROCURABLE_ENTITY 422
• INTERNAL_SERVER_ERROR 500

NO_CONTENT 204

const { StatusCodes: { NO_CONTENT } } = require('error-handler-e2');

BAD_REQUEST 400

const { StatusCodes: { BAD_REQUEST } } = require('error-handler-e2');

UNAUTHENTICATED 401

const { StatusCodes: { UNAUTHENTICATED } } = require('error-handler-e2');

UNAUTHORIZED 403

const { StatusCodes: { UNAUTHORIZED } } = require('error-handler-e2');

NOT_FOUND 404

const { StatusCodes: { NOT_FOUND } } = require('error-handler-e2');

CONFLICT 409

const { StatusCodes: { CONFLICT } } = require('error-handler-e2');

UNPROCURABLE_ENTITY 422

const { StatusCodes: { UNPROCURABLE_ENTITY } } = require('error-handler-e2');

INTERNAL_SERVER_ERROR 500

const { StatusCodes: { INTERNAL_SERVER_ERROR } } = require('error-handler-e2');

1. Middleware
   • loggerMiddleware
   • handleErrorMiddleware
   • notFoundMiddleware
   • asyncHandlerMiddleware

loggerMiddleware

const { Middleware:{ loggerMiddleware }} = require('error-handler-e2');

app.use(loggerMiddleware);

handleErrorMiddleware

const { Middleware:{ handleErrorMiddleware }} = require('error-handler-e2');

app.use(handleErrorMiddleware);

handleErrorMiddleware

const { Middleware:{ notFoundMiddleware }} = require('error-handler-e2');

app.use(notFoundMiddleware);

asyncHandlerMiddleware

import { Middleware:{ asyncHandlerMiddleware }, StatusCodes } from 'error-handler-e2';

// get users example
route.get('/users', asyncHandler(async (req: Request, res: Response, next: NextFunction) => {

    return res.status(StatusCodes.OK).json({ users: [{ id: 1, name: 'Milad' } ]});
  })
);

Changelog

4.1.0 (2022-02-09)

Chores

• update docs (e4031ad1)

Continuous Integration

• delete pre-commit and add pre-push (a97d1abc)

Documentation Changes

• add docs for async handler (6db02398)

New Features

• create async handler middleware (357e5c14)