chore: fixed commit branch on generate reference action (#1857)
* fixed commit branch * fixes after yarn upgrade
This commit is contained in:
Shahed Nasser
GitHub
@@ -1,7 +1,5 @@
|
||||
# Class: MiddlewareService
|
||||
|
||||
Orchestrates dynamic middleware registered through the Medusa Middleware API
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
@@ -16,7 +14,7 @@ Orchestrates dynamic middleware registered through the Medusa Middleware API
|
||||
|
||||
#### Defined in
|
||||
|
||||
[services/middleware.js:7](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/middleware.js#L7)
|
||||
[services/middleware.js:7](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/middleware.js#L7)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -26,7 +24,7 @@ Orchestrates dynamic middleware registered through the Medusa Middleware API
|
||||
|
||||
#### Defined in
|
||||
|
||||
[services/middleware.js:8](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/middleware.js#L8)
|
||||
[services/middleware.js:8](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/middleware.js#L8)
|
||||
|
||||
___
|
||||
|
||||
@@ -36,7 +34,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[services/middleware.js:9](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/middleware.js#L9)
|
||||
[services/middleware.js:9](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/middleware.js#L9)
|
||||
|
||||
___
|
||||
|
||||
@@ -46,7 +44,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[services/middleware.js:10](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/middleware.js#L10)
|
||||
[services/middleware.js:10](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/middleware.js#L10)
|
||||
|
||||
___
|
||||
|
||||
@@ -56,7 +54,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[services/middleware.js:11](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/middleware.js#L11)
|
||||
[services/middleware.js:11](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/middleware.js#L11)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -64,14 +62,12 @@ ___
|
||||
|
||||
▸ **addPostAuthentication**(`middleware`, `options`): `void`
|
||||
|
||||
Adds a middleware function to be called after authentication is completed.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `middleware` | `Function` | the middleware function. Should return a middleware function. |
|
||||
| `options` | `any` | the arguments that will be passed to the middleware |
|
||||
| `middleware` | `Function` | |
|
||||
| `options` | `any` | |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -79,7 +75,7 @@ Adds a middleware function to be called after authentication is completed.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[services/middleware.js:45](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/middleware.js#L45)
|
||||
[services/middleware.js:45](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/middleware.js#L45)
|
||||
|
||||
___
|
||||
|
||||
@@ -87,14 +83,12 @@ ___
|
||||
|
||||
▸ **addPreAuthentication**(`middleware`, `options`): `void`
|
||||
|
||||
Adds a middleware function to be called before authentication is completed.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `middleware` | `Function` | the middleware function. Should return a middleware function. |
|
||||
| `options` | `any` | the arguments that will be passed to the middleware |
|
||||
| `middleware` | `Function` | |
|
||||
| `options` | `any` | |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -102,7 +96,7 @@ Adds a middleware function to be called before authentication is completed.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[services/middleware.js:61](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/middleware.js#L61)
|
||||
[services/middleware.js:61](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/middleware.js#L61)
|
||||
|
||||
___
|
||||
|
||||
@@ -110,13 +104,11 @@ ___
|
||||
|
||||
▸ **addPreCartCreation**(`middleware`): `void`
|
||||
|
||||
Adds a middleware function to be called before cart creation
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `middleware` | `Function` | the middleware function. Should return a middleware function. |
|
||||
| `middleware` | `Function` | |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -124,7 +116,7 @@ Adds a middleware function to be called before cart creation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[services/middleware.js:75](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/middleware.js#L75)
|
||||
[services/middleware.js:75](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/middleware.js#L75)
|
||||
|
||||
___
|
||||
|
||||
@@ -145,7 +137,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[services/middleware.js:14](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/middleware.js#L14)
|
||||
[services/middleware.js:14](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/middleware.js#L14)
|
||||
|
||||
___
|
||||
|
||||
@@ -165,7 +157,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[services/middleware.js:19](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/middleware.js#L19)
|
||||
[services/middleware.js:19](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/middleware.js#L19)
|
||||
|
||||
___
|
||||
|
||||
@@ -173,13 +165,11 @@ ___
|
||||
|
||||
▸ **usePostAuthentication**(`app`): `void`
|
||||
|
||||
Adds post authentication middleware to an express app.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `app` | `ExpressApp` | the express app to add the middleware to |
|
||||
| `app` | `ExpressApp` | |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -187,7 +177,7 @@ Adds post authentication middleware to an express app.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[services/middleware.js:85](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/middleware.js#L85)
|
||||
[services/middleware.js:85](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/middleware.js#L85)
|
||||
|
||||
___
|
||||
|
||||
@@ -195,13 +185,11 @@ ___
|
||||
|
||||
▸ **usePreAuthentication**(`app`): `void`
|
||||
|
||||
Adds pre authentication middleware to an express app.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `app` | `ExpressApp` | the express app to add the middleware to |
|
||||
| `app` | `ExpressApp` | |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -209,7 +197,7 @@ Adds pre authentication middleware to an express app.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[services/middleware.js:96](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/middleware.js#L96)
|
||||
[services/middleware.js:96](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/middleware.js#L96)
|
||||
|
||||
___
|
||||
|
||||
@@ -223,7 +211,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[services/middleware.js:102](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/middleware.js#L102)
|
||||
[services/middleware.js:102](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/middleware.js#L102)
|
||||
|
||||
___
|
||||
|
||||
@@ -231,13 +219,11 @@ ___
|
||||
|
||||
▸ **validateMiddleware_**(`fn`): `void`
|
||||
|
||||
Validates a middleware function, throws if fn is not of type function.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `fn` | `Function` | the middleware function to validate. |
|
||||
| `fn` | `Function` | |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -245,4 +231,4 @@ Validates a middleware function, throws if fn is not of type function.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[services/middleware.js:28](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/middleware.js#L28)
|
||||
[services/middleware.js:28](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/middleware.js#L28)
|
||||
|
||||
Reference in New Issue
Block a user