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

30
www/apps/docs/content/references/services/classes/services.LineItemService.mdx
View File

@@ -50,8 +50,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":[]}]} />
___
### cloneTo
#### Parameters
@@ -62,8 +60,6 @@ ___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[LineItem](../../entities/classes/entities.LineItem.mdx)[]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### create
Create a line item
@@ -80,8 +76,6 @@ Create a line item
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the created line item","expandable":false,"children":[]}]} />
___
### createReturnLines
Creates return line items for a given cart based on the return items in a
@@ -95,8 +89,6 @@ return.
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[LineItem](../../entities/classes/entities.LineItem.mdx)[]&#62;","optional":false,"defaultValue":"","description":"the created line items","expandable":false,"children":[]}]} />
___
### createTaxLine
Create a line item tax line.
@@ -109,8 +101,6 @@ Create a line item tax line.
<ParameterTypes parameters={[{"name":"LineItemTaxLine","type":"`object`","description":"A Line Item Tax Line represents the taxes applied on a line item.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
### delete
`**delete**(ids): Promise&#60;[LineItem](../../entities/classes/entities.LineItem.mdx)[]&#62;`
@@ -137,8 +127,6 @@ Deletes a line item.
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void \\| [LineItem](../../entities/classes/entities.LineItem.mdx)&#62;","optional":false,"defaultValue":"","description":"the result of the delete operation","expandable":false,"children":[]}]} />
___
### deleteWithTaxLines
#### Parameters
@@ -154,8 +142,6 @@ ___
no the cascade on the entity takes care of it
Deletes a line item with the tax lines.
___
### generate
Generate a single or multiple line item without persisting the data into the db
@@ -170,9 +156,7 @@ Generate a single or multiple line item without persisting the data into the db
#### Returns
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"Generate a single or multiple line item without persisting the data into the db","expandable":false,"children":[]}]} />
### generateLineItem
@@ -184,8 +168,6 @@ ___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[LineItem](../../entities/classes/entities.LineItem.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### list
#### Parameters
@@ -196,8 +178,6 @@ ___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[LineItem](../../entities/classes/entities.LineItem.mdx)[]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### retrieve
Retrieves a line item by its id.
@@ -210,8 +190,6 @@ Retrieves a line item by its id.
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[LineItem](../../entities/classes/entities.LineItem.mdx)&#62;","optional":false,"defaultValue":"","description":"the line item","expandable":false,"children":[]}]} />
___
### shouldRetryTransaction\_
#### Parameters
@@ -222,8 +200,6 @@ ___
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### update
Updates a line item
@@ -236,8 +212,6 @@ Updates a line item
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[LineItem](../../entities/classes/entities.LineItem.mdx)[]&#62;","optional":false,"defaultValue":"","description":"the updated line item(s)","expandable":false,"children":[]}]} />
___
### validateGenerateArguments
#### Type Parameters
@@ -252,8 +226,6 @@ ___
<ParameterTypes parameters={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### withTransaction
#### Parameters