914d773d3a
* initialized next.js project * finished markdown sections * added operation schema component * change page metadata * eslint fixes * fixes related to deployment * added response schema * resolve max stack issue * support for different property types * added support for property types * added loading for components * added more loading * type fixes * added oneOf type * removed console * fix replace with push * refactored everything * use static content for description * fixes and improvements * added code examples section * fix path name * optimizations * fixed tag navigation * add support for admin and store references * general enhancements * optimizations and fixes * fixes and enhancements * added search bar * loading enhancements * added loading * added code blocks * added margin top * add empty response text * fixed oneOf parameters * added path and query parameters * general fixes * added base path env variable * small fix for arrays * enhancements * design enhancements * general enhancements * fix isRequired * added enum values * enhancements * general fixes * general fixes * changed oas generation script * additions to the introduction section * added copy button for code + other enhancements * fix response code block * fix metadata * formatted store introduction * move sidebar logic to Tags component * added test env variables * fix code block bug * added loading animation * added expand param + loading * enhance operation loading * made responsive + improvements * added loading provider * fixed loading * adjustments for small devices * added sidebar label for endpoints * added feedback component * fixed analytics * general fixes * listen to scroll for other headings * added sample env file * update api ref files + support new fields * fix for external docs link * added new sections * fix last item in sidebar not showing * move docs content to www/docs * change redirect url * revert change * resolve build errors * configure rewrites * changed to environment variable url * revert changing environment variable name * add environment variable for API path * fix links * fix tailwind settings * remove vercel file * reconfigured api route * move api page under api * fix page metadata * fix external link in navigation bar * update api spec * updated api specs * fixed google lint error * add max-height on request samples * add padding before loading * fix for one of name * fix undefined types * general fixes * remove response schema example * redesigned navigation bar * redesigned sidebar * fixed up paddings * added feedback component + report issue * fixed up typography, padding, and general styling * redesigned code blocks * optimization * added error timeout * fixes * added indexing with algolia + fixes * fix errors with algolia script * redesign operation sections * fix heading scroll * design fixes * fix padding * fix padding + scroll issues * fix scroll issues * improve scroll performance * fixes for safari * optimization and fixes * fixes to docs + details animation * padding fixes for code block * added tab animation * fixed incorrect link * added selection styling * fix lint errors * redesigned details component * added detailed feedback form * api reference fixes * fix tabs * upgrade + fixes * updated documentation links * optimizations to sidebar items * fix spacing in sidebar item * optimizations and fixes * fix endpoint path styling * remove margin * final fixes * change margin on small devices * generated OAS * fixes for mobile * added feedback modal * optimize dark mode button * fixed color mode useeffect * minimize dom size * use new style system * radius and spacing design system * design fixes * fix eslint errors * added meta files * change cron schedule * fix docusaurus configurations * added operating system to feedback data * change content directory name * fixes to contribution guidelines * revert renaming content * added api-reference to documentation workflow * fixes for search * added dark mode + fixes * oas fixes * handle bugs * added code examples for clients * changed tooltip text * change authentication to card * change page title based on selected section * redesigned mobile navbar * fix icon colors * fix key colors * fix medusa-js installation command * change external regex in algolia * change changeset * fix padding on mobile * fix hydration error * update depedencies
5.7 KiB
Class: MiddlewareService
Orchestrates dynamic middleware registered through the Medusa Middleware API
Constructors
constructor
• new MiddlewareService()
Defined in
medusa/src/services/middleware.ts:22
Properties
postAuthentication_
• Protected Readonly postAuthentication_: middlewareType[]
Defined in
medusa/src/services/middleware.ts:17
preAuthentication_
• Protected Readonly preAuthentication_: middlewareType[]
Defined in
medusa/src/services/middleware.ts:18
preCartCreation_
• Protected Readonly preCartCreation_: RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>[]
Defined in
medusa/src/services/middleware.ts:19
routers
• Protected Readonly routers: Record<string, Router[]>
Defined in
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
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
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
medusa/src/services/middleware.ts:96
addRouter
▸ addRouter(path, router): void
Parameters
| Name | Type |
|---|---|
path |
string |
router |
Router |
Returns
void
Defined in
medusa/src/services/middleware.ts:29
getRouters
▸ getRouters(path): Router[]
Parameters
| Name | Type |
|---|---|
path |
string |
Returns
Router[]
Defined in
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
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
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
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