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

16
www/apps/docs/content/references/services/classes/services.IdempotencyKeyService.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":[]}]} />
___
### create
Creates an idempotency key for a request.
@@ -66,8 +64,6 @@ identifier.
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[IdempotencyKey](../../entities/classes/entities.IdempotencyKey.mdx)&#62;","optional":false,"defaultValue":"","description":"the created idempotency key","expandable":false,"children":[]}]} />
___
### initializeRequest
Execute the initial steps in a idempotent request.
@@ -80,8 +76,6 @@ Execute the initial steps in a idempotent request.
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[IdempotencyKey](../../entities/classes/entities.IdempotencyKey.mdx)&#62;","optional":false,"defaultValue":"","description":"the existing or created idempotency key","expandable":false,"children":[]}]} />
___
### lock
Locks an idempotency.
@@ -94,8 +88,6 @@ Locks an idempotency.
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[IdempotencyKey](../../entities/classes/entities.IdempotencyKey.mdx)&#62;","optional":false,"defaultValue":"","description":"result of the update operation","expandable":false,"children":[]}]} />
___
### retrieve
Retrieves an idempotency key
@@ -108,8 +100,6 @@ Retrieves an idempotency key
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[IdempotencyKey](../../entities/classes/entities.IdempotencyKey.mdx)&#62;","optional":false,"defaultValue":"","description":"idempotency key","expandable":false,"children":[]}]} />
___
### shouldRetryTransaction\_
#### Parameters
@@ -120,8 +110,6 @@ ___
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### update
Locks an idempotency.
@@ -134,8 +122,6 @@ Locks an idempotency.
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[IdempotencyKey](../../entities/classes/entities.IdempotencyKey.mdx)&#62;","optional":false,"defaultValue":"","description":"result of the update operation","expandable":false,"children":[]}]} />
___
### withTransaction
#### Parameters
@@ -146,8 +132,6 @@ ___
<ParameterTypes parameters={[{"name":"this","type":"`this`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### workStage
Performs an atomic work stage.