asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
Files
5dee25e5eef76fb2e8cc02e280d633fa71d4325e
medusa-store/www/apps/docs/content/references/services/classes/LineItemAdjustmentService.md
Shahed Nasser fa7c94b4cc docs: create docs workspace (#5174) 
* docs: migrate ui docs to docs universe

* created yarn workspace

* added eslint and tsconfig configurations

* fix eslint configurations

* fixed eslint configurations

* shared tailwind configurations

* added shared ui package

* added more shared components

* migrating more components

* made details components shared

* move InlineCode component

* moved InputText

* moved Loading component

* Moved Modal component

* moved Select components

* Moved Tooltip component

* moved Search components

* moved ColorMode provider

* Moved Notification components and providers

* used icons package

* use UI colors in api-reference

* moved Navbar component

* used Navbar and Search in UI docs

* added Feedback to UI docs

* general enhancements

* fix color mode

* added copy colors file from ui-preset

* added features and enhancements to UI docs

* move Sidebar component and provider

* general fixes and preparations for deployment

* update docusaurus version

* adjusted versions

* fix output directory

* remove rootDirectory property

* fix yarn.lock

* moved code component

* added vale for all docs MD and MDX

* fix tests

* fix vale error

* fix deployment errors

* change ignore commands

* add output directory

* fix docs test

* general fixes

* content fixes

* fix announcement script

* added changeset

* fix vale checks

* added nofilter option

* fix vale error
2023-09-21 20:57:15 +03:00

11 KiB
Raw Blame History

Class: LineItemAdjustmentService

Provides layer to manipulate line item adjustments.

Hierarchy

  • TransactionBaseService

    ↳ LineItemAdjustmentService

Constructors

constructor

• new LineItemAdjustmentService(__namedParameters)

Parameters

Name Type
__namedParameters LineItemAdjustmentServiceProps

Overrides

TransactionBaseService.constructor

Defined in

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

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

discountService

• Private Readonly discountService: DiscountService

Defined in

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

lineItemAdjustmentRepo_

• Private Readonly lineItemAdjustmentRepo_: Repository<LineItemAdjustment>

Defined in

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

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

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.

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

medusa/src/interfaces/transaction-base-service.ts:56

create

▸ create(data): Promise<LineItemAdjustment>

Creates a line item adjustment

Parameters

Name Type Description
data Partial<LineItemAdjustment> the line item adjustment to create

Returns

Promise<LineItemAdjustment>

line item adjustment

Defined in

medusa/src/services/line-item-adjustment.ts:86

createAdjustmentForLineItem

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

Creates adjustment for a line item

Parameters

Name Type Description
cart Cart the cart object holding discounts
lineItem LineItem the 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

medusa/src/services/line-item-adjustment.ts:262

createAdjustments

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

Creates adjustment for a line item

Parameters

Name Type Description
cart Cart the cart object holding discounts
lineItem? LineItem the 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

medusa/src/services/line-item-adjustment.ts:290

delete

▸ delete(selectorOrIds): Promise<void>

Deletes line item adjustments matching a selector

Parameters

Name Type Description
selectorOrIds string | 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

medusa/src/services/line-item-adjustment.ts:153

generateAdjustments

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

Creates adjustment for a line item

Parameters

Name Type Description
calculationContextData CalculationContextData the calculationContextData object holding discounts
generatedLineItem LineItem the line item for which a line item adjustment might be created
context AdjustmentContext the 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

medusa/src/services/line-item-adjustment.ts:188

list

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

Lists line item adjustments

Parameters

Name Type Description
selector FilterableLineItemAdjustmentProps the query object for find
config FindConfig<LineItemAdjustment> the config to be used for find

Returns

Promise<LineItemAdjustment[]>

the result of the find operation

Defined in

medusa/src/services/line-item-adjustment.ts:136

retrieve

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

Retrieves a line item adjustment by id.

Parameters

Name Type Description
lineItemAdjustmentId string the id of the line item adjustment to retrieve
config FindConfig<LineItemAdjustment> the config to retrieve the line item adjustment by

Returns

Promise<LineItemAdjustment>

the line item adjustment.

Defined in

medusa/src/services/line-item-adjustment.ts:53

shouldRetryTransaction_

▸ Protected shouldRetryTransaction_(err): boolean

Parameters

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

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

medusa/src/interfaces/transaction-base-service.ts:37

update

▸ update(id, data): Promise<LineItemAdjustment>

Creates a line item adjustment

Parameters

Name Type Description
id string the line item adjustment id to update
data Partial<LineItemAdjustment> the line item adjustment to create

Returns

Promise<LineItemAdjustment>

line item adjustment

Defined in

medusa/src/services/line-item-adjustment.ts:104

withTransaction

▸ withTransaction(transactionManager?): LineItemAdjustmentService

Parameters

Name Type
transactionManager? EntityManager

Returns

LineItemAdjustmentService

Inherited from

TransactionBaseService.withTransaction

Defined in

medusa/src/interfaces/transaction-base-service.ts:20

Reference in New Issue View Git Blame Copy Permalink