asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 3 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/PaymentService.mdx
+44 -44
View File
@@ -10,14 +10,14 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### constructor
**new PaymentService**(`«destructured»`)
`**new PaymentService**(«destructured»)`
#### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "[`InjectedDependencies`](../types/InjectedDependencies-22.mdx)",
"type": "[InjectedDependencies](../types/InjectedDependencies-22.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -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": "eventBusService_",
"type": "[`EventBusService`](EventBusService.mdx)",
"type": "[EventBusService](EventBusService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -67,7 +67,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "manager_",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": false,
"defaultValue": "",
@@ -76,7 +76,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "paymentProviderService_",
"type": "[`PaymentProviderService`](PaymentProviderService.mdx)",
"type": "[PaymentProviderService](PaymentProviderService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -85,7 +85,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "paymentRepository_",
"type": "`Repository`<[`Payment`](Payment.mdx)\\>",
"type": "Repository&#60;[Payment](Payment.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -94,7 +94,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"type": "`undefined` \\| EntityManager",
"description": "",
"optional": false,
"defaultValue": "",
@@ -170,16 +170,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": "",
@@ -192,7 +192,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
@@ -224,7 +224,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": "",
@@ -233,7 +233,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": "",
@@ -242,7 +242,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": "",
@@ -253,12 +253,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",
@@ -271,7 +271,7 @@ ___
### capture
**capture**(`paymentOrId`): `Promise`<[`Payment`](Payment.mdx)\>
`**capture**(paymentOrId): Promise&#60;[Payment](Payment.mdx)&#62;`
Captures a payment.
@@ -280,7 +280,7 @@ Captures a payment.
<ParameterTypes parameters={[
{
"name": "paymentOrId",
"type": "`string` \\| [`Payment`](Payment.mdx)",
"type": "`string` \\| [Payment](Payment.mdx)",
"description": "the id or the class instance of the payment",
"optional": false,
"defaultValue": "",
@@ -291,12 +291,12 @@ Captures a payment.
#### Returns
`Promise`<[`Payment`](Payment.mdx)\>
Promise&#60;[Payment](Payment.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`Payment`](Payment.mdx)\\>",
"type": "Promise&#60;[Payment](Payment.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the payment captured.",
@@ -309,7 +309,7 @@ ___
### create
**create**(`paymentInput`): `Promise`<[`Payment`](Payment.mdx)\>
`**create**(paymentInput): Promise&#60;[Payment](Payment.mdx)&#62;`
Created a new payment.
@@ -318,7 +318,7 @@ Created a new payment.
<ParameterTypes parameters={[
{
"name": "paymentInput",
"type": "[`PaymentDataInput`](../types/PaymentDataInput.mdx)",
"type": "[PaymentDataInput](../types/PaymentDataInput.mdx)",
"description": "info to create the payment",
"optional": false,
"defaultValue": "",
@@ -329,12 +329,12 @@ Created a new payment.
#### Returns
`Promise`<[`Payment`](Payment.mdx)\>
Promise&#60;[Payment](Payment.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`Payment`](Payment.mdx)\\>",
"type": "Promise&#60;[Payment](Payment.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the payment created.",
@@ -347,7 +347,7 @@ ___
### refund
**refund**(`paymentOrId`, `amount`, `reason`, `note?`): `Promise`<[`Refund`](Refund.mdx)\>
`**refund**(paymentOrId, amount, reason, note?): Promise&#60;[Refund](Refund.mdx)&#62;`
refunds a payment.
@@ -356,7 +356,7 @@ refunds a payment.
<ParameterTypes parameters={[
{
"name": "paymentOrId",
"type": "`string` \\| [`Payment`](Payment.mdx)",
"type": "`string` \\| [Payment](Payment.mdx)",
"description": "the id or the class instance of the payment",
"optional": false,
"defaultValue": "",
@@ -394,12 +394,12 @@ refunds a payment.
#### Returns
`Promise`<[`Refund`](Refund.mdx)\>
Promise&#60;[Refund](Refund.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`Refund`](Refund.mdx)\\>",
"type": "Promise&#60;[Refund](Refund.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the refund created.",
@@ -412,7 +412,7 @@ ___
### retrieve
**retrieve**(`paymentId`, `config?`): `Promise`<[`Payment`](Payment.mdx)\>
`**retrieve**(paymentId, config?): Promise&#60;[Payment](Payment.mdx)&#62;`
Retrieves a payment by id.
@@ -430,7 +430,7 @@ Retrieves a payment by id.
},
{
"name": "config",
"type": "[`FindConfig`](../interfaces/FindConfig.mdx)<[`Payment`](Payment.mdx)\\>",
"type": "[FindConfig](../interfaces/FindConfig.mdx)&#60;[Payment](Payment.mdx)&#62;",
"description": "the config to retrieve the payment",
"optional": false,
"defaultValue": "{}",
@@ -441,12 +441,12 @@ Retrieves a payment by id.
#### Returns
`Promise`<[`Payment`](Payment.mdx)\>
Promise&#60;[Payment](Payment.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`Payment`](Payment.mdx)\\>",
"type": "Promise&#60;[Payment](Payment.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the payment.",
@@ -459,14 +459,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": "",
@@ -495,7 +495,7 @@ ___
### update
**update**(`paymentId`, `data`): `Promise`<[`Payment`](Payment.mdx)\>
`**update**(paymentId, data): Promise&#60;[Payment](Payment.mdx)&#62;`
Updates a payment in order to link it to an order or a swap.
@@ -514,7 +514,7 @@ Updates a payment in order to link it to an order or a swap.
{
"name": "data",
"type": "`object`",
"description": "order_id or swap_id to link the payment",
"description": "order\\_id or swap\\_id to link the payment",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -542,12 +542,12 @@ Updates a payment in order to link it to an order or a swap.
#### Returns
`Promise`<[`Payment`](Payment.mdx)\>
Promise&#60;[Payment](Payment.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`Payment`](Payment.mdx)\\>",
"type": "Promise&#60;[Payment](Payment.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the payment updated.",
@@ -560,14 +560,14 @@ ___
### withTransaction
**withTransaction**(`transactionManager?`): [`PaymentService`](PaymentService.mdx)
`**withTransaction**(transactionManager?): [PaymentService](PaymentService.mdx)`
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": true,
"defaultValue": "",
@@ -578,12 +578,12 @@ ___
#### Returns
[`PaymentService`](PaymentService.mdx)
[PaymentService](PaymentService.mdx)
<ParameterTypes parameters={[
{
"name": "default",
"type": "[`PaymentService`](PaymentService.mdx)",
"type": "[PaymentService](PaymentService.mdx)",
"optional": false,
"defaultValue": "",
"description": "",