Files
medusa-store/docs/content/references/services/classes/ClaimItemService.md
2022-09-06 11:06:32 +03:00

7.4 KiB

Class: ClaimItemService

Hierarchy

  • TransactionBaseService

    ClaimItemService

Constructors

constructor

new ClaimItemService(__namedParameters)

Parameters

Name Type
__namedParameters Object

Overrides

BaseService.constructor

Defined in

packages/medusa/src/services/claim-item.ts:30

Properties

__configModule__

Protected Optional Readonly __configModule__: Record<string, unknown>

Inherited from

BaseService.__configModule__

Defined in

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


__container__

Protected Readonly __container__: any

Inherited from

BaseService.__container__

Defined in

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


claimImageRepository_

Protected Readonly claimImageRepository_: typeof ClaimImageRepository

Defined in

packages/medusa/src/services/claim-item.ts:25


claimItemRepository_

Protected Readonly claimItemRepository_: typeof ClaimItemRepository

Defined in

packages/medusa/src/services/claim-item.ts:23


claimTagRepository_

Protected Readonly claimTagRepository_: typeof ClaimTagRepository

Defined in

packages/medusa/src/services/claim-item.ts:24


eventBus_

Protected Readonly eventBus_: EventBusService

Defined in

packages/medusa/src/services/claim-item.ts:22


lineItemService_

Protected Readonly lineItemService_: LineItemService

Defined in

packages/medusa/src/services/claim-item.ts:21


manager_

Protected manager_: EntityManager

Overrides

BaseService.manager_

Defined in

packages/medusa/src/services/claim-item.ts:27


transactionManager_

Protected transactionManager_: undefined | EntityManager

Overrides

BaseService.transactionManager_

Defined in

packages/medusa/src/services/claim-item.ts:28


Events

Static Events: Object

Type declaration

Name Type
CANCELED string
CREATED string
UPDATED string

Defined in

packages/medusa/src/services/claim-item.ts:15

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

BaseService.atomicPhase_

Defined in

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


create

create(data): Promise<ClaimItem>

Parameters

Name Type
data CreateClaimItemInput

Returns

Promise<ClaimItem>

Defined in

packages/medusa/src/services/claim-item.ts:49


list

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

Parameters

Name Type Description
selector Selector<ClaimItem> the query object for find
config FindConfig<ClaimItem> the config object for find

Returns

Promise<ClaimItem[]>

the result of the find operation

Defined in

packages/medusa/src/services/claim-item.ts:214


retrieve

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

Gets a claim item by id.

Parameters

Name Type Description
id string id of ClaimItem to retrieve
config FindConfig<ClaimItem> configuration for the find operation

Returns

Promise<ClaimItem>

the ClaimItem

Defined in

packages/medusa/src/services/claim-item.ts:233


shouldRetryTransaction_

Protected shouldRetryTransaction_(err): boolean

Parameters

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

Returns

boolean

Inherited from

BaseService.shouldRetryTransaction_

Defined in

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


update

update(id, data): Promise<ClaimItem>

Parameters

Name Type
id any
data any

Returns

Promise<ClaimItem>

Defined in

packages/medusa/src/services/claim-item.ts:132


withTransaction

withTransaction(transactionManager?): ClaimItemService

Parameters

Name Type
transactionManager? EntityManager

Returns

ClaimItemService

Inherited from

BaseService.withTransaction

Defined in

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