asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: update docusaurus to v3 (#5625)

Browse Source 
* update dependencies

* update onboarding mdx

* fixes for mdx issues

* fixes for mdx compatibility

* resolve mdx errors

* fixes in reference

* fix check errors

* revert change in vale action

* fix node version in action

* fix summary in markdown
This commit is contained in:
Shahed Nasser
2023-11-13 20:11:50 +02:00
committed by GitHub
parent cedab58339
commit c6dff873de
2265 changed files with 46163 additions and 47195 deletions
Download Patch File Download Diff File Expand all files Collapse all files

54
www/apps/docs/content/references/services/classes/MiddlewareService.mdx
View File

@@ -12,14 +12,14 @@ Orchestrates dynamic middleware registered through the Medusa Middleware API
### constructor
**new MiddlewareService**()
`**new MiddlewareService**()`
## Properties
<ParameterTypes parameters={[
{
"name": "postAuthentication_",
"type": "[`middlewareType`](../types/middlewareType.mdx)[]",
"type": "[middlewareType](../types/middlewareType.mdx)[]",
"description": "",
"optional": false,
"defaultValue": "",
@@ -28,7 +28,7 @@ Orchestrates dynamic middleware registered through the Medusa Middleware API
},
{
"name": "preAuthentication_",
"type": "[`middlewareType`](../types/middlewareType.mdx)[]",
"type": "[middlewareType](../types/middlewareType.mdx)[]",
"description": "",
"optional": false,
"defaultValue": "",
@@ -37,7 +37,7 @@ Orchestrates dynamic middleware registered through the Medusa Middleware API
},
{
"name": "preCartCreation_",
"type": "`RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, Record<`string`, `any`\\>\\>[]",
"type": "RequestHandler&#60;ParamsDictionary, any, any, ParsedQs, Record&#60;string, any&#62;&#62;[]",
"description": "",
"optional": false,
"defaultValue": "",
@@ -46,7 +46,7 @@ Orchestrates dynamic middleware registered through the Medusa Middleware API
},
{
"name": "routers",
"type": "Record<`string`, `Router`[]\\>",
"type": "`Record<string, Router[]>`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -59,7 +59,7 @@ Orchestrates dynamic middleware registered through the Medusa Middleware API
### addPostAuthentication
**addPostAuthentication**(`middleware`, `options`): `void`
`**addPostAuthentication**(middleware, options): void`
Adds a middleware function to be called after authentication is completed.
@@ -68,7 +68,7 @@ Adds a middleware function to be called after authentication is completed.
<ParameterTypes parameters={[
{
"name": "middleware",
"type": "[`middlewareHandlerType`](../types/middlewareHandlerType.mdx)",
"type": "[middlewareHandlerType](../types/middlewareHandlerType.mdx)",
"description": "the middleware function. Should return a middleware function.",
"optional": false,
"defaultValue": "",
@@ -77,7 +77,7 @@ Adds a middleware function to be called after authentication is completed.
},
{
"name": "options",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "the arguments that will be passed to the middleware",
"optional": false,
"defaultValue": "",
@@ -106,7 +106,7 @@ ___
### addPreAuthentication
**addPreAuthentication**(`middleware`, `options`): `void`
`**addPreAuthentication**(middleware, options): void`
Adds a middleware function to be called before authentication is completed.
@@ -115,7 +115,7 @@ Adds a middleware function to be called before authentication is completed.
<ParameterTypes parameters={[
{
"name": "middleware",
"type": "[`middlewareHandlerType`](../types/middlewareHandlerType.mdx)",
"type": "[middlewareHandlerType](../types/middlewareHandlerType.mdx)",
"description": "the middleware function. Should return a middleware function.",
"optional": false,
"defaultValue": "",
@@ -124,7 +124,7 @@ Adds a middleware function to be called before authentication is completed.
},
{
"name": "options",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "the arguments that will be passed to the middleware",
"optional": false,
"defaultValue": "",
@@ -153,7 +153,7 @@ ___
### addPreCartCreation
**addPreCartCreation**(`middleware`): `void`
`**addPreCartCreation**(middleware): void`
Adds a middleware function to be called before cart creation
@@ -162,7 +162,7 @@ Adds a middleware function to be called before cart creation
<ParameterTypes parameters={[
{
"name": "middleware",
"type": "`RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, Record<`string`, `any`\\>\\>",
"type": "RequestHandler&#60;ParamsDictionary, any, any, ParsedQs, Record&#60;string, any&#62;&#62;",
"description": "the middleware function. Should return a middleware function.",
"optional": false,
"defaultValue": "",
@@ -191,7 +191,7 @@ ___
### addRouter
**addRouter**(`path`, `router`): `void`
`**addRouter**(path, router): void`
#### Parameters
@@ -207,7 +207,7 @@ ___
},
{
"name": "router",
"type": "`Router`",
"type": "Router",
"description": "",
"optional": false,
"defaultValue": "",
@@ -236,7 +236,7 @@ ___
### getRouters
**getRouters**(`path`): `Router`[]
`**getRouters**(path): Router[]`
#### Parameters
@@ -254,12 +254,12 @@ ___
#### Returns
`Router`[]
Router[]
<ParameterTypes parameters={[
{
"name": "Router[]",
"type": "`Router`[]",
"type": "Router[]",
"optional": false,
"defaultValue": "",
"description": "",
@@ -272,7 +272,7 @@ ___
### usePostAuthentication
**usePostAuthentication**(`app`): `void`
`**usePostAuthentication**(app): void`
Adds post authentication middleware to an express app.
@@ -281,7 +281,7 @@ Adds post authentication middleware to an express app.
<ParameterTypes parameters={[
{
"name": "app",
"type": "`Router`",
"type": "Router",
"description": "the express app to add the middleware to",
"optional": false,
"defaultValue": "",
@@ -310,7 +310,7 @@ ___
### usePreAuthentication
**usePreAuthentication**(`app`): `void`
`**usePreAuthentication**(app): void`
Adds pre authentication middleware to an express app.
@@ -319,7 +319,7 @@ Adds pre authentication middleware to an express app.
<ParameterTypes parameters={[
{
"name": "app",
"type": "`Router`",
"type": "Router",
"description": "the express app to add the middleware to",
"optional": false,
"defaultValue": "",
@@ -348,16 +348,16 @@ ___
### usePreCartCreation
**usePreCartCreation**(): `RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, Record<`string`, `any`\>\>[]
`**usePreCartCreation**(): RequestHandler&#60;ParamsDictionary, any, any, ParsedQs, Record&#60;string, any&#62;&#62;[]`
#### Returns
`RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, Record<`string`, `any`\>\>[]
RequestHandler&#60;ParamsDictionary, any, any, ParsedQs, Record&#60;string, any&#62;&#62;[]
<ParameterTypes parameters={[
{
"name": "RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any\\>\\>[]",
"type": "`RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, Record<`string`, `any`\\>\\>[]",
"name": "RequestHandler&#60;ParamsDictionary, any, any, ParsedQs, Record&#60;string, any&#62;&#62;[]",
"type": "RequestHandler&#60;ParamsDictionary, any, any, ParsedQs, Record&#60;string, any&#62;&#62;[]",
"optional": false,
"defaultValue": "",
"description": "",
@@ -370,7 +370,7 @@ ___
### validateMiddleware\_
**validateMiddleware_**(`fn`): `void`
`**validateMiddleware_**(fn): void`
Validates a middleware function, throws if fn is not of type function.