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_
• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard postAuthentication_: middlewareTypeCopy to Clipboard[]
Defined in
packages/medusa/src/services/middleware.ts:17
preAuthentication_
• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard preAuthentication_: middlewareTypeCopy to Clipboard[]
Defined in
packages/medusa/src/services/middleware.ts:18
preCartCreation_
• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard preCartCreation_: RequestHandlerCopy to Clipboard<ParamsDictionaryCopy to Clipboard, anyCopy to Clipboard, anyCopy to Clipboard, ParsedQsCopy to Clipboard, RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard>>[]
Defined in
packages/medusa/src/services/middleware.ts:19
routers
• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard routers: RecordCopy to Clipboard<stringCopy to Clipboard, RouterCopy to Clipboard[]>
Defined in
packages/medusa/src/services/middleware.ts:20
Methods
addPostAuthentication
▸ addPostAuthentication(middlewareCopy to Clipboard, optionsCopy to Clipboard): voidCopy to Clipboard
Adds a middleware function to be called after authentication is completed.
Parameters
| Name | Type | Description |
|---|---|---|
middlewareCopy to Clipboard | middlewareHandlerTypeCopy to Clipboard | the middleware function. Should return a middleware function. |
optionsCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard> | the arguments that will be passed to the middleware |
Returns
voidCopy to Clipboard
void
Defined in
packages/medusa/src/services/middleware.ts:60
addPreAuthentication
▸ addPreAuthentication(middlewareCopy to Clipboard, optionsCopy to Clipboard): voidCopy to Clipboard
Adds a middleware function to be called before authentication is completed.
Parameters
| Name | Type | Description |
|---|---|---|
middlewareCopy to Clipboard | middlewareHandlerTypeCopy to Clipboard | the middleware function. Should return a middleware function. |
optionsCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard> | the arguments that will be passed to the middleware |
Returns
voidCopy to Clipboard
void
Defined in
packages/medusa/src/services/middleware.ts:79
addPreCartCreation
▸ addPreCartCreation(middlewareCopy to Clipboard): voidCopy to Clipboard
Adds a middleware function to be called before cart creation
Parameters
| Name | Type | Description |
|---|---|---|
middlewareCopy to Clipboard | RequestHandlerCopy to Clipboard<ParamsDictionaryCopy to Clipboard, anyCopy to Clipboard, anyCopy to Clipboard, ParsedQsCopy to Clipboard, RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard>> | the middleware function. Should return a middleware function. |
Returns
voidCopy to Clipboard
Defined in
packages/medusa/src/services/middleware.ts:96
addRouter
▸ addRouter(pathCopy to Clipboard, routerCopy to Clipboard): voidCopy to Clipboard
Parameters
| Name | Type |
|---|---|
pathCopy to Clipboard | stringCopy to Clipboard |
routerCopy to Clipboard | RouterCopy to Clipboard |
Returns
voidCopy to Clipboard
Defined in
packages/medusa/src/services/middleware.ts:29
getRouters
▸ getRouters(pathCopy to Clipboard): RouterCopy to Clipboard[]
Parameters
| Name | Type |
|---|---|
pathCopy to Clipboard | stringCopy to Clipboard |
Returns
RouterCopy to Clipboard[]
Defined in
packages/medusa/src/services/middleware.ts:34
usePostAuthentication
▸ usePostAuthentication(appCopy to Clipboard): voidCopy to Clipboard
Adds post authentication middleware to an express app.
Parameters
| Name | Type | Description |
|---|---|---|
appCopy to Clipboard | RouterCopy to Clipboard | the express app to add the middleware to |
Returns
voidCopy to Clipboard
Defined in
packages/medusa/src/services/middleware.ts:106
usePreAuthentication
▸ usePreAuthentication(appCopy to Clipboard): voidCopy to Clipboard
Adds pre authentication middleware to an express app.
Parameters
| Name | Type | Description |
|---|---|---|
appCopy to Clipboard | RouterCopy to Clipboard | the express app to add the middleware to |
Returns
voidCopy to Clipboard
Defined in
packages/medusa/src/services/middleware.ts:117
usePreCartCreation
▸ usePreCartCreation(): RequestHandlerCopy to Clipboard<ParamsDictionaryCopy to Clipboard, anyCopy to Clipboard, anyCopy to Clipboard, ParsedQsCopy to Clipboard, RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard>>[]
Returns
RequestHandlerCopy to Clipboard<ParamsDictionaryCopy to Clipboard, anyCopy to Clipboard, anyCopy to Clipboard, ParsedQsCopy to Clipboard, RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard>>[]
Defined in
packages/medusa/src/services/middleware.ts:123
validateMiddleware_
▸ validateMiddleware_(fnCopy to Clipboard): voidCopy to Clipboard
Validates a middleware function, throws if fn is not of type function.
Parameters
| Name | Type | Description |
|---|---|---|
fnCopy to Clipboard | unknownCopy to Clipboard | the middleware function to validate. |
Returns
voidCopy to Clipboard
nothing if the middleware is a function