@n4it/utility-error-filter

@n4it/utility-error-filter

A NestJS module for catching and handling errors globally. The ErrorInterceptorModule will catch all errors thrown in your NestJS application by default.

Installation

To install the module, use npm:

npm install @n4it/utility-error-filter

Usage

Importing and Configuring the Module

To use the ErrorInterceptorModule, import it into your NestJS module and configure it using the register method. This method allows you to enable logging and handle specific errors globally.

import { ErrorInterceptorModule } from "@n4it/utility-error-filter";
import { Module } from "@nestjs/common";

@Module({
  imports: [
    ErrorInterceptorModule.register({
      logErrros: true,
      logFailures: true,
    }),
  ],
})
export class AppModule {}

Custom Error Handling

You can extend the module to handle custom errors, such as those from TypeORM. This is done by mapping specific errors to HTTP status codes.

import { ErrorInterceptorModule } from "@n4it/utility-error-filter";
import { Module } from "@nestjs/common";
import {
  CannotCreateEntityIdMapError,
  EntityNotFoundError,
  QueryFailedError,
} from "typeorm";

@Module({
  imports: [
    ErrorInterceptorModule.register({
      // if you want to extend the working with custom errors
      // for example, with TypeORM errors:
      customErrorToStatusCodeMap: new Map([
        [EntityNotFoundError.name, 404],
        [CannotCreateEntityIdMapError.name, 422],
        [QueryFailedError.name, 400],
      ])
    }),
  ],
})
export class AppModule {}

Error handling for unauthorized exceptions

You can extend the module to invoke a function when an unauthorized exception is throwed.

import { ErrorInterceptorModule } from "@n4it/utility-error-filter";
import { Module, ArgumentsHost, HttpException } from "@nestjs/common";

@Module({
  imports: [
    ErrorInterceptorModule.register({
      onUnauthorized: (exception: HttpException, host: ArgumentsHost) => {
        // do something here, for example, delete session cookies
      }
    }),
  ],
})
export class AppModule {}

Configuring Slack Alerts

You can extend the module to send alerts to slack.

import { ErrorInterceptorModule } from "@n4it/utility-error-filter";
import { Module, ArgumentsHost, HttpException } from "@nestjs/common";

@Module({
  imports: [
    ErrorInterceptorModule.register({
      slackWebhook: {
        url: "https://hooks.slack.com/services/XXXXXXX/XXXXXX/XXXXXX"
      }
    }),
  ],
})
export class AppModule {}

License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request or open an issue on GitHub.

Support

If you have any questions or need support, you can contact us at [e-mail].