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

96
www/apps/docs/content/references/services/classes/NoteService.mdx
View File

@@ -10,14 +10,14 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### constructor
**new NoteService**(`«destructured»`)
`**new NoteService**(«destructured»)`
#### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "[`InjectedDependencies`](../types/InjectedDependencies-16.mdx)",
"type": "[InjectedDependencies](../types/InjectedDependencies-16.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": "eventBus_",
"type": "[`EventBusService`](EventBusService.mdx)",
"type": "[EventBusService](EventBusService.mdx)",
"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": "noteRepository_",
"type": "`Repository`<[`Note`](Note.mdx)\\>",
"type": "Repository&#60;[Note](Note.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -85,7 +85,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"type": "`undefined` \\| EntityManager",
"description": "",
"optional": false,
"defaultValue": "",
@@ -134,16 +134,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": "",
@@ -156,7 +156,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
@@ -188,7 +188,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": "",
@@ -197,7 +197,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": "",
@@ -206,7 +206,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": "",
@@ -217,12 +217,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",
@@ -235,7 +235,7 @@ ___
### create
**create**(`data`, `config?`): `Promise`<[`Note`](Note.mdx)\>
`**create**(data, config?): Promise&#60;[Note](Note.mdx)&#62;`
Creates a note associated with a given author
@@ -244,7 +244,7 @@ Creates a note associated with a given author
<ParameterTypes parameters={[
{
"name": "data",
"type": "[`CreateNoteInput`](../interfaces/CreateNoteInput.mdx)",
"type": "[CreateNoteInput](../interfaces/CreateNoteInput.mdx)",
"description": "the note to create",
"optional": false,
"defaultValue": "",
@@ -262,7 +262,7 @@ Creates a note associated with a given author
},
{
"name": "config.metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -273,12 +273,12 @@ Creates a note associated with a given author
#### Returns
`Promise`<[`Note`](Note.mdx)\>
Promise&#60;[Note](Note.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`Note`](Note.mdx)\\>",
"type": "Promise&#60;[Note](Note.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "resolves to the creation result",
@@ -291,7 +291,7 @@ ___
### delete
**delete**(`noteId`): `Promise`<`void`\>
`**delete**(noteId): Promise&#60;void&#62;`
Deletes a given note
@@ -311,12 +311,12 @@ Deletes a given note
#### Returns
`Promise`<`void`\>
Promise&#60;void&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -329,7 +329,7 @@ ___
### list
**list**(`selector`, `config?`): `Promise`<[`Note`](Note.mdx)[]\>
`**list**(selector, config?): Promise&#60;[Note](Note.mdx)[]&#62;`
Fetches all notes related to the given selector
@@ -338,7 +338,7 @@ Fetches all notes related to the given selector
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[`Selector`](../types/Selector.mdx)<[`Note`](Note.mdx)\\>",
"type": "[Selector](../types/Selector.mdx)&#60;[Note](Note.mdx)&#62;",
"description": "the query object for find",
"optional": false,
"defaultValue": "",
@@ -347,7 +347,7 @@ Fetches all notes related to the given selector
},
{
"name": "config",
"type": "[`FindConfig`](../interfaces/FindConfig.mdx)<[`Note`](Note.mdx)\\>",
"type": "[FindConfig](../interfaces/FindConfig.mdx)&#60;[Note](Note.mdx)&#62;",
"description": "the configuration used to find the objects. contains relations, skip, and take.",
"optional": false,
"defaultValue": "",
@@ -358,12 +358,12 @@ Fetches all notes related to the given selector
#### Returns
`Promise`<[`Note`](Note.mdx)[]\>
Promise&#60;[Note](Note.mdx)[]&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`Note`](Note.mdx)[]\\>",
"type": "Promise&#60;[Note](Note.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "notes related to the given search.",
@@ -376,7 +376,7 @@ ___
### listAndCount
**listAndCount**(`selector`, `config?`): `Promise`<[[`Note`](Note.mdx)[], `number`]\>
`**listAndCount**(selector, config?): Promise&#60;[[Note](Note.mdx)[], number]&#62;`
Fetches all notes related to the given selector
@@ -385,7 +385,7 @@ Fetches all notes related to the given selector
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[`Selector`](../types/Selector.mdx)<[`Note`](Note.mdx)\\>",
"type": "[Selector](../types/Selector.mdx)&#60;[Note](Note.mdx)&#62;",
"description": "the query object for find",
"optional": false,
"defaultValue": "",
@@ -394,7 +394,7 @@ Fetches all notes related to the given selector
},
{
"name": "config",
"type": "[`FindConfig`](../interfaces/FindConfig.mdx)<[`Note`](Note.mdx)\\>",
"type": "[FindConfig](../interfaces/FindConfig.mdx)&#60;[Note](Note.mdx)&#62;",
"description": "the configuration used to find the objects. contains relations, skip, and take.",
"optional": false,
"defaultValue": "",
@@ -405,12 +405,12 @@ Fetches all notes related to the given selector
#### Returns
`Promise`<[[`Note`](Note.mdx)[], `number`]\>
Promise&#60;[[Note](Note.mdx)[], number]&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[[`Note`](Note.mdx)[], `number`]\\>",
"type": "Promise&#60;[[Note](Note.mdx)[], number]&#62;",
"optional": false,
"defaultValue": "",
"description": "notes related to the given search.",
@@ -423,7 +423,7 @@ ___
### retrieve
**retrieve**(`noteId`, `config?`): `Promise`<[`Note`](Note.mdx)\>
`**retrieve**(noteId, config?): Promise&#60;[Note](Note.mdx)&#62;`
Retrieves a specific note.
@@ -441,7 +441,7 @@ Retrieves a specific note.
},
{
"name": "config",
"type": "[`FindConfig`](../interfaces/FindConfig.mdx)<[`Note`](Note.mdx)\\>",
"type": "[FindConfig](../interfaces/FindConfig.mdx)&#60;[Note](Note.mdx)&#62;",
"description": "any options needed to query for the result.",
"optional": false,
"defaultValue": "{}",
@@ -452,12 +452,12 @@ Retrieves a specific note.
#### Returns
`Promise`<[`Note`](Note.mdx)\>
Promise&#60;[Note](Note.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`Note`](Note.mdx)\\>",
"type": "Promise&#60;[Note](Note.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "which resolves to the requested note.",
@@ -470,14 +470,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": "",
@@ -506,7 +506,7 @@ ___
### update
**update**(`noteId`, `value`): `Promise`<[`Note`](Note.mdx)\>
`**update**(noteId, value): Promise&#60;[Note](Note.mdx)&#62;`
Updates a given note with a new value
@@ -535,12 +535,12 @@ Updates a given note with a new value
#### Returns
`Promise`<[`Note`](Note.mdx)\>
Promise&#60;[Note](Note.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`Note`](Note.mdx)\\>",
"type": "Promise&#60;[Note](Note.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "resolves to the updated element",
@@ -553,14 +553,14 @@ ___
### withTransaction
**withTransaction**(`transactionManager?`): [`NoteService`](NoteService.mdx)
`**withTransaction**(transactionManager?): [NoteService](NoteService.mdx)`
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": true,
"defaultValue": "",
@@ -571,12 +571,12 @@ ___
#### Returns
[`NoteService`](NoteService.mdx)
[NoteService](NoteService.mdx)
<ParameterTypes parameters={[
{
"name": "NoteService",
"type": "[`NoteService`](NoteService.mdx)",
"type": "[NoteService](NoteService.mdx)",
"optional": false,
"defaultValue": "",
"description": "",