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

chore(docs): Generated References (#5743)

Browse Source 
Generated the following references:
- `entities`
- `inventory`
- `js-client`
- `pricing`
- `product`
- `services`
- `stock-location`
- `workflows`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-11-27 18:58:52 +00:00
committed by GitHub
parent dc6b815b12
commit cdd42dbdcd
1383 changed files with 18978 additions and 20154 deletions
Download Patch File Download Diff File Expand all files Collapse all files

80
www/apps/docs/content/references/services/classes/IdempotencyKeyService.mdx
View File

@@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Constructors
### constructor
#### constructor
`**new IdempotencyKeyService**(«destructured»)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -87,29 +87,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Accessors
### activeManager\_
#### activeManager\_
`Protected get**activeManager_**(): EntityManager`
#### Returns
EntityManager
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "EntityManager",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
`Protected` **activeManager\_**: [object Object]
## Methods
### atomicPhase\_
#### atomicPhase\_
`Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise&#60;TResult&#62;`
@@ -117,6 +101,8 @@ 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
<ParameterTypes parameters={[
{
"name": "TResult",
@@ -138,7 +124,7 @@ transaction manager is created.
}
]} />
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -170,7 +156,7 @@ transaction manager is created.
}
]} />
#### Returns
##### Returns
Promise&#60;TResult&#62;
@@ -188,7 +174,7 @@ Promise&#60;TResult&#62;
___
### create
#### create
`**create**(payload): Promise&#60;[IdempotencyKey](IdempotencyKey.mdx)&#62;`
@@ -196,7 +182,7 @@ Creates an idempotency key for a request.
If no idempotency key is provided in request, we will create a unique
identifier.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -210,7 +196,7 @@ identifier.
}
]} />
#### Returns
##### Returns
Promise&#60;[IdempotencyKey](IdempotencyKey.mdx)&#62;
@@ -228,13 +214,13 @@ Promise&#60;[IdempotencyKey](IdempotencyKey.mdx)&#62;
___
### initializeRequest
#### initializeRequest
`**initializeRequest**(headerKey, reqMethod, reqParams, reqPath): Promise&#60;[IdempotencyKey](IdempotencyKey.mdx)&#62;`
Execute the initial steps in a idempotent request.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -275,7 +261,7 @@ Execute the initial steps in a idempotent request.
}
]} />
#### Returns
##### Returns
Promise&#60;[IdempotencyKey](IdempotencyKey.mdx)&#62;
@@ -293,13 +279,13 @@ Promise&#60;[IdempotencyKey](IdempotencyKey.mdx)&#62;
___
### lock
#### lock
`**lock**(idempotencyKey): Promise&#60;[IdempotencyKey](IdempotencyKey.mdx)&#62;`
Locks an idempotency.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -313,7 +299,7 @@ Locks an idempotency.
}
]} />
#### Returns
##### Returns
Promise&#60;[IdempotencyKey](IdempotencyKey.mdx)&#62;
@@ -331,13 +317,13 @@ Promise&#60;[IdempotencyKey](IdempotencyKey.mdx)&#62;
___
### retrieve
#### retrieve
`**retrieve**(idempotencyKeyOrSelector): Promise&#60;[IdempotencyKey](IdempotencyKey.mdx)&#62;`
Retrieves an idempotency key
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -351,7 +337,7 @@ Retrieves an idempotency key
}
]} />
#### Returns
##### Returns
Promise&#60;[IdempotencyKey](IdempotencyKey.mdx)&#62;
@@ -369,11 +355,11 @@ Promise&#60;[IdempotencyKey](IdempotencyKey.mdx)&#62;
___
### shouldRetryTransaction\_
#### shouldRetryTransaction\_
`Protected **shouldRetryTransaction_**(err): boolean`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -387,7 +373,7 @@ ___
}
]} />
#### Returns
##### Returns
`boolean`
@@ -405,13 +391,13 @@ ___
___
### update
#### update
`**update**(idempotencyKey, update): Promise&#60;[IdempotencyKey](IdempotencyKey.mdx)&#62;`
Locks an idempotency.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -434,7 +420,7 @@ Locks an idempotency.
}
]} />
#### Returns
##### Returns
Promise&#60;[IdempotencyKey](IdempotencyKey.mdx)&#62;
@@ -452,11 +438,11 @@ Promise&#60;[IdempotencyKey](IdempotencyKey.mdx)&#62;
___
### withTransaction
#### withTransaction
`**withTransaction**(transactionManager?): [IdempotencyKeyService](IdempotencyKeyService.mdx)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -470,7 +456,7 @@ ___
}
]} />
#### Returns
##### Returns
[IdempotencyKeyService](IdempotencyKeyService.mdx)
@@ -488,7 +474,7 @@ ___
___
### workStage
#### workStage
`**workStage**(idempotencyKey, callback): Promise&#60;[IdempotencyKey](IdempotencyKey.mdx)&#62;`
@@ -498,7 +484,7 @@ transactionally executed in isolation. An idempotent request will
always consist of 2 or more of these phases. The required phases are
"started" and "finished".
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -521,7 +507,7 @@ always consist of 2 or more of these phases. The required phases are
}
]} />
#### Returns
##### Returns
Promise&#60;[IdempotencyKey](IdempotencyKey.mdx)&#62;