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

88
www/apps/docs/content/references/services/classes/SalesChannelLocationService.mdx
View File

@@ -12,14 +12,14 @@ Service for managing the stock locations of sales channels
### constructor
**new SalesChannelLocationService**(`«destructured»`)
`**new SalesChannelLocationService**(«destructured»)`
#### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "[`InjectedDependencies`](../types/InjectedDependencies-35.mdx)",
"type": "[InjectedDependencies](../types/InjectedDependencies-35.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -33,7 +33,7 @@ Service for managing the stock locations of sales channels
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -51,7 +51,7 @@ Service for managing the stock locations of sales channels
},
{
"name": "__moduleDeclaration__",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -60,7 +60,7 @@ Service for managing the stock locations of sales channels
},
{
"name": "eventBusService_",
"type": "[`IEventBusService`](../interfaces/IEventBusService.mdx)",
"type": "[IEventBusService](../interfaces/IEventBusService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -69,7 +69,7 @@ Service for managing the stock locations of sales channels
},
{
"name": "manager_",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": false,
"defaultValue": "",
@@ -78,7 +78,7 @@ Service for managing the stock locations of sales channels
},
{
"name": "salesChannelService_",
"type": "[`SalesChannelService`](SalesChannelService.mdx)",
"type": "[SalesChannelService](SalesChannelService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -87,7 +87,7 @@ Service for managing the stock locations of sales channels
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"type": "`undefined` \\| EntityManager",
"description": "",
"optional": false,
"defaultValue": "",
@@ -100,16 +100,16 @@ Service for managing the stock locations of sales channels
### activeManager\_
`Protected` `get` **activeManager_**(): `EntityManager`
`Protected get**activeManager_**(): EntityManager`
#### Returns
`EntityManager`
EntityManager
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"type": "EntityManager",
"optional": false,
"defaultValue": "",
"description": "",
@@ -122,16 +122,16 @@ ___
### stockLocationService\_
`Protected` `get` **stockLocationService_**(): [`IStockLocationService`](../interfaces/IStockLocationService.mdx)
`Protected get**stockLocationService_**(): [IStockLocationService](../interfaces/IStockLocationService.mdx)`
#### Returns
[`IStockLocationService`](../interfaces/IStockLocationService.mdx)
[IStockLocationService](../interfaces/IStockLocationService.mdx)
<ParameterTypes parameters={[
{
"name": "__joinerConfig",
"type": "() => [`ModuleJoinerConfig`](../types/ModuleJoinerConfig.mdx)",
"type": "() => [ModuleJoinerConfig](../types/ModuleJoinerConfig.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -140,7 +140,7 @@ ___
},
{
"name": "create",
"type": "(`input`: [`CreateStockLocationInput`](../types/CreateStockLocationInput.mdx), `context?`: [`SharedContext`](../types/SharedContext.mdx)) => `Promise`<[`StockLocationDTO`](../types/StockLocationDTO.mdx)\\>",
"type": "(`input`: [CreateStockLocationInput](../types/CreateStockLocationInput.mdx), `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -149,7 +149,7 @@ ___
},
{
"name": "delete",
"type": "(`id`: `string`, `context?`: [`SharedContext`](../types/SharedContext.mdx)) => `Promise`<`void`\\>",
"type": "(`id`: `string`, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;void&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -158,7 +158,7 @@ ___
},
{
"name": "list",
"type": "(`selector`: [`FilterableStockLocationProps`](../types/FilterableStockLocationProps.mdx), `config?`: [`FindConfig`](../interfaces/FindConfig-1.mdx)<[`StockLocationDTO`](../types/StockLocationDTO.mdx)\\>, `context?`: [`SharedContext`](../types/SharedContext.mdx)) => `Promise`<[`StockLocationDTO`](../types/StockLocationDTO.mdx)[]\\>",
"type": "(`selector`: [FilterableStockLocationProps](../types/FilterableStockLocationProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)[]&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -167,7 +167,7 @@ ___
},
{
"name": "listAndCount",
"type": "(`selector`: [`FilterableStockLocationProps`](../types/FilterableStockLocationProps.mdx), `config?`: [`FindConfig`](../interfaces/FindConfig-1.mdx)<[`StockLocationDTO`](../types/StockLocationDTO.mdx)\\>, `context?`: [`SharedContext`](../types/SharedContext.mdx)) => `Promise`<[[`StockLocationDTO`](../types/StockLocationDTO.mdx)[], `number`]\\>",
"type": "(`selector`: [FilterableStockLocationProps](../types/FilterableStockLocationProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;[[StockLocationDTO](../types/StockLocationDTO.mdx)[], number]&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -176,7 +176,7 @@ ___
},
{
"name": "retrieve",
"type": "(`id`: `string`, `config?`: [`FindConfig`](../interfaces/FindConfig-1.mdx)<[`StockLocationDTO`](../types/StockLocationDTO.mdx)\\>, `context?`: [`SharedContext`](../types/SharedContext.mdx)) => `Promise`<[`StockLocationDTO`](../types/StockLocationDTO.mdx)\\>",
"type": "(`id`: `string`, `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -185,7 +185,7 @@ ___
},
{
"name": "update",
"type": "(`id`: `string`, `input`: [`UpdateStockLocationInput`](../types/UpdateStockLocationInput.mdx), `context?`: [`SharedContext`](../types/SharedContext.mdx)) => `Promise`<[`StockLocationDTO`](../types/StockLocationDTO.mdx)\\>",
"type": "(`id`: `string`, `input`: [UpdateStockLocationInput](../types/UpdateStockLocationInput.mdx), `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -198,7 +198,7 @@ ___
### associateLocation
**associateLocation**(`salesChannelId`, `locationId`): `Promise`<`void`\>
`**associateLocation**(salesChannelId, locationId): Promise&#60;void&#62;`
Associates a sales channel with a stock location.
@@ -227,12 +227,12 @@ Associates a sales channel with a stock location.
#### Returns
`Promise`<`void`\>
Promise&#60;void&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "A promise that resolves when the association has been created.",
@@ -245,7 +245,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
@@ -277,7 +277,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": "",
@@ -286,7 +286,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": "",
@@ -295,7 +295,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": "",
@@ -306,12 +306,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",
@@ -324,7 +324,7 @@ ___
### listLocationIds
**listLocationIds**(`salesChannelId`): `Promise`<`string`[]\>
`**listLocationIds**(salesChannelId): Promise&#60;string[]&#62;`
Lists the stock locations associated with a sales channel.
@@ -344,12 +344,12 @@ Lists the stock locations associated with a sales channel.
#### Returns
`Promise`<`string`[]\>
Promise&#60;string[]&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`string`[]\\>",
"type": "Promise&#60;string[]&#62;",
"optional": false,
"defaultValue": "",
"description": "A promise that resolves with an array of location IDs.",
@@ -362,7 +362,7 @@ ___
### listSalesChannelIds
**listSalesChannelIds**(`locationId`): `Promise`<`string`[]\>
`**listSalesChannelIds**(locationId): Promise&#60;string[]&#62;`
Lists the sales channels associated with a stock location.
@@ -382,12 +382,12 @@ Lists the sales channels associated with a stock location.
#### Returns
`Promise`<`string`[]\>
Promise&#60;string[]&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`string`[]\\>",
"type": "Promise&#60;string[]&#62;",
"optional": false,
"defaultValue": "",
"description": "A promise that resolves with an array of sales channel IDs.",
@@ -400,7 +400,7 @@ ___
### removeLocation
**removeLocation**(`locationId`, `salesChannelId?`): `Promise`<`void`\>
`**removeLocation**(locationId, salesChannelId?): Promise&#60;void&#62;`
Removes an association between a sales channel and a stock location.
@@ -429,12 +429,12 @@ Removes an association between a sales channel and a stock location.
#### Returns
`Promise`<`void`\>
Promise&#60;void&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "A promise that resolves when the association has been removed.",
@@ -447,14 +447,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": "",
@@ -483,14 +483,14 @@ ___
### withTransaction
**withTransaction**(`transactionManager?`): [`SalesChannelLocationService`](SalesChannelLocationService.mdx)
`**withTransaction**(transactionManager?): [SalesChannelLocationService](SalesChannelLocationService.mdx)`
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": true,
"defaultValue": "",
@@ -501,12 +501,12 @@ ___
#### Returns
[`SalesChannelLocationService`](SalesChannelLocationService.mdx)
[SalesChannelLocationService](SalesChannelLocationService.mdx)
<ParameterTypes parameters={[
{
"name": "SalesChannelLocationService",
"type": "[`SalesChannelLocationService`](SalesChannelLocationService.mdx)",
"type": "[SalesChannelLocationService](SalesChannelLocationService.mdx)",
"optional": false,
"defaultValue": "",
"description": "",