Skip to main content

Class: BatchJobService

Hierarchy

  • TransactionBaseService

    BatchJobService

Constructors

constructor

new BatchJobService(__namedParameters)

Parameters

NameType
__namedParametersInjectedDependencies

Overrides

TransactionBaseService.constructor

Defined in

packages/medusa/src/services/batch-job.ts:93

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


batchJobRepository_

Protected Readonly batchJobRepository_: typeof BatchJobRepository

Defined in

packages/medusa/src/services/batch-job.ts:41


batchJobStatusMapToProps

Protected batchJobStatusMapToProps: Map<BatchJobStatus, { entityColumnName: string ; eventType: string }>

Defined in

packages/medusa/src/services/batch-job.ts:45


eventBus_

Protected Readonly eventBus_: EventBusService

Defined in

packages/medusa/src/services/batch-job.ts:42


manager_

Protected manager_: EntityManager

Overrides

TransactionBaseService.manager_

Defined in

packages/medusa/src/services/batch-job.ts:38


strategyResolver_

Protected Readonly strategyResolver_: StrategyResolverService

Defined in

packages/medusa/src/services/batch-job.ts:43


transactionManager_

Protected transactionManager_: undefined | EntityManager

Overrides

TransactionBaseService.transactionManager_

Defined in

packages/medusa/src/services/batch-job.ts:39


Events

Static Readonly Events: Object

Type declaration

NameType
CANCELEDstring
COMPLETEDstring
CONFIRMEDstring
CREATEDstring
FAILEDstring
PRE_PROCESSEDstring
PROCESSINGstring
UPDATEDstring

Defined in

packages/medusa/src/services/batch-job.ts:27

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


cancel

cancel(batchJobOrId): Promise<BatchJob>

Parameters

NameType
batchJobOrIdstring | BatchJob

Returns

Promise<BatchJob>

Defined in

packages/medusa/src/services/batch-job.ts:274


complete

complete(batchJobOrId): Promise<BatchJob>

Parameters

NameType
batchJobOrIdstring | BatchJob

Returns

Promise<BatchJob>

Defined in

packages/medusa/src/services/batch-job.ts:256


confirm

confirm(batchJobOrId): Promise<BatchJob>

Parameters

NameType
batchJobOrIdstring | BatchJob

Returns

Promise<BatchJob>

Defined in

packages/medusa/src/services/batch-job.ts:238


create

create(data): Promise<BatchJob>

Parameters

NameType
dataBatchJobCreateProps

Returns

Promise<BatchJob>

Defined in

packages/medusa/src/services/batch-job.ts:143


listAndCount

listAndCount(selector?, config?): Promise<[BatchJob[], number]>

Parameters

NameType
selectorFilterableBatchJobProps
configFindConfig<BatchJob>

Returns

Promise<[BatchJob[], number]>

Defined in

packages/medusa/src/services/batch-job.ts:132


prepareBatchJobForProcessing

prepareBatchJobForProcessing(data, req): Promise<CreateBatchJobInput>

Parameters

NameType
dataCreateBatchJobInput
reqRequest<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

Returns

Promise<CreateBatchJobInput>

Defined in

packages/medusa/src/services/batch-job.ts:371


retrieve

retrieve(batchJobId, config?): Promise<BatchJob>

Parameters

NameType
batchJobIdstring
configFindConfig<BatchJob>

Returns

Promise<BatchJob>

Defined in

packages/medusa/src/services/batch-job.ts:112


setFailed

setFailed(batchJobOrId, error?): Promise<BatchJob>

Parameters

NameType
batchJobOrIdstring | BatchJob
error?BatchJobResultError

Returns

Promise<BatchJob>

Defined in

packages/medusa/src/services/batch-job.ts:345


setPreProcessingDone

setPreProcessingDone(batchJobOrId): Promise<BatchJob>

Parameters

NameType
batchJobOrIdstring | BatchJob

Returns

Promise<BatchJob>

Defined in

packages/medusa/src/services/batch-job.ts:292


setProcessing

setProcessing(batchJobOrId): Promise<BatchJob>

Parameters

NameType
batchJobOrIdstring | BatchJob

Returns

Promise<BatchJob>

Defined in

packages/medusa/src/services/batch-job.ts:325


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(batchJobOrId, data): Promise<BatchJob>

Parameters

NameType
batchJobOrIdstring | BatchJob
dataPartial<Pick<BatchJob, "context" | "result">>

Returns

Promise<BatchJob>

Defined in

packages/medusa/src/services/batch-job.ts:162


updateStatus

Protected updateStatus(batchJobOrId, status): Promise<BatchJob>

Parameters

NameType
batchJobOrIdstring | BatchJob
statusBatchJobStatus

Returns

Promise<BatchJob>

Defined in

packages/medusa/src/services/batch-job.ts:203


withTransaction

withTransaction(transactionManager?): BatchJobService

Parameters

NameType
transactionManager?EntityManager

Returns

BatchJobService

Inherited from

TransactionBaseService.withTransaction

Defined in

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