Files
medusa-store/docs/content/references/services/classes/DiscountConditionService.md
2022-11-28 11:02:51 +02:00

7.5 KiB

Class: DiscountConditionService

Provides layer to manipulate discount conditions.

Implements

Hierarchy

  • TransactionBaseService

    DiscountConditionService

Constructors

constructor

new DiscountConditionService(__namedParameters)

Parameters

Name Type
__namedParameters InjectedDependencies

Overrides

TransactionBaseService.constructor

Defined in

packages/medusa/src/services/discount-condition.ts:37

Properties

__configModule__

Protected Optional Readonly __configModule__: Record<string, unknown>

Inherited from

TransactionBaseService.__configModule__

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:10


__container__

Protected Readonly __container__: any

Inherited from

TransactionBaseService.__container__

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:9


discountConditionRepository_

Protected Readonly discountConditionRepository_: typeof DiscountConditionRepository

Defined in

packages/medusa/src/services/discount-condition.ts:31


eventBus_

Protected Readonly eventBus_: EventBusService

Defined in

packages/medusa/src/services/discount-condition.ts:32


manager_

Protected manager_: EntityManager

Overrides

TransactionBaseService.manager_

Defined in

packages/medusa/src/services/discount-condition.ts:34


transactionManager_

Protected transactionManager_: undefined | EntityManager

Overrides

TransactionBaseService.transactionManager_

Defined in

packages/medusa/src/services/discount-condition.ts:35

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/src/interfaces/transaction-base-service.ts:48


delete

delete(discountConditionId): Promise<void | DiscountCondition>

Parameters

Name Type
discountConditionId string

Returns

Promise<void | DiscountCondition>

Defined in

packages/medusa/src/services/discount-condition.ts:213


removeResources

removeResources(data): Promise<void>

Parameters

Name Type
data Omit<DiscountConditionInput, "id"> & { id: string }

Returns

Promise<void>

Defined in

packages/medusa/src/services/discount-condition.ts:181


retrieve

retrieve(conditionId, config?): Promise<DiscountCondition>

Parameters

Name Type
conditionId string
config? FindConfig<DiscountCondition>

Returns

Promise<DiscountCondition>

Defined in

packages/medusa/src/services/discount-condition.ts:49


shouldRetryTransaction_

Protected shouldRetryTransaction_(err): boolean

Parameters

Name Type
err Record<string, unknown> | { code: string }

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:29


upsertCondition

upsertCondition(data, overrideExisting?): Promise<(DiscountConditionCustomerGroup | DiscountConditionProduct | DiscountConditionProductCollection | DiscountConditionProductTag | DiscountConditionProductType)[]>

Parameters

Name Type Default value
data DiscountConditionInput undefined
overrideExisting boolean true

Returns

Promise<(DiscountConditionCustomerGroup | DiscountConditionProduct | DiscountConditionProductCollection | DiscountConditionProductTag | DiscountConditionProductType)[]>

Defined in

packages/medusa/src/services/discount-condition.ts:109


withTransaction

withTransaction(transactionManager?): DiscountConditionService

Parameters

Name Type
transactionManager? EntityManager

Returns

DiscountConditionService

Inherited from

TransactionBaseService.withTransaction

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:13


resolveConditionType_

Static Protected resolveConditionType_(data): undefined | { resource_ids: (string | { id: string })[] ; type: DiscountConditionType }

Parameters

Name Type
data DiscountConditionInput

Returns

undefined | { resource_ids: (string | { id: string })[] ; type: DiscountConditionType }

Defined in

packages/medusa/src/services/discount-condition.ts:72