Skip to main content
Skip to main content

ClaimItemService

Constructors​

constructor​

new ClaimItemService(«destructured»)

Parameters​

__namedParametersObjectRequired

Properties​

__configModule__Record<string, unknown>
__container__anyRequired
__moduleDeclaration__Record<string, unknown>
claimImageRepository_Repository<ClaimImage>Required
claimItemRepository_Repository<ClaimItem>Required
claimTagRepository_Repository<ClaimTag>Required
eventBus_EventBusServiceRequired
lineItemService_LineItemServiceRequired
manager_EntityManagerRequired
transactionManager_undefined | EntityManagerRequired
EventsobjectRequired
Events.CANCELEDstringRequired

Default: "claim_item.canceled"

Events.CREATEDstringRequired

Default: "claim_item.created"

Events.UPDATEDstringRequired

Default: "claim_item.updated"

Accessors​

activeManager_​

Protected get activeManager_(): EntityManager

Returns​

EntityManager

EntityManagerEntityManagerRequired

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.

TResultobjectRequired
TErrorobjectRequired

Parameters​

work(transactionManager: EntityManager) => Promise<TResult>Required
the transactional work to be done
isolationOrErrorHandlerIsolationLevel | (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>

PromisePromise<TResult>Required
the result of the transactional work

create​

create(data): Promise<ClaimItem>

Parameters​

Returns​

Promise<ClaimItem>

PromisePromise<ClaimItem>Required

list​

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

Parameters​

selectorSelector<ClaimItem>Required
the query object for find
configFindConfig<ClaimItem>Required
the config object for find

Returns​

Promise<ClaimItem[]>

PromisePromise<ClaimItem[]>Required
the result of the find operation

retrieve​

retrieve(claimItemId, config?): Promise<ClaimItem>

Gets a claim item by id.

Parameters​

claimItemIdstringRequired
id of ClaimItem to retrieve
configFindConfig<ClaimItem>Required
configuration for the find operation

Default: {}

Returns​

Promise<ClaimItem>

PromisePromise<ClaimItem>Required
the ClaimItem

shouldRetryTransaction_​

Protected shouldRetryTransaction_(err): boolean

Parameters​

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

Returns​

boolean

booleanboolean

update​

update(id, data): Promise<ClaimItem>

Parameters​

idanyRequired
dataanyRequired

Returns​

Promise<ClaimItem>

PromisePromise<ClaimItem>Required

withTransaction​

withTransaction(transactionManager?): ClaimItemService

Parameters​

transactionManagerEntityManager

Returns​

ClaimItemService

ClaimItemServiceClaimItemServiceRequired
Was this section helpful?
© 2023 Medusa, Inc. All rights reserved.