aa2bb7a31b
Generated the following references: - `js-client` - `pricing` - `services` Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
8.8 KiB
IdempotencyKeyService
Hierarchy
-
TransactionBaseService↳
IdempotencyKeyService
Constructors
constructor
new IdempotencyKeyService(«destructured»)
Parameters
| Name |
|---|
«destructured» |
Overrides
TransactionBaseService.constructor
Defined in
medusa/src/services/idempotency-key.ts:25
Properties
__configModule__
Protected Optional Readonly __configModule__: Record<string, unknown>
Inherited from
TransactionBaseService.__configModule__
Defined in
medusa/src/interfaces/transaction-base-service.ts:14
__container__
Protected Readonly __container__: any
Inherited from
TransactionBaseService.__container__
Defined in
medusa/src/interfaces/transaction-base-service.ts:13
__moduleDeclaration__
Protected Optional Readonly __moduleDeclaration__: Record<string, unknown>
Inherited from
TransactionBaseService.__moduleDeclaration__
Defined in
medusa/src/interfaces/transaction-base-service.ts:15
idempotencyKeyRepository_
Protected Readonly idempotencyKeyRepository_: Repository<IdempotencyKey>
Defined in
medusa/src/services/idempotency-key.ts:23
manager_
Protected manager_: EntityManager
Inherited from
TransactionBaseService.manager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:5
transactionManager_
Protected transactionManager_: undefined | EntityManager
Inherited from
TransactionBaseService.transactionManager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:6
Accessors
activeManager_
Protected get activeManager_(): EntityManager
Returns
EntityManager
-EntityManager:
Inherited from
TransactionBaseService.activeManager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:8
Methods
atomicPhase_
Protected atomicPhase_<TResult, TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>
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.
| Name |
|---|
TResult |
TError |
Parameters
| Name | Description |
|---|---|
work |
(transactionManager: EntityManager) => Promise<TResult> |
isolationOrErrorHandler? |
IsolationLevel | (error: TError) => Promise<void | TResult> |
maybeErrorHandlerOrDontFail? |
(error: TError) => Promise<void | TResult> |
Returns
Promise<TResult>
-Promise: the result of the transactional work
Inherited from
TransactionBaseService.atomicPhase_
Defined in
medusa/src/interfaces/transaction-base-service.ts:56
create
create(payload): Promise<IdempotencyKey>
Creates an idempotency key for a request. If no idempotency key is provided in request, we will create a unique identifier.
Parameters
| Name | Description |
|---|---|
payload |
CreateIdempotencyKeyInput |
Returns
Promise<IdempotencyKey>
-Promise: the created idempotency key
-IdempotencyKey:
Defined in
medusa/src/services/idempotency-key.ts:68
initializeRequest
initializeRequest(headerKey, reqMethod, reqParams, reqPath): Promise<IdempotencyKey>
Execute the initial steps in a idempotent request.
Parameters
| Name | Description |
|---|---|
headerKey |
string |
reqMethod |
string |
reqParams |
Record<string, unknown> |
reqPath |
string |
Returns
Promise<IdempotencyKey>
-Promise: the existing or created idempotency key
-IdempotencyKey:
Defined in
medusa/src/services/idempotency-key.ts:40
lock
lock(idempotencyKey): Promise<IdempotencyKey>
Locks an idempotency.
Parameters
| Name | Description |
|---|---|
idempotencyKey |
string |
Returns
Promise<IdempotencyKey>
-Promise: result of the update operation
-IdempotencyKey:
Defined in
medusa/src/services/idempotency-key.ts:138
retrieve
retrieve(idempotencyKeyOrSelector): Promise<IdempotencyKey>
Retrieves an idempotency key
Parameters
| Name | Description |
|---|---|
idempotencyKeyOrSelector |
string | Selector<IdempotencyKey> |
Returns
Promise<IdempotencyKey>
-Promise: idempotency key
-IdempotencyKey:
Defined in
medusa/src/services/idempotency-key.ts:86
shouldRetryTransaction_
Protected shouldRetryTransaction_(err): boolean
Parameters
| Name |
|---|
err |
Returns
boolean
-boolean: (optional)
Inherited from
TransactionBaseService.shouldRetryTransaction_
Defined in
medusa/src/interfaces/transaction-base-service.ts:37
update
update(idempotencyKey, update): Promise<IdempotencyKey>
Locks an idempotency.
Parameters
| Name | Description |
|---|---|
idempotencyKey |
string |
update |
DeepPartial<IdempotencyKey> |
Returns
Promise<IdempotencyKey>
-Promise: result of the update operation
-IdempotencyKey:
Defined in
medusa/src/services/idempotency-key.ts:167
withTransaction
withTransaction(transactionManager?): IdempotencyKeyService
Parameters
| Name |
|---|
transactionManager? |
Returns
-IdempotencyKeyService:
Inherited from
TransactionBaseService.withTransaction
Defined in
medusa/src/interfaces/transaction-base-service.ts:20
workStage
workStage(idempotencyKey, callback): Promise<IdempotencyKey>
Performs an atomic work stage. An atomic work stage contains some related functionality, that needs to be 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
| Name | Description |
|---|---|
idempotencyKey |
string |
callback |
(transactionManager: EntityManager) => Promise<IdempotencyCallbackResult> |
Returns
Promise<IdempotencyKey>
-Promise: new updated idempotency key
-IdempotencyKey: