github-actions[bot]andOliver Windall Juhl
6e0b9c3991
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Oliver Windall Juhl <59018053+olivermrbl@users.noreply.github.com>
5.8 KiB
Class: MiddlewareService
Orchestrates dynamic middleware registered through the Medusa Middleware API
Constructors
constructor
• new MiddlewareService()
Defined in
packages/medusa/src/services/middleware.ts:22
Properties
postAuthentication_
• Protected Readonly postAuthentication_: middlewareType[]
Defined in
packages/medusa/src/services/middleware.ts:17
preAuthentication_
• Protected Readonly preAuthentication_: middlewareType[]
Defined in
packages/medusa/src/services/middleware.ts:18
preCartCreation_
• Protected Readonly preCartCreation_: RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>[]
Defined in
packages/medusa/src/services/middleware.ts:19
routers
• Protected Readonly routers: Record<string, Router[]>
Defined in
packages/medusa/src/services/middleware.ts:20
Methods
addPostAuthentication
▸ addPostAuthentication(middleware, options): void
Adds a middleware function to be called after authentication is completed.
Parameters
| Name | Type | Description |
|---|---|---|
middleware |
middlewareHandlerType |
the middleware function. Should return a middleware function. |
options |
Record<string, unknown> |
the arguments that will be passed to the middleware |
Returns
void
void
Defined in
packages/medusa/src/services/middleware.ts:60
addPreAuthentication
▸ addPreAuthentication(middleware, options): void
Adds a middleware function to be called before authentication is completed.
Parameters
| Name | Type | Description |
|---|---|---|
middleware |
middlewareHandlerType |
the middleware function. Should return a middleware function. |
options |
Record<string, unknown> |
the arguments that will be passed to the middleware |
Returns
void
void
Defined in
packages/medusa/src/services/middleware.ts:79
addPreCartCreation
▸ addPreCartCreation(middleware): void
Adds a middleware function to be called before cart creation
Parameters
| Name | Type | Description |
|---|---|---|
middleware |
RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>> |
the middleware function. Should return a middleware function. |
Returns
void
Defined in
packages/medusa/src/services/middleware.ts:96
addRouter
▸ addRouter(path, router): void
Parameters
| Name | Type |
|---|---|
path |
string |
router |
Router |
Returns
void
Defined in
packages/medusa/src/services/middleware.ts:29
getRouters
▸ getRouters(path): Router[]
Parameters
| Name | Type |
|---|---|
path |
string |
Returns
Router[]
Defined in
packages/medusa/src/services/middleware.ts:34
usePostAuthentication
▸ usePostAuthentication(app): void
Adds post authentication middleware to an express app.
Parameters
| Name | Type | Description |
|---|---|---|
app |
Router |
the express app to add the middleware to |
Returns
void
Defined in
packages/medusa/src/services/middleware.ts:106
usePreAuthentication
▸ usePreAuthentication(app): void
Adds pre authentication middleware to an express app.
Parameters
| Name | Type | Description |
|---|---|---|
app |
Router |
the express app to add the middleware to |
Returns
void
Defined in
packages/medusa/src/services/middleware.ts:117
usePreCartCreation
▸ usePreCartCreation(): RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>[]
Returns
RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>[]
Defined in
packages/medusa/src/services/middleware.ts:123
validateMiddleware_
▸ validateMiddleware_(fn): void
Validates a middleware function, throws if fn is not of type function.
Parameters
| Name | Type | Description |
|---|---|---|
fn |
unknown |
the middleware function to validate. |
Returns
void
nothing if the middleware is a function