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

52
www/apps/docs/content/references/services/classes/AbstractEventBusModuleService.mdx
View File

@@ -8,20 +8,20 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Implements
- [`IEventBusModuleService`](../interfaces/IEventBusModuleService.mdx)
- [IEventBusModuleService](../interfaces/IEventBusModuleService.mdx)
## Constructors
### constructor
**new AbstractEventBusModuleService**()
`**new AbstractEventBusModuleService**()`
## Properties
<ParameterTypes parameters={[
{
"name": "eventToSubscribersMap_",
"type": "`Map`<`string` \\| `symbol`, [`SubscriberDescriptor`](../types/SubscriberDescriptor.mdx)[]\\>",
"type": "Map&#60;string \\| symbol, [SubscriberDescriptor](../types/SubscriberDescriptor.mdx)[]&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -34,16 +34,16 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### eventToSubscribersMap
`get` **eventToSubscribersMap**(): `Map`<`string` \| `symbol`, [`SubscriberDescriptor`](../types/SubscriberDescriptor.mdx)[]\>
`get**eventToSubscribersMap**(): Map&#60;string \| symbol, [SubscriberDescriptor](../types/SubscriberDescriptor.mdx)[]&#62;`
#### Returns
`Map`<`string` \| `symbol`, [`SubscriberDescriptor`](../types/SubscriberDescriptor.mdx)[]\>
Map&#60;string \| symbol, [SubscriberDescriptor](../types/SubscriberDescriptor.mdx)[]&#62;
<ParameterTypes parameters={[
{
"name": "Map",
"type": "`Map`<`string` \\| `symbol`, [`SubscriberDescriptor`](../types/SubscriberDescriptor.mdx)[]\\>",
"type": "Map&#60;string \\| symbol, [SubscriberDescriptor](../types/SubscriberDescriptor.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -56,7 +56,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### emit
`Abstract` **emit**<`T`\>(`eventName`, `data`, `options`): `Promise`<`void`\>
`Abstract **emit**<TypeParameter T>(eventName, data, options): Promise&#60;void&#62;`
<ParameterTypes parameters={[
{
@@ -93,7 +93,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "options",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -104,12 +104,12 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
#### Returns
`Promise`<`void`\>
Promise&#60;void&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -118,7 +118,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
`Abstract` **emit**<`T`\>(`data`): `Promise`<`void`\>
`Abstract **emit**<TypeParameter T>(data): Promise&#60;void&#62;`
<ParameterTypes parameters={[
{
@@ -137,7 +137,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "data",
"type": "[`EmitData`](../types/EmitData.mdx)<`T`\\>[]",
"type": "[EmitData](../types/EmitData.mdx)&#60;T&#62;[]",
"description": "",
"optional": false,
"defaultValue": "",
@@ -148,12 +148,12 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
#### Returns
`Promise`<`void`\>
Promise&#60;void&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -166,7 +166,7 @@ ___
### storeSubscribers
`Protected` **storeSubscribers**(`«destructured»`): `void`
`Protected **storeSubscribers**(«destructured»): void`
#### Parameters
@@ -191,7 +191,7 @@ ___
},
{
"name": "__namedParameters.subscriber",
"type": "[`Subscriber`](../types/Subscriber.mdx)<`unknown`\\>",
"type": "[Subscriber](../types/Subscriber.mdx)&#60;unknown&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -229,7 +229,7 @@ ___
### subscribe
**subscribe**(`eventName`, `subscriber`, `context?`): [`AbstractEventBusModuleService`](AbstractEventBusModuleService.mdx)
`**subscribe**(eventName, subscriber, context?): [AbstractEventBusModuleService](AbstractEventBusModuleService.mdx)`
#### Parameters
@@ -245,7 +245,7 @@ ___
},
{
"name": "subscriber",
"type": "[`Subscriber`](../types/Subscriber.mdx)<`unknown`\\>",
"type": "[Subscriber](../types/Subscriber.mdx)&#60;unknown&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -254,7 +254,7 @@ ___
},
{
"name": "context",
"type": "[`SubscriberContext`](../types/SubscriberContext.mdx)",
"type": "[SubscriberContext](../types/SubscriberContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -265,12 +265,12 @@ ___
#### Returns
[`AbstractEventBusModuleService`](AbstractEventBusModuleService.mdx)
[AbstractEventBusModuleService](AbstractEventBusModuleService.mdx)
<ParameterTypes parameters={[
{
"name": "AbstractEventBusModuleService",
"type": "[`AbstractEventBusModuleService`](AbstractEventBusModuleService.mdx)",
"type": "[AbstractEventBusModuleService](AbstractEventBusModuleService.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -283,7 +283,7 @@ ___
### unsubscribe
**unsubscribe**(`eventName`, `subscriber`, `context`): [`AbstractEventBusModuleService`](AbstractEventBusModuleService.mdx)
`**unsubscribe**(eventName, subscriber, context): [AbstractEventBusModuleService](AbstractEventBusModuleService.mdx)`
#### Parameters
@@ -299,7 +299,7 @@ ___
},
{
"name": "subscriber",
"type": "[`Subscriber`](../types/Subscriber.mdx)<`unknown`\\>",
"type": "[Subscriber](../types/Subscriber.mdx)&#60;unknown&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -308,7 +308,7 @@ ___
},
{
"name": "context",
"type": "[`SubscriberContext`](../types/SubscriberContext.mdx)",
"type": "[SubscriberContext](../types/SubscriberContext.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -319,12 +319,12 @@ ___
#### Returns
[`AbstractEventBusModuleService`](AbstractEventBusModuleService.mdx)
[AbstractEventBusModuleService](AbstractEventBusModuleService.mdx)
<ParameterTypes parameters={[
{
"name": "AbstractEventBusModuleService",
"type": "[`AbstractEventBusModuleService`](AbstractEventBusModuleService.mdx)",
"type": "[AbstractEventBusModuleService](AbstractEventBusModuleService.mdx)",
"optional": false,
"defaultValue": "",
"description": "",