Skip to main content
Skip to main content

IBatchJobStrategy

Properties

__configModule__Record<string, unknown>
__container__anyRequired
__moduleDeclaration__Record<string, unknown>
manager_EntityManagerRequired
transactionManager_undefined | EntityManagerRequired

Accessors

activeManager_

Returns

EntityManagerEntityManagerRequired

Methods

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

buildTemplate

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

Returns

PromisePromise<string>Required

preProcessBatchJob

Method for pre-processing a batch job

Parameters

batchJobIdstringRequired

Returns

PromisePromise<void>Required

prepareBatchJobForProcessing

Method for preparing a batch job for processing

Parameters

batchJobEntityCreateBatchJobInputRequired
reqRequestRequired

Returns

PromisePromise<CreateBatchJobInput>Required

processJob

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

Parameters

batchJobIdstringRequired

Returns

PromisePromise<void>Required

shouldRetryTransaction_

Parameters

errRecord<string, unknown> | objectRequired

Returns

booleanboolean

withTransaction

Parameters

transactionManagerEntityManager

Returns

__configModule__Record<string, unknown>
__container__anyRequired
__moduleDeclaration__Record<string, unknown>
manager_EntityManagerRequired
transactionManager_undefined | EntityManagerRequired
activeManager_objectRequired
atomicPhase_<TResult, TError>(work: (transactionManager: EntityManager) => Promise<TResult>, isolationOrErrorHandler?: IsolationLevel | (error: TError) => Promise<void | TResult>, maybeErrorHandlerOrDontFail?: (error: TError) => Promise<void | TResult>) => Promise<TResult>Required
buildTemplate() => Promise<string>Required
preProcessBatchJob(batchJobId: string) => Promise<void>Required
prepareBatchJobForProcessing(batchJobEntity: CreateBatchJobInput, req: Request) => Promise<CreateBatchJobInput>Required
processJob(batchJobId: string) => Promise<void>Required
shouldRetryTransaction_(err: Record<string, unknown> | { code: string }) => booleanRequired
withTransaction(transactionManager?: EntityManager) => IBatchJobStrategyRequired
Was this section helpful?