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
www/apps/docs/content/references/services/classes/SystemPaymentProviderService.mdx
+50 -50
View File
@@ -10,7 +10,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### constructor
**new SystemPaymentProviderService**(`_`)
`**new SystemPaymentProviderService**(_)`
#### Parameters
@@ -31,7 +31,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -49,7 +49,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "__moduleDeclaration__",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -58,7 +58,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "manager_",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": false,
"defaultValue": "",
@@ -67,7 +67,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"type": "`undefined` \\| EntityManager",
"description": "",
"optional": false,
"defaultValue": "",
@@ -89,16 +89,16 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### activeManager\_
`Protected` `get` **activeManager_**(): `EntityManager`
`Protected get**activeManager_**(): EntityManager`
#### Returns
`EntityManager`
EntityManager
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"type": "EntityManager",
"optional": false,
"defaultValue": "",
"description": "",
@@ -111,7 +111,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### atomicPhase\_
`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
`Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise&#60;TResult&#62;`
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
@@ -143,7 +143,7 @@ transaction manager is created.
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => `Promise`<`TResult`\\>",
"type": "(`transactionManager`: EntityManager) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
@@ -152,7 +152,7 @@ transaction manager is created.
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
@@ -161,7 +161,7 @@ transaction manager is created.
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
@@ -172,12 +172,12 @@ transaction manager is created.
#### Returns
`Promise`<`TResult`\>
Promise&#60;TResult&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`TResult`\\>",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
@@ -190,7 +190,7 @@ ___
### authorizePayment
**authorizePayment**(`_`): `Promise`<Record<`string`, `unknown`\>\>
`**authorizePayment**(_): Promise&#60;Record&#60;string, unknown&#62;&#62;`
#### Parameters
@@ -208,12 +208,12 @@ ___
#### Returns
`Promise`<Record<`string`, `unknown`\>\>
Promise&#60;Record&#60;string, unknown&#62;&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<Record<`string`, `unknown`\\>\\>",
"type": "Promise&#60;Record&#60;string, unknown&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -226,7 +226,7 @@ ___
### cancelPayment
**cancelPayment**(`_`): `Promise`<Record<`string`, `unknown`\>\>
`**cancelPayment**(_): Promise&#60;Record&#60;string, unknown&#62;&#62;`
#### Parameters
@@ -244,12 +244,12 @@ ___
#### Returns
`Promise`<Record<`string`, `unknown`\>\>
Promise&#60;Record&#60;string, unknown&#62;&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<Record<`string`, `unknown`\\>\\>",
"type": "Promise&#60;Record&#60;string, unknown&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -262,7 +262,7 @@ ___
### capturePayment
**capturePayment**(`_`): `Promise`<Record<`string`, `unknown`\>\>
`**capturePayment**(_): Promise&#60;Record&#60;string, unknown&#62;&#62;`
#### Parameters
@@ -280,12 +280,12 @@ ___
#### Returns
`Promise`<Record<`string`, `unknown`\>\>
Promise&#60;Record&#60;string, unknown&#62;&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<Record<`string`, `unknown`\\>\\>",
"type": "Promise&#60;Record&#60;string, unknown&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -298,7 +298,7 @@ ___
### createPayment
**createPayment**(`_`): `Promise`<Record<`string`, `unknown`\>\>
`**createPayment**(_): Promise&#60;Record&#60;string, unknown&#62;&#62;`
#### Parameters
@@ -316,12 +316,12 @@ ___
#### Returns
`Promise`<Record<`string`, `unknown`\>\>
Promise&#60;Record&#60;string, unknown&#62;&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<Record<`string`, `unknown`\\>\\>",
"type": "Promise&#60;Record&#60;string, unknown&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -334,7 +334,7 @@ ___
### deletePayment
**deletePayment**(`_`): `Promise`<Record<`string`, `unknown`\>\>
`**deletePayment**(_): Promise&#60;Record&#60;string, unknown&#62;&#62;`
#### Parameters
@@ -352,12 +352,12 @@ ___
#### Returns
`Promise`<Record<`string`, `unknown`\>\>
Promise&#60;Record&#60;string, unknown&#62;&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<Record<`string`, `unknown`\\>\\>",
"type": "Promise&#60;Record&#60;string, unknown&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -370,7 +370,7 @@ ___
### getPaymentData
**getPaymentData**(`_`): `Promise`<Record<`string`, `unknown`\>\>
`**getPaymentData**(_): Promise&#60;Record&#60;string, unknown&#62;&#62;`
#### Parameters
@@ -388,12 +388,12 @@ ___
#### Returns
`Promise`<Record<`string`, `unknown`\>\>
Promise&#60;Record&#60;string, unknown&#62;&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<Record<`string`, `unknown`\\>\\>",
"type": "Promise&#60;Record&#60;string, unknown&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -406,7 +406,7 @@ ___
### getStatus
**getStatus**(`_`): `Promise`<`string`\>
`**getStatus**(_): Promise&#60;string&#62;`
#### Parameters
@@ -424,12 +424,12 @@ ___
#### Returns
`Promise`<`string`\>
Promise&#60;string&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`string`\\>",
"type": "Promise&#60;string&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -442,7 +442,7 @@ ___
### refundPayment
**refundPayment**(`_`): `Promise`<Record<`string`, `unknown`\>\>
`**refundPayment**(_): Promise&#60;Record&#60;string, unknown&#62;&#62;`
#### Parameters
@@ -460,12 +460,12 @@ ___
#### Returns
`Promise`<Record<`string`, `unknown`\>\>
Promise&#60;Record&#60;string, unknown&#62;&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<Record<`string`, `unknown`\\>\\>",
"type": "Promise&#60;Record&#60;string, unknown&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -478,14 +478,14 @@ ___
### shouldRetryTransaction\_
`Protected` **shouldRetryTransaction_**(`err`): `boolean`
`Protected **shouldRetryTransaction_**(err): boolean`
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "Record<`string`, `unknown`\\> \\| { `code`: `string` }",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -514,7 +514,7 @@ ___
### updatePayment
**updatePayment**(`_`): `Promise`<Record<`string`, `unknown`\>\>
`**updatePayment**(_): Promise&#60;Record&#60;string, unknown&#62;&#62;`
#### Parameters
@@ -532,12 +532,12 @@ ___
#### Returns
`Promise`<Record<`string`, `unknown`\>\>
Promise&#60;Record&#60;string, unknown&#62;&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<Record<`string`, `unknown`\\>\\>",
"type": "Promise&#60;Record&#60;string, unknown&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -550,7 +550,7 @@ ___
### updatePaymentData
**updatePaymentData**(`_`): `Promise`<Record<`string`, `unknown`\>\>
`**updatePaymentData**(_): Promise&#60;Record&#60;string, unknown&#62;&#62;`
#### Parameters
@@ -568,12 +568,12 @@ ___
#### Returns
`Promise`<Record<`string`, `unknown`\>\>
Promise&#60;Record&#60;string, unknown&#62;&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<Record<`string`, `unknown`\\>\\>",
"type": "Promise&#60;Record&#60;string, unknown&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -586,14 +586,14 @@ ___
### withTransaction
**withTransaction**(`transactionManager?`): [`SystemPaymentProviderService`](SystemPaymentProviderService.mdx)
`**withTransaction**(transactionManager?): [SystemPaymentProviderService](SystemPaymentProviderService.mdx)`
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": true,
"defaultValue": "",
@@ -604,12 +604,12 @@ ___
#### Returns
[`SystemPaymentProviderService`](SystemPaymentProviderService.mdx)
[SystemPaymentProviderService](SystemPaymentProviderService.mdx)
<ParameterTypes parameters={[
{
"name": "SystemProviderService",
"type": "[`SystemPaymentProviderService`](SystemPaymentProviderService.mdx)",
"type": "[SystemPaymentProviderService](SystemPaymentProviderService.mdx)",
"optional": false,
"defaultValue": "",
"description": "",