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

116
www/apps/docs/content/references/services/classes/EventBusService.mdx
View File

@@ -11,20 +11,20 @@ subscribers when events happen. Events will run asynchronously.
## Implements
- [`IEventBusService`](../interfaces/IEventBusService.mdx)
- [IEventBusService](../interfaces/IEventBusService.mdx)
## Constructors
### constructor
**new EventBusService**(`«destructured»`, `config`, `isSingleton?`)
`**new EventBusService**(«destructured», config, isSingleton?)`
#### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "[`InjectedDependencies`](../types/InjectedDependencies-10.mdx)",
"type": "[InjectedDependencies](../types/InjectedDependencies-10.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -56,7 +56,7 @@ subscribers when events happen. Events will run asynchronously.
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -74,7 +74,7 @@ subscribers when events happen. Events will run asynchronously.
},
{
"name": "__moduleDeclaration__",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -83,7 +83,7 @@ subscribers when events happen. Events will run asynchronously.
},
{
"name": "config_",
"type": "[`ConfigModule`](../types/ConfigModule.mdx)",
"type": "[ConfigModule](../types/ConfigModule.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -92,7 +92,7 @@ subscribers when events happen. Events will run asynchronously.
},
{
"name": "enqueue_",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -101,7 +101,7 @@ subscribers when events happen. Events will run asynchronously.
},
{
"name": "logger_",
"type": "[`Logger`](../interfaces/Logger.mdx)",
"type": "[Logger](../interfaces/Logger.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -110,7 +110,7 @@ subscribers when events happen. Events will run asynchronously.
},
{
"name": "manager_",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": false,
"defaultValue": "",
@@ -128,7 +128,7 @@ subscribers when events happen. Events will run asynchronously.
},
{
"name": "stagedJobService_",
"type": "[`StagedJobService`](StagedJobService.mdx)",
"type": "[StagedJobService](StagedJobService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -137,7 +137,7 @@ subscribers when events happen. Events will run asynchronously.
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"type": "`undefined` \\| EntityManager",
"description": "",
"optional": false,
"defaultValue": "",
@@ -150,16 +150,16 @@ subscribers when events happen. Events will run asynchronously.
### activeManager\_
`Protected` `get` **activeManager_**(): `EntityManager`
`Protected get**activeManager_**(): EntityManager`
#### Returns
`EntityManager`
EntityManager
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"type": "EntityManager",
"optional": false,
"defaultValue": "",
"description": "",
@@ -172,16 +172,16 @@ ___
### eventBusModuleService\_
`Protected` `get` **eventBusModuleService_**(): [`IEventBusModuleService`](../interfaces/IEventBusModuleService.mdx)
`Protected get**eventBusModuleService_**(): [IEventBusModuleService](../interfaces/IEventBusModuleService.mdx)`
#### Returns
[`IEventBusModuleService`](../interfaces/IEventBusModuleService.mdx)
[IEventBusModuleService](../interfaces/IEventBusModuleService.mdx)
<ParameterTypes parameters={[
{
"name": "IEventBusModuleService",
"type": "[`IEventBusModuleService`](../interfaces/IEventBusModuleService.mdx)",
"type": "[IEventBusModuleService](../interfaces/IEventBusModuleService.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -194,7 +194,7 @@ ___
### 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
@@ -226,7 +226,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": "",
@@ -235,7 +235,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": "",
@@ -244,7 +244,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": "",
@@ -255,12 +255,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",
@@ -273,7 +273,7 @@ ___
### emit
**emit**<`T`\>(`data`): `Promise`<`void` \| [`StagedJob`](StagedJob.mdx)[]\>
`**emit**<TypeParameter T>(data): Promise&#60;void \| [StagedJob](StagedJob.mdx)[]&#62;`
Calls all subscribers when an event occurs.
@@ -294,7 +294,7 @@ Calls all subscribers when an event occurs.
<ParameterTypes parameters={[
{
"name": "data",
"type": "[`EmitData`](../types/EmitData.mdx)<`T`\\>[]",
"type": "[EmitData](../types/EmitData.mdx)&#60;T&#62;[]",
"description": "The data to use to process the events",
"optional": false,
"defaultValue": "",
@@ -305,12 +305,12 @@ Calls all subscribers when an event occurs.
#### Returns
`Promise`<`void` \| [`StagedJob`](StagedJob.mdx)[]\>
Promise&#60;void \| [StagedJob](StagedJob.mdx)[]&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void` \\| [`StagedJob`](StagedJob.mdx)[]\\>",
"type": "Promise&#60;void \\| [StagedJob](StagedJob.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "the jobs from our queue",
@@ -319,7 +319,7 @@ Calls all subscribers when an event occurs.
}
]} />
**emit**<`T`\>(`eventName`, `data`, `options?`): `Promise`<`void` \| [`StagedJob`](StagedJob.mdx)\>
`**emit**<TypeParameter T>(eventName, data, options?): Promise&#60;void \| [StagedJob](StagedJob.mdx)&#62;`
Calls all subscribers when an event occurs.
@@ -358,7 +358,7 @@ Calls all subscribers when an event occurs.
},
{
"name": "options",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "options to add the job with",
"optional": true,
"defaultValue": "",
@@ -369,12 +369,12 @@ Calls all subscribers when an event occurs.
#### Returns
`Promise`<`void` \| [`StagedJob`](StagedJob.mdx)\>
Promise&#60;void \| [StagedJob](StagedJob.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void` \\| [`StagedJob`](StagedJob.mdx)\\>",
"type": "Promise&#60;void \\| [StagedJob](StagedJob.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the job from our queue",
@@ -387,16 +387,16 @@ ___
### enqueuer\_
**enqueuer_**(): `Promise`<`void`\>
`**enqueuer_**(): Promise&#60;void&#62;`
#### Returns
`Promise`<`void`\>
Promise&#60;void&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -409,14 +409,14 @@ ___
### listJobs
`Protected` **listJobs**(`listConfig`): `Promise`<`never`[] \| [`StagedJob`](StagedJob.mdx)[]\>
`Protected **listJobs**(listConfig): Promise&#60;never[] \| [StagedJob](StagedJob.mdx)[]&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "listConfig",
"type": "[`FindConfig`](../interfaces/FindConfig.mdx)<[`StagedJob`](StagedJob.mdx)\\>",
"type": "[FindConfig](../interfaces/FindConfig.mdx)&#60;[StagedJob](StagedJob.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -427,12 +427,12 @@ ___
#### Returns
`Promise`<`never`[] \| [`StagedJob`](StagedJob.mdx)[]\>
Promise&#60;never[] \| [StagedJob](StagedJob.mdx)[]&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`never`[] \\| [`StagedJob`](StagedJob.mdx)[]\\>",
"type": "Promise&#60;never[] \\| [StagedJob](StagedJob.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -445,14 +445,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": "",
@@ -481,7 +481,7 @@ ___
### startEnqueuer
**startEnqueuer**(): `void`
`**startEnqueuer**(): void`
#### Returns
@@ -503,16 +503,16 @@ ___
### stopEnqueuer
**stopEnqueuer**(): `Promise`<`void`\>
`**stopEnqueuer**(): Promise&#60;void&#62;`
#### Returns
`Promise`<`void`\>
Promise&#60;void&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -525,7 +525,7 @@ ___
### subscribe
**subscribe**(`event`, `subscriber`, `context?`): [`EventBusService`](EventBusService.mdx)
`**subscribe**(event, subscriber, context?): [EventBusService](EventBusService.mdx)`
Adds a function to a list of event subscribers.
@@ -543,7 +543,7 @@ Adds a function to a list of event subscribers.
},
{
"name": "subscriber",
"type": "[`Subscriber`](../types/Subscriber.mdx)<`unknown`\\>",
"type": "[Subscriber](../types/Subscriber.mdx)&#60;unknown&#62;",
"description": "the function to be called when a certain event happens. Subscribers must return a Promise.",
"optional": false,
"defaultValue": "",
@@ -552,7 +552,7 @@ Adds a function to a list of event subscribers.
},
{
"name": "context",
"type": "[`SubscriberContext`](../types/SubscriberContext.mdx)",
"type": "[SubscriberContext](../types/SubscriberContext.mdx)",
"description": "subscriber context",
"optional": true,
"defaultValue": "",
@@ -563,12 +563,12 @@ Adds a function to a list of event subscribers.
#### Returns
[`EventBusService`](EventBusService.mdx)
[EventBusService](EventBusService.mdx)
<ParameterTypes parameters={[
{
"name": "default",
"type": "[`EventBusService`](EventBusService.mdx)",
"type": "[EventBusService](EventBusService.mdx)",
"optional": false,
"defaultValue": "",
"description": "this",
@@ -581,7 +581,7 @@ ___
### unsubscribe
**unsubscribe**(`event`, `subscriber`, `context`): [`EventBusService`](EventBusService.mdx)
`**unsubscribe**(event, subscriber, context): [EventBusService](EventBusService.mdx)`
Removes function from the list of event subscribers.
@@ -599,7 +599,7 @@ Removes function from the list of event subscribers.
},
{
"name": "subscriber",
"type": "[`Subscriber`](../types/Subscriber.mdx)<`unknown`\\>",
"type": "[Subscriber](../types/Subscriber.mdx)&#60;unknown&#62;",
"description": "the function to be removed",
"optional": false,
"defaultValue": "",
@@ -608,7 +608,7 @@ Removes function from the list of event subscribers.
},
{
"name": "context",
"type": "[`SubscriberContext`](../types/SubscriberContext.mdx)",
"type": "[SubscriberContext](../types/SubscriberContext.mdx)",
"description": "subscriber context",
"optional": false,
"defaultValue": "",
@@ -619,12 +619,12 @@ Removes function from the list of event subscribers.
#### Returns
[`EventBusService`](EventBusService.mdx)
[EventBusService](EventBusService.mdx)
<ParameterTypes parameters={[
{
"name": "default",
"type": "[`EventBusService`](EventBusService.mdx)",
"type": "[EventBusService](EventBusService.mdx)",
"optional": false,
"defaultValue": "",
"description": "this",
@@ -637,14 +637,14 @@ ___
### withTransaction
**withTransaction**(`transactionManager?`): [`EventBusService`](EventBusService.mdx)
`**withTransaction**(transactionManager?): [EventBusService](EventBusService.mdx)`
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": true,
"defaultValue": "",
@@ -655,12 +655,12 @@ ___
#### Returns
[`EventBusService`](EventBusService.mdx)
[EventBusService](EventBusService.mdx)
<ParameterTypes parameters={[
{
"name": "default",
"type": "[`EventBusService`](EventBusService.mdx)",
"type": "[EventBusService](EventBusService.mdx)",
"optional": false,
"defaultValue": "",
"description": "",