https://github.com/cmradiology/nitro-conditional-middleware
Tools for creating conditional middlewares for nitro
https://github.com/cmradiology/nitro-conditional-middleware
conditional conditional-middleware h3 middleware middlewares nitro nitro-conditional-middleware nitrojs npm npm-package skip skip-middleware typescript
Last synced: 4 months ago
JSON representation
Tools for creating conditional middlewares for nitro
- Host: GitHub
- URL: https://github.com/cmradiology/nitro-conditional-middleware
- Owner: cmradiology
- License: mit
- Created: 2024-11-01T11:44:51.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-01T15:44:41.000Z (over 1 year ago)
- Last Synced: 2025-09-28T08:37:39.247Z (4 months ago)
- Topics: conditional, conditional-middleware, h3, middleware, middlewares, nitro, nitro-conditional-middleware, nitrojs, npm, npm-package, skip, skip-middleware, typescript
- Language: TypeScript
- Homepage:
- Size: 794 KB
- Stars: 1
- Watchers: 5
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# nitro-conditional-middleware
## Development
### install
```bash
npm install
```
### test
```bash
npm run test
```
### lint
```bash
npm run lint:fix
```
### build
```bash
npm run build
```
## Documentation
A brief explanation on how middlewares in nitrojs work.
NitroJS provides as base for their middlewares H3 event handlers created by `defineEventHandler`.
Middlewares in the nitrojs framework are executed in every request.
## Real life scenarios
In this diagram we display 3 different scenarios that our server needs to handle:
- Open API requests
- Authenticated API requests
- HealthCheck Requests
### Problem
Knowing that all events will pass through all middlewares, we need to plan the **flow** based on **conditions** that will **run** or **skip** these middlewares
## Skipping middlewares
With the constrain that the event flow will pass through all middleware event handlers, we needed a way to skip a middleware for some events that will go through the middleware pipeline based on a particular condition.
This library creates a way to pass a condition as parameter to create `defineMiddlewareHandler` functions with a run condition. This function has the same signature as as H3's `defineEventHandler`. Making it a 1:1 substitute.
```ts
type condition = (event: H3Event) => boolean
// This function would return a handler as H3's `defineEventHandler`
const defineMiddlewareHandler = createMiddlewareHandler(condition)
```
### Creating and using multiple `middlewareHandler`s
```ts
// defineApiMiddleware.ts
import { createMiddlewareHandler } from 'nitro-conditional-middleware'
const apiV1MiddlewareHandler = createMiddlewareHandler((event) => {
return event.path.includes('/api/v1/')
})
const apiV2ConditionFn = (event: H3Event) => boolean {
return event.path.includes('/api/v2/')
}
const apiV2MiddlewareHandler = createMiddlewareHandler(apiV2ConditionFn)
```
```ts
// usage 1.my-first-middleware.ts
import { apiV1MiddlewareHandler } from './defineApiMiddleware'
const myFirstMiddleware = (event) => {
console.log('myFirstMiddleware: This will only run in api/v1 endpoints')
}
export default apiV1MiddlewareHandler(myFirstMiddleware)
```
```ts
// usage 2.my-second-middleware.ts
import { apiV2MiddlewareHandler } from './defineApiMiddleware'
export default apiV2MiddlewareHandler((event) => {
console.log('mySecondMiddleware: This will only run in api/v2 endpoints')
})
```