BatchJobService
constructor
Parameters
__namedParameters
InjectedDependenciesRequiredProperties
manager_
EntityManagerRequiredtransactionManager_
undefined | EntityManagerRequired__container__
anyRequiredEvents
objectRequiredEvents.CREATED
stringRequiredDefault: "batch.created"
Events.UPDATED
stringRequiredDefault: "batch.updated"
Events.PRE_PROCESSED
stringRequiredDefault: "batch.pre_processed"
Events.CONFIRMED
stringRequiredDefault: "batch.confirmed"
Events.PROCESSING
stringRequiredDefault: "batch.processing"
Events.COMPLETED
stringRequiredDefault: "batch.completed"
Events.CANCELED
stringRequiredDefault: "batch.canceled"
Events.FAILED
stringRequiredDefault: "batch.failed"
__configModule__
Record<string, unknown>__moduleDeclaration__
Record<string, unknown>Accessors
activeManager_
Returns
EntityManager
EntityManagerRequiredMethods
withTransaction
Parameters
transactionManager
EntityManagerReturns
this
thisRequiredshouldRetryTransaction_
Parameters
err
Record<string, unknown> | objectRequiredReturns
boolean
booleanRequiredatomicPhase_
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
TResult
objectRequiredTError
objectRequiredParameters
work
(transactionManager: EntityManager) => Promise<TResult>Requiredthe 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
Promise<TResult>Requiredthe result of the transactional work
retrieve
Parameters
batchJobId
stringRequiredDefault: {}
Returns
listAndCount
Parameters
Default: {}
Returns
create
Parameters
Returns
update
Parameters
Returns
confirm
Parameters
Returns
complete
Parameters
Returns
cancel
Parameters
Returns
setPreProcessingDone
Parameters
Returns
setProcessing
Parameters
Returns
setFailed
Parameters
error
string | BatchJobResultErrorReturns
prepareBatchJobForProcessing
Parameters
req
Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>RequiredReturns
updateStatus
Parameters
Returns
Was this section helpful?