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

74
www/apps/docs/content/references/services/classes/AnalyticsConfigService.mdx
View File

@@ -10,14 +10,14 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### constructor
**new AnalyticsConfigService**(`«destructured»`)
`**new AnalyticsConfigService**(«destructured»)`
#### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "[`InjectedDependencies`](../types/InjectedDependencies.mdx)",
"type": "[InjectedDependencies](../types/InjectedDependencies.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": "analyticsConfigRepository_",
"type": "`Repository`<[`AnalyticsConfig`](AnalyticsConfig.mdx)\\>",
"type": "Repository&#60;[AnalyticsConfig](AnalyticsConfig.mdx)&#62;",
"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": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"type": "`undefined` \\| EntityManager",
"description": "",
"optional": false,
"defaultValue": "",
@@ -85,7 +85,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "userService_",
"type": "[`UserService`](UserService.mdx)",
"type": "[UserService](UserService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -98,16 +98,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": "",
@@ -120,7 +120,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
@@ -152,7 +152,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": "",
@@ -161,7 +161,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": "",
@@ -170,7 +170,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": "",
@@ -181,12 +181,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",
@@ -199,7 +199,7 @@ ___
### create
**create**(`userId`, `data`): `Promise`<[`AnalyticsConfig`](AnalyticsConfig.mdx)\>
`**create**(userId, data): Promise&#60;[AnalyticsConfig](AnalyticsConfig.mdx)&#62;`
Creates an analytics config.
@@ -217,7 +217,7 @@ Creates an analytics config.
},
{
"name": "data",
"type": "[`CreateAnalyticsConfig`](../types/CreateAnalyticsConfig.mdx)",
"type": "[CreateAnalyticsConfig](../types/CreateAnalyticsConfig.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -228,12 +228,12 @@ Creates an analytics config.
#### Returns
`Promise`<[`AnalyticsConfig`](AnalyticsConfig.mdx)\>
Promise&#60;[AnalyticsConfig](AnalyticsConfig.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`AnalyticsConfig`](AnalyticsConfig.mdx)\\>",
"type": "Promise&#60;[AnalyticsConfig](AnalyticsConfig.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -246,7 +246,7 @@ ___
### delete
**delete**(`userId`): `Promise`<`void`\>
`**delete**(userId): Promise&#60;void&#62;`
Deletes an analytics config.
@@ -266,12 +266,12 @@ Deletes an analytics config.
#### Returns
`Promise`<`void`\>
Promise&#60;void&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -284,7 +284,7 @@ ___
### retrieve
**retrieve**(`userId`): `Promise`<[`AnalyticsConfig`](AnalyticsConfig.mdx)\>
`**retrieve**(userId): Promise&#60;[AnalyticsConfig](AnalyticsConfig.mdx)&#62;`
#### Parameters
@@ -302,12 +302,12 @@ ___
#### Returns
`Promise`<[`AnalyticsConfig`](AnalyticsConfig.mdx)\>
Promise&#60;[AnalyticsConfig](AnalyticsConfig.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`AnalyticsConfig`](AnalyticsConfig.mdx)\\>",
"type": "Promise&#60;[AnalyticsConfig](AnalyticsConfig.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -320,14 +320,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": "",
@@ -356,7 +356,7 @@ ___
### update
**update**(`userId`, `update`): `Promise`<[`AnalyticsConfig`](AnalyticsConfig.mdx)\>
`**update**(userId, update): Promise&#60;[AnalyticsConfig](AnalyticsConfig.mdx)&#62;`
Updates an analytics config. If the config does not exist, it will be created instead.
@@ -374,7 +374,7 @@ Updates an analytics config. If the config does not exist, it will be created in
},
{
"name": "update",
"type": "[`UpdateAnalyticsConfig`](../types/UpdateAnalyticsConfig.mdx)",
"type": "[UpdateAnalyticsConfig](../types/UpdateAnalyticsConfig.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -385,12 +385,12 @@ Updates an analytics config. If the config does not exist, it will be created in
#### Returns
`Promise`<[`AnalyticsConfig`](AnalyticsConfig.mdx)\>
Promise&#60;[AnalyticsConfig](AnalyticsConfig.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`AnalyticsConfig`](AnalyticsConfig.mdx)\\>",
"type": "Promise&#60;[AnalyticsConfig](AnalyticsConfig.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -403,14 +403,14 @@ ___
### withTransaction
**withTransaction**(`transactionManager?`): [`AnalyticsConfigService`](AnalyticsConfigService.mdx)
`**withTransaction**(transactionManager?): [AnalyticsConfigService](AnalyticsConfigService.mdx)`
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": true,
"defaultValue": "",
@@ -421,12 +421,12 @@ ___
#### Returns
[`AnalyticsConfigService`](AnalyticsConfigService.mdx)
[AnalyticsConfigService](AnalyticsConfigService.mdx)
<ParameterTypes parameters={[
{
"name": "AnalyticsConfigService",
"type": "[`AnalyticsConfigService`](AnalyticsConfigService.mdx)",
"type": "[AnalyticsConfigService](AnalyticsConfigService.mdx)",
"optional": false,
"defaultValue": "",
"description": "",