Skip to main content

Class: LineItemAdjustmentService

Provides layer to manipulate line item adjustments.

Hierarchy

  • TransactionBaseService

    LineItemAdjustmentService

Constructors

constructor

new LineItemAdjustmentService(__namedParameters)

Parameters

NameType
__namedParametersLineItemAdjustmentServiceProps

Overrides

TransactionBaseService.constructor

Defined in

packages/medusa/src/services/line-item-adjustment.ts:39

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


__moduleDeclaration__

Protected Optional Readonly __moduleDeclaration__: Record<string, unknown>

Inherited from

TransactionBaseService.__moduleDeclaration__

Defined in

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


discountService

Private Readonly discountService: DiscountService

Defined in

packages/medusa/src/services/line-item-adjustment.ts:37


lineItemAdjustmentRepo_

Private Readonly lineItemAdjustmentRepo_: typeof LineItemAdjustmentRepository

Defined in

packages/medusa/src/services/line-item-adjustment.ts:36


manager_

Protected Readonly manager_: EntityManager

Overrides

TransactionBaseService.manager_

Defined in

packages/medusa/src/services/line-item-adjustment.ts:33


transactionManager_

Protected transactionManager_: undefined | EntityManager

Overrides

TransactionBaseService.transactionManager_

Defined in

packages/medusa/src/services/line-item-adjustment.ts:34

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

NameTypeDescription
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:50


create

create(data): Promise<LineItemAdjustment>

Creates a line item adjustment

Parameters

NameTypeDescription
dataPartial<LineItemAdjustment>the line item adjustment to create

Returns

Promise<LineItemAdjustment>

line item adjustment

Defined in

packages/medusa/src/services/line-item-adjustment.ts:90


createAdjustmentForLineItem

createAdjustmentForLineItem(cart, lineItem): Promise<LineItemAdjustment[]>

Creates adjustment for a line item

Parameters

NameTypeDescription
cartCartthe cart object holding discounts
lineItemLineItemthe line item for which a line item adjustment might be created

Returns

Promise<LineItemAdjustment[]>

a line item adjustment or undefined if no adjustment was created

Defined in

packages/medusa/src/services/line-item-adjustment.ts:263


createAdjustments

createAdjustments(cart, lineItem?): Promise<LineItemAdjustment[] | LineItemAdjustment[][]>

Creates adjustment for a line item

Parameters

NameTypeDescription
cartCartthe cart object holding discounts
lineItem?LineItemthe line item for which a line item adjustment might be created

Returns

Promise<LineItemAdjustment[] | LineItemAdjustment[][]>

if a lineItem was given, returns a line item adjustment or undefined if no adjustment was created otherwise returns an array of line item adjustments for each line item in the cart

Defined in

packages/medusa/src/services/line-item-adjustment.ts:291


delete

delete(selectorOrIds): Promise<void>

Deletes line item adjustments matching a selector

Parameters

NameTypeDescription
selectorOrIdsstring | string[] | FilterableLineItemAdjustmentProps & { discount_id?: FindOperator<null | string> }the query object for find or the line item adjustment id

Returns

Promise<void>

the result of the delete operation

Defined in

packages/medusa/src/services/line-item-adjustment.ts:155


generateAdjustments

generateAdjustments(calculationContextData, generatedLineItem, context): Promise<GeneratedAdjustment[]>

Creates adjustment for a line item

Parameters

NameTypeDescription
calculationContextDataCalculationContextDatathe calculationContextData object holding discounts
generatedLineItemLineItemthe line item for which a line item adjustment might be created
contextAdjustmentContextthe line item for which a line item adjustment might be created

Returns

Promise<GeneratedAdjustment[]>

a line item adjustment or undefined if no adjustment was created

Defined in

packages/medusa/src/services/line-item-adjustment.ts:189


list

list(selector?, config?): Promise<LineItemAdjustment[]>

Lists line item adjustments

Parameters

NameTypeDescription
selectorFilterableLineItemAdjustmentPropsthe query object for find
configFindConfig<LineItemAdjustment>the config to be used for find

Returns

Promise<LineItemAdjustment[]>

the result of the find operation

Defined in

packages/medusa/src/services/line-item-adjustment.ts:138


retrieve

retrieve(lineItemAdjustmentId, config?): Promise<LineItemAdjustment>

Retrieves a line item adjustment by id.

Parameters

NameTypeDescription
lineItemAdjustmentIdstringthe id of the line item adjustment to retrieve
configFindConfig<LineItemAdjustment>the config to retrieve the line item adjustment by

Returns

Promise<LineItemAdjustment>

the line item adjustment.

Defined in

packages/medusa/src/services/line-item-adjustment.ts:58


shouldRetryTransaction_

Protected shouldRetryTransaction_(err): boolean

Parameters

NameType
errRecord<string, unknown> | { code: string }

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

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


update

update(id, data): Promise<LineItemAdjustment>

Creates a line item adjustment

Parameters

NameTypeDescription
idstringthe line item adjustment id to update
dataPartial<LineItemAdjustment>the line item adjustment to create

Returns

Promise<LineItemAdjustment>

line item adjustment

Defined in

packages/medusa/src/services/line-item-adjustment.ts:107


withTransaction

withTransaction(transactionManager?): LineItemAdjustmentService

Parameters

NameType
transactionManager?EntityManager

Returns

LineItemAdjustmentService

Inherited from

TransactionBaseService.withTransaction

Defined in

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