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

docs: TSDoc + reference of fulfillment service (#5761)

Browse Source
This commit is contained in:
Shahed Nasser
2023-11-29 11:58:08 +00:00
committed by GitHub
parent 8f25ed8a10
commit f802e2460f
1479 changed files with 30259 additions and 16135 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/docs/content/references/services/classes/ClaimItemService.mdx
+48 -28
View File
@@ -6,13 +6,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# ClaimItemService
## Constructors
#### constructor
## constructor
`**new ClaimItemService**(«destructured»)`
##### Parameters
### Parameters
<ParameterTypes parameters={[
{
@@ -26,6 +24,8 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
___
## Properties
<ParameterTypes parameters={[
@@ -157,15 +157,35 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
___
## Accessors
#### activeManager\_
### activeManager\_
`Protected` **activeManager\_**: [object Object]
`Protected get**activeManager_**(): EntityManager`
#### Returns
EntityManager
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "EntityManager",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
## Methods
#### atomicPhase\_
### atomicPhase\_
`Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise&#60;TResult&#62;`
@@ -173,7 +193,7 @@ Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
##### Type Parameters
#### Type Parameters
<ParameterTypes parameters={[
{
@@ -196,7 +216,7 @@ transaction manager is created.
}
]} />
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -228,7 +248,7 @@ transaction manager is created.
}
]} />
##### Returns
#### Returns
Promise&#60;TResult&#62;
@@ -246,11 +266,11 @@ Promise&#60;TResult&#62;
___
#### create
### create
`**create**(data): Promise&#60;[ClaimItem](ClaimItem.mdx)&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -264,7 +284,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;[ClaimItem](ClaimItem.mdx)&#62;
@@ -282,11 +302,11 @@ Promise&#60;[ClaimItem](ClaimItem.mdx)&#62;
___
#### list
### list
`**list**(selector, config?): Promise&#60;[ClaimItem](ClaimItem.mdx)[]&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -309,7 +329,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;[ClaimItem](ClaimItem.mdx)[]&#62;
@@ -327,13 +347,13 @@ Promise&#60;[ClaimItem](ClaimItem.mdx)[]&#62;
___
#### retrieve
### retrieve
`**retrieve**(claimItemId, config?): Promise&#60;[ClaimItem](ClaimItem.mdx)&#62;`
Gets a claim item by id.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -356,7 +376,7 @@ Gets a claim item by id.
}
]} />
##### Returns
#### Returns
Promise&#60;[ClaimItem](ClaimItem.mdx)&#62;
@@ -374,11 +394,11 @@ Promise&#60;[ClaimItem](ClaimItem.mdx)&#62;
___
#### shouldRetryTransaction\_
### shouldRetryTransaction\_
`Protected **shouldRetryTransaction_**(err): boolean`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -392,7 +412,7 @@ ___
}
]} />
##### Returns
#### Returns
`boolean`
@@ -410,11 +430,11 @@ ___
___
#### update
### update
`**update**(id, data): Promise&#60;[ClaimItem](ClaimItem.mdx)&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -437,7 +457,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;[ClaimItem](ClaimItem.mdx)&#62;
@@ -455,11 +475,11 @@ Promise&#60;[ClaimItem](ClaimItem.mdx)&#62;
___
#### withTransaction
### withTransaction
`**withTransaction**(transactionManager?): [ClaimItemService](ClaimItemService.mdx)`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -473,7 +493,7 @@ ___
}
]} />
##### Returns
#### Returns
[ClaimItemService](ClaimItemService.mdx)