asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: migrate guides to TSDoc references (#6100)

Browse Source
This commit is contained in:
Shahed Nasser
2024-01-22 19:38:35 +02:00
committed by GitHub
parent 85dad169bb
commit 4792c55226
980 changed files with 195537 additions and 160619 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/docs/content/references/services/classes/services.OrderEditService.mdx
+1 -45
View File
@@ -28,8 +28,6 @@ ___
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### inventoryService\_
#### Returns
@@ -50,8 +48,6 @@ ___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### atomicPhase\_
Wraps some work within a transactional block. If the service already has
@@ -70,8 +66,6 @@ transaction manager is created.
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
___
### cancel
#### Parameters
@@ -82,8 +76,6 @@ ___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### confirm
#### Parameters
@@ -94,8 +86,6 @@ ___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### create
#### Parameters
@@ -106,8 +96,6 @@ ___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### decline
#### Parameters
@@ -118,8 +106,6 @@ ___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### decorateTotals
#### Parameters
@@ -130,8 +116,6 @@ ___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### delete
#### Parameters
@@ -142,8 +126,6 @@ ___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### deleteClonedItems
#### Parameters
@@ -154,8 +136,6 @@ ___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### deleteItemChange
#### Parameters
@@ -166,8 +146,6 @@ ___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### list
#### Parameters
@@ -178,8 +156,6 @@ ___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### listAndCount
#### Parameters
@@ -190,8 +166,6 @@ ___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[], number]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### refreshAdjustments
#### Parameters
@@ -202,8 +176,6 @@ ___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### removeLineItem
#### Parameters
@@ -214,8 +186,6 @@ ___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### requestConfirmation
#### Parameters
@@ -226,8 +196,6 @@ ___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### retrieve
#### Parameters
@@ -238,8 +206,6 @@ ___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### retrieveActive
#### Parameters
@@ -250,8 +216,6 @@ ___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;undefined \\| null \\| [OrderEdit](../../entities/classes/entities.OrderEdit.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### shouldRetryTransaction\_
#### Parameters
@@ -262,8 +226,6 @@ ___
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### update
#### Parameters
@@ -274,8 +236,6 @@ ___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### updateLineItem
Create or update order edit item change line item and apply the quantity
@@ -288,9 +248,7 @@ Create or update order edit item change line item and apply the quantity
#### Returns
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"Create or update order edit item change line item and apply the quantity\n- If the item change already exists then update the quantity of the line item as well as the line adjustments\n- If the item change does not exist then create the item change of type update and apply the quantity as well as update the line adjustments","expandable":false,"children":[]}]} />
### withTransaction
@@ -302,8 +260,6 @@ ___
<ParameterTypes parameters={[{"name":"this","type":"`this`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### isOrderEditActive
#### Parameters