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

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
@@ -6,13 +6,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# CustomShippingOptionService
## Constructors
#### constructor
## constructor
`**new CustomShippingOptionService**(«destructured»)`
##### Parameters
### Parameters
<ParameterTypes parameters={[
{
@@ -26,6 +24,8 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
___
## Properties
<ParameterTypes parameters={[
@@ -85,15 +85,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;`
@@ -101,7 +121,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={[
{
@@ -124,7 +144,7 @@ transaction manager is created.
}
]} />
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -156,7 +176,7 @@ transaction manager is created.
}
]} />
##### Returns
#### Returns
Promise&#60;TResult&#62;
@@ -174,13 +194,13 @@ Promise&#60;TResult&#62;
___
#### create
### create
`**create**<TypeParameter T, TypeParameter TResult>(data): Promise&#60;TResult&#62;`
Creates a custom shipping option
##### Type Parameters
#### Type Parameters
<ParameterTypes parameters={[
{
@@ -203,7 +223,7 @@ Creates a custom shipping option
}
]} />
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -217,7 +237,7 @@ Creates a custom shipping option
}
]} />
##### Returns
#### Returns
Promise&#60;TResult&#62;
@@ -235,13 +255,13 @@ Promise&#60;TResult&#62;
___
#### list
### list
`**list**(selector, config?): Promise&#60;[CustomShippingOption](CustomShippingOption.mdx)[]&#62;`
Fetches all custom shipping options based on the given selector
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -264,7 +284,7 @@ Fetches all custom shipping options based on the given selector
}
]} />
##### Returns
#### Returns
Promise&#60;[CustomShippingOption](CustomShippingOption.mdx)[]&#62;
@@ -282,13 +302,13 @@ Promise&#60;[CustomShippingOption](CustomShippingOption.mdx)[]&#62;
___
#### retrieve
### retrieve
`**retrieve**(id, config?): Promise&#60;[CustomShippingOption](CustomShippingOption.mdx)&#62;`
Retrieves a specific shipping option.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -311,7 +331,7 @@ Retrieves a specific shipping option.
}
]} />
##### Returns
#### Returns
Promise&#60;[CustomShippingOption](CustomShippingOption.mdx)&#62;
@@ -329,11 +349,11 @@ Promise&#60;[CustomShippingOption](CustomShippingOption.mdx)&#62;
___
#### shouldRetryTransaction\_
### shouldRetryTransaction\_
`Protected **shouldRetryTransaction_**(err): boolean`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -347,7 +367,7 @@ ___
}
]} />
##### Returns
#### Returns
`boolean`
@@ -365,11 +385,11 @@ ___
___
#### withTransaction
### withTransaction
`**withTransaction**(transactionManager?): [CustomShippingOptionService](CustomShippingOptionService.mdx)`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -383,7 +403,7 @@ ___
}
]} />
##### Returns
#### Returns
[CustomShippingOptionService](CustomShippingOptionService.mdx)