https://github.com/wbhob/nest-middlewares

Common, injectable middlewares for NestJS
https://github.com/wbhob/nest-middlewares

Last synced: 4 days ago
JSON representation

Common, injectable middlewares for NestJS

• Host: GitHub
• URL: https://github.com/wbhob/nest-middlewares
• Owner: wbhob
• License: mit
• Created: 2017-11-23T01:54:38.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2024-12-25T20:41:53.000Z (about 1 month ago)
• Last Synced: 2025-01-25T17:01:40.085Z (11 days ago)
• Language: TypeScript
• Size: 845 KB
• Stars: 390
• Watchers: 8
• Forks: 33
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-nestjs - Nest Middlewares - NestJS 的通用可注入中间件 (资源 / 组件和库)

README

        
[![Coverage Status](https://coveralls.io/repos/github/wbhob/nest-middlewares/badge.svg?branch=master)](https://coveralls.io/github/wbhob/nest-middlewares?branch=master)

# Nest Middlewares

Add the most common Express middlewares to your Nest app with one line.

## System Requirements

This packages requires the following:

- Node.JS 18.0.0 or later

- @nestjs/core and @nestjs/common 10.0.0 or later

## Adding Middlewares

If you want to see a middleware added, I welcome contributions (or you can hire me). I've tried to make this project really easy to extend and hope we can build a resource for the Nest community together. See [CONTRIBUTING.md](CONTRIBUTING.md) for more information on how to create a new middleware. I'll merge and release it if it meets the contributing guidelines. Thank you for your contribution.

## Usage

Take the name of your favorite Express middleware and prefix it with `@nest-middlewares/`.

```

$ npm install --save @nest-middlewares/helmet

```

In your module:

```ts

import { HelmetMiddleware } from '@nest-middlewares/helmet'; // (look around in the source code for the exact class name)

@Module(...)

export class MyModule {

    configure(consumer: MiddlewaresConsumer) {

        // IMPORTANT! Call Middleware.configure BEFORE using it for routes

        HelmetMiddleware.configure( /* options as per helmet docs */ )

        consumer.apply(HelmetMiddleware).forRoutes(

            /* your routes */

        );

    }

}

```

## Currently supports:

- **Compression**

- Connect RID

- Connect Timeout

- **Cookie Parser**

- Cookie Session

- **CORS**

- Csurf

- **Error Handler**

- **Helmet**

- Method Override

- **Morgan**

- Response Time

- Serve Favicon

- Serve Index

- Serve Static

- VHost