@wthek/nestjs-middleware
Version:
NestJS middleware for handling and formatting errors using http-error-kit. Automatically detects and supports both Express and Fastify-based NestJS apps to ensure structured error responses with correct HTTP status codes.
118 lines (83 loc) ā¢ 6.48 kB
Markdown
# Official @wthek Extension ā NestJS Middleware for `http-error-kit`
**Seamless NestJS Error Handling with @wthek**
_Built for applications powered by [http-error-kit][http-error-kit], this middleware ensures that all `http-error-kit` errors are properly formatted and returned with the correct HTTP status codes._
> š” What the HEK?! Need a hassle-free way to manage error responses for `http-error-kit` errors in NestJS? `@wthek/nestjs-middleware` has got you covered!
ā
**Supports both Express and Fastify** underlying NestJS apps out of the box.
[](https://www.npmjs.com/package/@wthek/nestjs-middleware)
[](LICENSE)
[](https://github.com/Skillnter/wthek-nestjs-middleware/issues)
[](https://app.codacy.com/gh/Skillnter/wthek-nestjs-middleware/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage)
[](https://app.codacy.com/gh/Skillnter/wthek-nestjs-middleware/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
[](https://socket.dev/npm/package/@wthek/nestjs-middleware/overview/1.0.1)
[](https://skillnter.github.io/wthek-nestjs-middleware/)
[](https://github.com/sponsors/Skillnter)
[](https://opencollective.com/skillnter)
[](https://www.buymeacoffee.com/skillnter)
[](https://www.patreon.com/skillnter)
[](https://www.paypal.me/skillnte)
## Features
- **Official `http-error-kit` Extension** ā The recommended middleware for NestJS apps.
- **Dual Engine Support** ā Works with both Express and Fastify-based NestJS apps.
- **Auto-sets HTTP status codes** ā Ensures the response status matches the error type.
- **Plug-and-Play Middleware** ā Just drop it before starting your server!
- **Graceful Fallbacks** ā Passes unrecognized errors to the next middleware.
## Table of Content
- [Installation](#installation)
- [Usage](#usage)
- [How It Works](#how-it-works)
- [Why Use @wthek/nestjs-middleware?](#why-use-wtheknestjs-middleware)
- [Explore More WTHek Extensions](#explore-more-wthek-extensions)
- [People](#people)
- [Donations](#donations)
- [License](#license)
## Installation
```console
npm install @wthek/nestjs-middleware
```
## Usage
**Add Middleware Just Before Starting the Server**
To catch all errors correctly, place `KitNestJsMiddleware(app)` in `main.ts` file before starting the NestJS server.
```Typescript
import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';
import { KitNestJsMiddleware } from '@wthek/nestjs-middleware';
async function bootstrap() {
const app = await NestFactory.create(AppModule);
KitNestJsMiddleware(app);
await app.listen(process.env.PORT ?? 3000);
}
bootstrap();
```
## How It Works
- Catches errors thrown in routes and middleware
- Checks if the error is an instance of any `http-error-kit` Errors
- Formats the error response and sets the correct HTTP status code
- Passes other errors to the next middleware (_so they can be handled separately_)
## Why Use `@wthek/nestjs-middleware`?
- **No more manual error handling** ā Status codes are automatically set.
- **Consistent API responses** ā Standardized errors improve debugging & logging.
- **Works perfectly with `http-error-kit`** ā Fully compatible with existing `http-error-kit` error structures.
## Explore More WTHek Extensions
The WTHek ecosystem continues to grow with new extensions to simplify error handling across various frameworks and libraries. Stay updated with the latest tools that integrate seamlessly with `http-error-kit`.
**Check out the official list of extensions**: [Official Extensions List](https://github.com/Skillnter/http-error-kit/wiki/Official-Extensions-List)
## People
The original author of the project is [Himanshu Bansal][skillnter]
## Donations
**This is all voluntary work**, so if you want to support my efforts you can
- [Buy Me A Coffee](https://www.buymeacoffee.com/skillnter)
- [Paypal](https://www.paypal.me/skillnte)
- [GitHub Sponsor](https://github.com/sponsors/Skillnter)
- [Patreon](https://www.patreon.com/skillnter)
- [Open Collective](https://opencollective.com/skillnter)
You can also use the following:
## License
`@wthek/nestjs-middleware` project is open-sourced software licensed under the [MIT license](LICENSE) by [Himanshu Bansal][skillnter].
[skillnter]: https://github.com/Skillnter/
[http-error-kit]: https://www.npmjs.com/package/http-error-kit