Files
medusa-store/www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractPriceSelectionStrategy.md
github-actions[bot] daea35fe73 chore(docs): Generated JS Client Reference (#5334)
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>
2023-10-10 17:47:07 +00:00

7.0 KiB

displayed_sidebar
displayed_sidebar
jsClientSidebar

Class: AbstractPriceSelectionStrategy

internal.internal.AbstractPriceSelectionStrategy

Hierarchy

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


calculateVariantPrice

Abstract calculateVariantPrice(data, context): Promise<Map<string, PriceSelectionResult>>

Calculate the original and discount price for a given variant in a set of circumstances described in the context.

Parameters

Name Type Description
data { quantity?: number ; taxRates: TaxServiceRate[] ; variantId: string }[] -
context PriceSelectionContext Details relevant to determine the correct pricing of the variant

Returns

Promise<Map<string, PriceSelectionResult>>

pricing details in an object containing the calculated lowest price, the default price an all valid prices for the given variant

Implementation of

IPriceSelectionStrategy.calculateVariantPrice

Defined in

packages/medusa/dist/interfaces/price-selection-strategy.d.ts:26


onVariantsPricesUpdate

onVariantsPricesUpdate(variantIds): Promise<void>

Notify price selection strategy that variants prices have been updated.

Parameters

Name Type Description
variantIds string[] The ids of the updated variants

Returns

Promise<void>

Implementation of

IPriceSelectionStrategy.onVariantsPricesUpdate

Defined in

packages/medusa/dist/interfaces/price-selection-strategy.d.ts:31


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?): AbstractPriceSelectionStrategy

Parameters

Name Type
transactionManager? EntityManager

Returns

AbstractPriceSelectionStrategy

Implementation of

IPriceSelectionStrategy.withTransaction

Inherited from

TransactionBaseService.withTransaction

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:11