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

60
www/apps/docs/content/references/services/classes/AbstractNotificationService.mdx
View File

@@ -8,13 +8,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Implements
- [`INotificationService`](../interfaces/INotificationService.mdx)
- [INotificationService](../interfaces/INotificationService.mdx)
## Constructors
### constructor
`Protected` **new AbstractNotificationService**(`__container__`, `__configModule__?`, `__moduleDeclaration__?`)
`Protected **new AbstractNotificationService**(__container__, __configModule__?, __moduleDeclaration__?)`
#### Parameters
@@ -30,7 +30,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "__configModule__",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -39,7 +39,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "__moduleDeclaration__",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -53,7 +53,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -71,7 +71,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "__moduleDeclaration__",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -80,7 +80,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "manager_",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": false,
"defaultValue": "",
@@ -89,7 +89,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"type": "`undefined` \\| EntityManager",
"description": "",
"optional": false,
"defaultValue": "",
@@ -111,16 +111,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": "",
@@ -133,7 +133,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
@@ -165,7 +165,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": "",
@@ -174,7 +174,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": "",
@@ -183,7 +183,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": "",
@@ -194,12 +194,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",
@@ -212,7 +212,7 @@ ___
### getIdentifier
**getIdentifier**(): `string`
`**getIdentifier**(): string`
#### Returns
@@ -234,7 +234,7 @@ ___
### resendNotification
`Abstract` **resendNotification**(`notification`, `config`, `attachmentGenerator`): `Promise`<[`ReturnedData`](../types/ReturnedData.mdx)\>
`Abstract **resendNotification**(notification, config, attachmentGenerator): Promise&#60;[ReturnedData](../types/ReturnedData.mdx)&#62;`
#### Parameters
@@ -270,12 +270,12 @@ ___
#### Returns
`Promise`<[`ReturnedData`](../types/ReturnedData.mdx)\>
Promise&#60;[ReturnedData](../types/ReturnedData.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`ReturnedData`](../types/ReturnedData.mdx)\\>",
"type": "Promise&#60;[ReturnedData](../types/ReturnedData.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -288,7 +288,7 @@ ___
### sendNotification
`Abstract` **sendNotification**(`event`, `data`, `attachmentGenerator`): `Promise`<[`ReturnedData`](../types/ReturnedData.mdx)\>
`Abstract **sendNotification**(event, data, attachmentGenerator): Promise&#60;[ReturnedData](../types/ReturnedData.mdx)&#62;`
#### Parameters
@@ -324,12 +324,12 @@ ___
#### Returns
`Promise`<[`ReturnedData`](../types/ReturnedData.mdx)\>
Promise&#60;[ReturnedData](../types/ReturnedData.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`ReturnedData`](../types/ReturnedData.mdx)\\>",
"type": "Promise&#60;[ReturnedData](../types/ReturnedData.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -342,14 +342,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": "",
@@ -378,14 +378,14 @@ ___
### withTransaction
**withTransaction**(`transactionManager?`): [`AbstractNotificationService`](AbstractNotificationService.mdx)
`**withTransaction**(transactionManager?): [AbstractNotificationService](AbstractNotificationService.mdx)`
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": true,
"defaultValue": "",
@@ -396,12 +396,12 @@ ___
#### Returns
[`AbstractNotificationService`](AbstractNotificationService.mdx)
[AbstractNotificationService](AbstractNotificationService.mdx)
<ParameterTypes parameters={[
{
"name": "AbstractNotificationService",
"type": "[`AbstractNotificationService`](AbstractNotificationService.mdx)",
"type": "[AbstractNotificationService](AbstractNotificationService.mdx)",
"optional": false,
"defaultValue": "",
"description": "",