docs: update docusaurus to v3 (#5625)
* 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:
@@ -10,7 +10,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
### emit
|
||||
|
||||
**emit**<`T`\>(`eventName`, `data`, `options?`): `Promise`<`void`\>
|
||||
`**emit**<TypeParameter T>(eventName, data, options?): Promise<void>`
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -47,7 +47,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
},
|
||||
{
|
||||
"name": "options",
|
||||
"type": "Record<`string`, `unknown`\\>",
|
||||
"type": "`Record<string, unknown>`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -58,12 +58,12 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`void`\>
|
||||
Promise<void>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<`void`\\>",
|
||||
"type": "Promise<void>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
@@ -72,7 +72,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
}
|
||||
]} />
|
||||
|
||||
**emit**<`T`\>(`data`): `Promise`<`void`\>
|
||||
`**emit**<TypeParameter T>(data): Promise<void>`
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -91,7 +91,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "data",
|
||||
"type": "[`EmitData`](../types/EmitData.mdx)<`T`\\>[]",
|
||||
"type": "[EmitData](../types/EmitData.mdx)<T>[]",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -102,12 +102,12 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`void`\>
|
||||
Promise<void>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<`void`\\>",
|
||||
"type": "Promise<void>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
@@ -120,7 +120,7 @@ ___
|
||||
|
||||
### subscribe
|
||||
|
||||
**subscribe**(`eventName`, `subscriber`, `context?`): [`IEventBusModuleService`](IEventBusModuleService.mdx)
|
||||
`**subscribe**(eventName, subscriber, context?): [IEventBusModuleService](IEventBusModuleService.mdx)`
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -136,7 +136,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "subscriber",
|
||||
"type": "[`Subscriber`](../types/Subscriber.mdx)",
|
||||
"type": "[Subscriber](../types/Subscriber.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -145,7 +145,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`SubscriberContext`](../types/SubscriberContext.mdx)",
|
||||
"type": "[SubscriberContext](../types/SubscriberContext.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -156,12 +156,12 @@ ___
|
||||
|
||||
#### Returns
|
||||
|
||||
[`IEventBusModuleService`](IEventBusModuleService.mdx)
|
||||
[IEventBusModuleService](IEventBusModuleService.mdx)
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "IEventBusModuleService",
|
||||
"type": "[`IEventBusModuleService`](IEventBusModuleService.mdx)",
|
||||
"type": "[IEventBusModuleService](IEventBusModuleService.mdx)",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
@@ -174,7 +174,7 @@ ___
|
||||
|
||||
### unsubscribe
|
||||
|
||||
**unsubscribe**(`eventName`, `subscriber`, `context?`): [`IEventBusModuleService`](IEventBusModuleService.mdx)
|
||||
`**unsubscribe**(eventName, subscriber, context?): [IEventBusModuleService](IEventBusModuleService.mdx)`
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -190,7 +190,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "subscriber",
|
||||
"type": "[`Subscriber`](../types/Subscriber.mdx)",
|
||||
"type": "[Subscriber](../types/Subscriber.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -199,7 +199,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`SubscriberContext`](../types/SubscriberContext.mdx)",
|
||||
"type": "[SubscriberContext](../types/SubscriberContext.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -210,12 +210,12 @@ ___
|
||||
|
||||
#### Returns
|
||||
|
||||
[`IEventBusModuleService`](IEventBusModuleService.mdx)
|
||||
[IEventBusModuleService](IEventBusModuleService.mdx)
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "IEventBusModuleService",
|
||||
"type": "[`IEventBusModuleService`](IEventBusModuleService.mdx)",
|
||||
"type": "[IEventBusModuleService](IEventBusModuleService.mdx)",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
|
||||
Reference in New Issue
Block a user