Streamlined Node.js HTTP Exception Handling with node-http-exceptions

Key Features:

• Structured HTTP Exception Classes: Dedicated classes for common HTTP errors (BadRequestException, UnauthorizedException, NotFoundException, etc.) promote code organization and consistency.
• Centralized HTTP Status Codes: The httpStatus module provides easy access to standard HTTP status codes, enhancing code readability and maintainability.
• Error Handling Middleware: errorMiddleware and notFoundMiddleware facilitate centralized error management, simplifying error handling logic and ensuring appropriate responses.
• Flexible Base Class: The HttpException class allows for custom exception creation with specific status codes and messages, enabling tailored error handling.
• Informative Default Messages: Common error cases have default messages, but customizable messages enable more informative and user-friendly responses.
• TypeScript Support: Ensure type definitions for all modules and classes to enhance code completion, type checking, and overall development experience.

Installation:

$ npm install --save node-http-exceptions
$ yarn add node-http-exceptions

Usage Examples:

Here is simple example:

1import { Router } from 'express'
2const { UnauthorizedException, BadRequestException, UnprocessableEntityException } = require( 'node-http-exceptions')
3
4const routes = Router()
5
6routes.post('/tasks', function (req, res, next) {
7    if (!req.user){
8        throw new UnauthorizedException() //default message will be shown '401 Unauthorized'
9    }
10
11    if ( !req.body ) ) {
12        throw new BadRequestException( 'Task data is empty' )
13    }
14
15    if ( !req.body.name ) {
16        throw new UnprocessableEntityException( 'Please fills all required fields.', {
17          errors: { name: 'Name should not be empty.' }
18        } )
19    }
20
21    //create task
22})

Centralized Error Handling with Middleware::

1const { errorMiddleware, notFoundMiddleware } = require('node-http-exceptions')
2const express = require('express')
3const routes = require('./src/routes')
4
5const app = express()
6
7app.use(routes)
8
9//handle errors
10app.use(notFoundMiddleware)
11app.use(errorMiddleware)

Use base HttpException

1const { HttpException, httpStatus } = require('node-http-exceptions')
2const express = require('express')
3
4const app = express()
5
6app.post('/tasks', function (req, res, next) {
7    if (!req.user) {
8        throw new HttpException(httpStatus.UNAUTHORIZED, 'You are unauthorized.')
9    }
10
11    //do something
12})

The httpStatus object

Note that the node-http-exceptions also imports a httpStatus object:

1import { httpStatus } from 'node-http-exceptions'
2
3console.log(httpStatus.OK) // Output: 200
4console.log(httpStatus.NOT_FOUND) // Output: 404

Benefits:

• Improved Code Organization: Dedicated exception classes and centralized status codes enhance code readability and maintainability.
• Simplified Error Handling: Middleware simplifies error management and ensures consistent responses.
• Customizable Error Messages: Tailor error messages to provide more informative feedback to users.
• TypeScript Support: Enhance development experience with type checking and code completion.

Which exception classes this package provides?

node-http-exceptions provides a set of exception classes that inherit from the base HttpException. These classes represent many of the most common HTTP exceptions:

• BadRequestException
• UnauthorizedException
• NotFoundException
• ForbiddenException
• NotAcceptableException
• RequestTimeoutException
• ConflictException
• PayloadTooLargeException
• UnsupportedMediaTypeException
• UnprocessableEntityException
• InternalServerErrorException
• ServiceUnavailableException
• TooManyRequestException