AbstractBatchJobStrategy
constructor
Parameters
__container__anyRequired__configModule__Record<string, unknown>__moduleDeclaration__Record<string, unknown>Properties
__configModule__Record<string, unknown>__container__anyRequired__moduleDeclaration__Record<string, unknown>manager_EntityManagerRequiredtransactionManager_undefined | EntityManagerRequiredbatchTypestringRequiredidentifierstringRequiredAccessors
activeManager_
Returns
EntityManagerEntityManagerRequiredMethods
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
TResultobjectRequiredTErrorobjectRequiredParameters
work(transactionManager: EntityManager) => Promise<TResult>Requiredthe 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>Requiredthe result of the transactional work
PromisePromise<TResult>RequiredbuildTemplate
Builds and returns a template file that can be downloaded and filled in
Returns
PromisePromise<string>Required
PromisePromise<string>RequiredhandleProcessingError
Type Parameters
TobjectRequiredParameters
batchJobIdstringRequirederrunknownRequiredresultTRequiredReturns
PromisePromise<void>RequiredpreProcessBatchJob
Method for pre-processing a batch job
Parameters
batchJobIdstringRequiredReturns
PromisePromise<void>RequiredprepareBatchJobForProcessing
Method for preparing a batch job for processing
Parameters
reqRequestRequiredReturns
processJob
Method does the actual processing of the job. Should report back on the progress of the operation.
Parameters
batchJobIdstringRequiredReturns
PromisePromise<void>RequiredshouldRetryOnProcessingError
Parameters
A Batch Job indicates an asynchronus task stored in the Medusa backend. Its status determines whether it has been executed or not.
errunknownRequiredReturns
PromisePromise<boolean>Required
PromisePromise<boolean>RequiredshouldRetryTransaction_
Parameters
errRecord<string, unknown> | objectRequiredReturns
booleanbooleanwithTransaction
Parameters
transactionManagerEntityManagerReturns
constructor(__container__: any, __configModule__?: Record<string, unknown>, __moduleDeclaration__?: Record<string, unknown>) => AbstractBatchJobStrategyRequired__configModule__Record<string, unknown>__container__anyRequired__moduleDeclaration__Record<string, unknown>manager_EntityManagerRequiredtransactionManager_undefined | EntityManagerRequiredbatchTypestringRequiredidentifierstringRequiredactiveManager_objectRequiredatomicPhase_<TResult, TError>(work: (transactionManager: EntityManager) => Promise<TResult>, isolationOrErrorHandler?: IsolationLevel | (error: TError) => Promise<void | TResult>, maybeErrorHandlerOrDontFail?: (error: TError) => Promise<void | TResult>) => Promise<TResult>RequiredbuildTemplate() => Promise<string>RequiredhandleProcessingError<T>(batchJobId: string, err: unknown, result: T) => Promise<void>RequiredpreProcessBatchJob(batchJobId: string) => Promise<void>RequiredprepareBatchJobForProcessing(batchJob: CreateBatchJobInput, req: Request) => Promise<CreateBatchJobInput>RequiredprocessJob(batchJobId: string) => Promise<void>RequiredshouldRetryTransaction_(err: Record<string, unknown> | { code: string }) => booleanRequiredWas this section helpful?