@nest-boot/middleware
Classes
MiddlewareConfigurator
Defined in: middleware.configurator.ts:10
Configurator for applying middlewares to routes.
Methods
dependencies()
dependencies(...dependencyMiddlewares): this;
Defined in: middleware.configurator.ts:35
Parameters
| Parameter | Type |
|---|---|
...dependencyMiddlewares | Type<NestMiddleware<any, any>>[] |
Returns
this
disableGlobalExcludeRoutes()
disableGlobalExcludeRoutes(): this;
Defined in: middleware.configurator.ts:25
Returns
this
exclude()
exclude(...routes): this;
Defined in: middleware.configurator.ts:30
Parameters
| Parameter | Type |
|---|---|
...routes | (string | RouteInfo)[] |
Returns
this
forRoutes()
forRoutes(...routes): MiddlewareManager;
Defined in: middleware.configurator.ts:40
Parameters
| Parameter | Type |
|---|---|
...routes | (string | Type<any> | RouteInfo)[] |
Returns
MiddlewareManager
Defined in: middleware.manager.ts:12
Manages middleware registration and configuration.
Constructors
Constructor
new MiddlewareManager(): MiddlewareManager;
Returns
Methods
apply()
apply(...middlewares): MiddlewareConfigurator;
Defined in: middleware.manager.ts:81
Applies middlewares to routes.
Parameters
| Parameter | Type | Description |
|---|---|---|
...middlewares | MiddlewareInstanceOrFunction[] | The middlewares to apply |
Returns
A configurator for specifying routes
configure()
configure(consumer): void;
Defined in: middleware.manager.ts:92
Parameters
| Parameter | Type |
|---|---|
consumer | MiddlewareConsumer |
Returns
void
globalExclude()
globalExclude(...routes): this;
Defined in: middleware.manager.ts:87
Parameters
| Parameter | Type |
|---|---|
...routes | (string | RouteInfo)[] |
Returns
this
MiddlewareModule
Defined in: middleware.module.ts:10
Implements
NestModule
Constructors
Constructor
new MiddlewareModule(middlewareManager): MiddlewareModule;
Defined in: middleware.module.ts:11
Parameters
| Parameter | Type |
|---|---|
middlewareManager | MiddlewareManager |
Returns
Methods
configure()
configure(consumer): void;
Defined in: middleware.module.ts:13
Parameters
| Parameter | Type |
|---|---|
consumer | MiddlewareConsumer |
Returns
void
Implementation of
NestModule.configure
Type Aliases
MiddlewareFunction()
type MiddlewareFunction<TRequest, TResponse> = (req, res, next) => any;
Defined in: types/middleware-function.type.ts:4
Middleware function type.
Type Parameters
| Type Parameter |
|---|
TRequest |
TResponse |
Parameters
| Parameter | Type |
|---|---|
req | TRequest |
res | TResponse |
next | (error?) => void |
Returns
any
MiddlewareInstanceOrFunction
type MiddlewareInstanceOrFunction<TRequest, TResponse> =
| NestMiddleware<TRequest, TResponse>
| MiddlewareFunction<TRequest, TResponse>;
Defined in: types/middleware-instance-or-function.type.ts:8
Middleware instance or function.
Type Parameters
| Type Parameter |
|---|
TRequest |
TResponse |