1.1.1 • Published 10 months ago

@arunvaradharajalu/common.errors v1.1.1

Weekly downloads
-
License
ISC
Repository
github
Last release
10 months ago

@arunvaradharajalu/common.errors

npm version GitHub issues GitHub license

This npm package provides custom error classes and middleware for handling various types of errors commonly encountered in applications. It includes error classes for database connection errors, storage connection errors, mail connection errors, and a generic error handler middleware for Express applications.

Installation

Install the package using npm:

npm install @arunvaradharajalu/common.errors

Usage

Error Classes

The package includes several predefined error classes:

  • DatabaseConnectionError: Represents errors related to database connections.
  • StorageConnectionError: Represents errors related to storage connections.
  • MailConnectionError: Represents errors related to mail service connections.
  • FirebaseCloudMessagingConnectionError: Represents errors related to firebase cloud messaging connections.
  • SocketConnectionError: Represents errors related to socket connections.

Middleware

Error Handler Middleware

Use the error handler middleware to handle instances of CustomError and send appropriate responses:

import { errorHandler } from '@arunvaradharajalu/common.errors';

// Example usage with Express
app.use(errorHandler);

Example

import { DatabaseConnectionError } from '@arunvaradharajalu/common.errors';

try {
  // Attempt database connection
} catch (err) {
  throw new DatabaseConnectionError('Failed to connect to the database');
}

Running Tests

To run the tests, use:

npm test

The test results will be generated in an HTML report with the title "Error Test Report".

Repository

The source code is available at: GitHub Repository

Issues

If you encounter any issues, please report them at: GitHub Issues

Author

Arun Varadharajalu

License

This project is licensed under the ISC License.