Files
medusa-store/www/apps/docs/content/references/services/classes/OrderEditItemChangeService.md
github-actions[bot] 074055acbb chore(docs): Generated Services Reference (automated) (#5333)
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
2023-10-09 19:57:05 +03:00

8.0 KiB

Class: OrderEditItemChangeService

Hierarchy

  • TransactionBaseService

    OrderEditItemChangeService

Constructors

constructor

new OrderEditItemChangeService(«destructured»)

Parameters

Name Type
«destructured» InjectedDependencies

Overrides

TransactionBaseService.constructor

Defined in

medusa/src/services/order-edit-item-change.ts:33

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


eventBus_

Protected Readonly eventBus_: IEventBusService

Defined in

medusa/src/services/order-edit-item-change.ts:29


lineItemService_

Protected Readonly lineItemService_: LineItemService

Defined in

medusa/src/services/order-edit-item-change.ts:30


manager_

Protected manager_: EntityManager

Inherited from

TransactionBaseService.manager_

Defined in

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


orderItemChangeRepository_

Protected Readonly orderItemChangeRepository_: Repository<OrderItemChange>

Defined in

medusa/src/services/order-edit-item-change.ts:28


taxProviderService_

Protected Readonly taxProviderService_: TaxProviderService

Defined in

medusa/src/services/order-edit-item-change.ts:31


transactionManager_

Protected transactionManager_: undefined | EntityManager

Inherited from

TransactionBaseService.transactionManager_

Defined in

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


Events

Static Readonly Events: Object

Type declaration

Name Type
CREATED string
DELETED string

Defined in

medusa/src/services/order-edit-item-change.ts:22

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<OrderItemChange>

Parameters

Name Type
data CreateOrderEditItemChangeInput

Returns

Promise<OrderItemChange>

Defined in

medusa/src/services/order-edit-item-change.ts:81


delete

delete(itemChangeIds): Promise<void>

Parameters

Name Type
itemChangeIds string | string[]

Returns

Promise<void>

Defined in

medusa/src/services/order-edit-item-change.ts:97


list

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

Parameters

Name Type
selector Selector<OrderItemChange>
config FindConfig<OrderItemChange>

Returns

Promise<OrderItemChange[]>

Defined in

medusa/src/services/order-edit-item-change.ts:69


retrieve

retrieve(id, config?): Promise<OrderItemChange>

Parameters

Name Type
id string
config FindConfig<OrderItemChange>

Returns

Promise<OrderItemChange>

Defined in

medusa/src/services/order-edit-item-change.ts:48


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


withTransaction

withTransaction(transactionManager?): OrderEditItemChangeService

Parameters

Name Type
transactionManager? EntityManager

Returns

OrderEditItemChangeService

Inherited from

TransactionBaseService.withTransaction

Defined in

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