AbstractBatchJobStrategy

constructor

Parameters

__container__anyRequired

__configModule__Record<string, unknown>

__moduleDeclaration__Record<string, unknown>

---

Properties

_isBatchJobStrategybooleanRequired

Default: true

identifierstringRequired

batchTypestringRequired

batchJobService_BatchJobServiceRequired

manager_EntityManagerRequired

transactionManager_undefined | EntityManagerRequired

__container__anyRequired

__configModule__Record<string, unknown>

__moduleDeclaration__Record<string, unknown>

---

Accessors

activeManager_

Returns

EntityManagerEntityManagerRequired

---

Methods

isBatchJobStrategy

Parameters

objectanyRequired

Returns

objectobject is IBatchJobStrategyRequired

prepareBatchJobForProcessing

Method for preparing a batch job for processing

Parameters

batchJobCreateBatchJobInputRequired

reqRequestRequired

Returns

PromisePromise<CreateBatchJobInput>Required

Method for preparing a batch job for processing

preProcessBatchJob

Method for pre-processing a batch job

Parameters

batchJobIdstringRequired

Returns

PromisePromise<void>Required

Method for pre-processing a batch job

processJob

Method does the actual processing of the job. Should report back on the progress of the operation.

Parameters

batchJobIdstringRequired

Returns

PromisePromise<void>Required

Method does the actual processing of the job. Should report back on the progress of the operation.

buildTemplate

Builds and returns a template file that can be downloaded and filled in

Returns

PromisePromise<string>Required

Builds and returns a template file that can be downloaded and filled in

shouldRetryOnProcessingError

Parameters

batchJobBatchJobRequired

A Batch Job indicates an asynchronus task stored in the Medusa backend. Its status determines whether it has been executed or not.

errunknownRequired

Returns

PromisePromise<boolean>Required

handleProcessingError

Type Parameters

TobjectRequired

Parameters

batchJobIdstringRequired

errunknownRequired

resultTRequired

Returns

PromisePromise<void>Required

withTransaction

Parameters

transactionManagerEntityManager

Returns

thisthisRequired

shouldRetryTransaction_

Parameters

errRecord<string, unknown> | objectRequired

Returns

booleanbooleanRequired

atomicPhase_

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

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

PromisePromise<TResult>Required

the result of the transactional work