Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
6.0 KiB
displayed_sidebar
| displayed_sidebar |
|---|
| jsClientSidebar |
Class: AbstractCartCompletionStrategy
internal.internal.AbstractCartCompletionStrategy
Hierarchy
-
↳
AbstractCartCompletionStrategy
Implements
Properties
__configModule__
• Protected Optional Readonly __configModule__: Record<string, unknown>
Inherited from
TransactionBaseService.configModule
Defined in
packages/medusa/dist/interfaces/transaction-base-service.d.ts:5
__container__
• Protected Readonly __container__: any
Inherited from
TransactionBaseService.container
Defined in
packages/medusa/dist/interfaces/transaction-base-service.d.ts:4
__moduleDeclaration__
• Protected Optional Readonly __moduleDeclaration__: Record<string, unknown>
Inherited from
TransactionBaseService.moduleDeclaration
Defined in
packages/medusa/dist/interfaces/transaction-base-service.d.ts:6
manager_
• Protected manager_: EntityManager
Inherited from
TransactionBaseService.manager_
Defined in
packages/medusa/dist/interfaces/transaction-base-service.d.ts:7
transactionManager_
• Protected transactionManager_: undefined | EntityManager
Inherited from
TransactionBaseService.transactionManager_
Defined in
packages/medusa/dist/interfaces/transaction-base-service.d.ts:8
Accessors
activeManager_
• Protected get activeManager_(): EntityManager
Returns
EntityManager
Inherited from
TransactionBaseService.activeManager_
Defined in
packages/medusa/dist/interfaces/transaction-base-service.d.ts:9
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.
Type parameters
| Name |
|---|
TResult |
TError |
Parameters
| Name | Type | Description |
|---|---|---|
work |
(transactionManager: EntityManager) => Promise<TResult> |
the transactional work to be done |
isolationOrErrorHandler? |
IsolationLevel | (error: TError) => Promise<void | TResult> |
the isolation level to be used for the work. |
maybeErrorHandlerOrDontFail? |
(error: TError) => Promise<void | TResult> |
Potential error handler |
Returns
Promise<TResult>
the result of the transactional work
Inherited from
TransactionBaseService.atomicPhase_
Defined in
packages/medusa/dist/interfaces/transaction-base-service.d.ts:24
complete
▸ Abstract complete(cartId, idempotencyKey, context): Promise<CartCompletionResponse>
Takes a cart id and completes the cart. This for example takes place when creating an order or confirming a swap.
Parameters
| Name | Type | Description |
|---|---|---|
cartId |
string |
the id of the Cart to complete. |
idempotencyKey |
IdempotencyKey |
the idempotency key for the request |
context |
RequestContext |
the request context for the completion request |
Returns
Promise<CartCompletionResponse>
the response for the completion request
Implementation of
ICartCompletionStrategy.complete
Defined in
packages/medusa/dist/interfaces/cart-completion-strategy.d.ts:22
shouldRetryTransaction_
▸ Protected shouldRetryTransaction_(err): boolean
Parameters
| Name | Type |
|---|---|
err |
Record<string, unknown> | { code: string } |
Returns
boolean
Inherited from
TransactionBaseService.shouldRetryTransaction_
Defined in
packages/medusa/dist/interfaces/transaction-base-service.d.ts:12
withTransaction
▸ withTransaction(transactionManager?): AbstractCartCompletionStrategy
Parameters
| Name | Type |
|---|---|
transactionManager? |
EntityManager |
Returns
AbstractCartCompletionStrategy
Inherited from
TransactionBaseService.withTransaction
Defined in
packages/medusa/dist/interfaces/transaction-base-service.d.ts:11