Skip to main content

Class: BatchJobService

Hierarchy

  • TransactionBaseServiceCopy to Clipboard

    BatchJobServiceCopy to Clipboard

Constructors

constructor

new BatchJobService(__namedParametersCopy to Clipboard)

Parameters

NameType
__namedParametersCopy to ClipboardInjectedDependenciesCopy to Clipboard

Overrides

TransactionBaseService.constructor

Defined in

medusa/src/services/batch-job.ts:91

Properties

__configModule__

ProtectedCopy to Clipboard OptionalCopy to Clipboard ReadonlyCopy to Clipboard __configModule__: RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>

Inherited from

TransactionBaseService.__configModule__

Defined in

medusa/src/interfaces/transaction-base-service.ts:14


__container__

ProtectedCopy to Clipboard ReadonlyCopy to Clipboard __container__: anyCopy to Clipboard

Inherited from

TransactionBaseService.__container__

Defined in

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


__moduleDeclaration__

ProtectedCopy to Clipboard OptionalCopy to Clipboard ReadonlyCopy to Clipboard __moduleDeclaration__: RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>

Inherited from

TransactionBaseService.__moduleDeclaration__

Defined in

medusa/src/interfaces/transaction-base-service.ts:15


batchJobRepository_

ProtectedCopy to Clipboard ReadonlyCopy to Clipboard batchJobRepository_: RepositoryCopy to Clipboard<BatchJobCopy to Clipboard>

Defined in

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


batchJobStatusMapToProps

ProtectedCopy to Clipboard batchJobStatusMapToProps: MapCopy to Clipboard<BatchJobStatusCopy to Clipboard, { entityColumnNameCopy to Clipboard: stringCopy to Clipboard ; eventTypeCopy to Clipboard: stringCopy to Clipboard }>

Defined in

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


eventBus_

ProtectedCopy to Clipboard ReadonlyCopy to Clipboard eventBus_: EventBusServiceCopy to Clipboard

Defined in

medusa/src/services/batch-job.ts:40


manager_

ProtectedCopy to Clipboard manager_: EntityManagerCopy to Clipboard

Inherited from

TransactionBaseService.manager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:5


strategyResolver_

ProtectedCopy to Clipboard ReadonlyCopy to Clipboard strategyResolver_: StrategyResolverServiceCopy to Clipboard

Defined in

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


transactionManager_

ProtectedCopy to Clipboard transactionManager_: undefinedCopy to Clipboard | EntityManagerCopy to Clipboard

Inherited from

TransactionBaseService.transactionManager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:6


Events

StaticCopy to Clipboard ReadonlyCopy to Clipboard Events: ObjectCopy to Clipboard

Type declaration

NameType
CANCELEDCopy to ClipboardstringCopy to Clipboard
COMPLETEDCopy to ClipboardstringCopy to Clipboard
CONFIRMEDCopy to ClipboardstringCopy to Clipboard
CREATEDCopy to ClipboardstringCopy to Clipboard
FAILEDCopy to ClipboardstringCopy to Clipboard
PRE_PROCESSEDCopy to ClipboardstringCopy to Clipboard
PROCESSINGCopy to ClipboardstringCopy to Clipboard
UPDATEDCopy to ClipboardstringCopy to Clipboard

Defined in

medusa/src/services/batch-job.ts:28

Accessors

activeManager_

ProtectedCopy to Clipboard getCopy to Clipboard activeManager_(): EntityManagerCopy to Clipboard

Returns

EntityManagerCopy to Clipboard

Inherited from

TransactionBaseService.activeManager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:8

Methods

atomicPhase_

ProtectedCopy to Clipboard atomicPhase_<TResultCopy to Clipboard, TErrorCopy to Clipboard>(workCopy to Clipboard, isolationOrErrorHandler?Copy to Clipboard, maybeErrorHandlerOrDontFail?Copy to Clipboard): PromiseCopy to Clipboard<TResultCopy to Clipboard>

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
TResultCopy to Clipboard
TErrorCopy to Clipboard

Parameters

NameTypeDescription
workCopy to Clipboard(transactionManagerCopy to Clipboard: EntityManagerCopy to Clipboard) => PromiseCopy to Clipboard<TResultCopy to Clipboard>the transactional work to be done
isolationOrErrorHandler?Copy to ClipboardIsolationLevelCopy to Clipboard | (errorCopy to Clipboard: TErrorCopy to Clipboard) => PromiseCopy to Clipboard<voidCopy to Clipboard | TResultCopy to Clipboard>the isolation level to be used for the work.
maybeErrorHandlerOrDontFail?Copy to Clipboard(errorCopy to Clipboard: TErrorCopy to Clipboard) => PromiseCopy to Clipboard<voidCopy to Clipboard | TResultCopy to Clipboard>Potential error handler

Returns

PromiseCopy to Clipboard<TResultCopy to Clipboard>

the result of the transactional work

Inherited from

TransactionBaseService.atomicPhase_

Defined in

medusa/src/interfaces/transaction-base-service.ts:56


cancel

cancel(batchJobOrIdCopy to Clipboard): PromiseCopy to Clipboard<BatchJobCopy to Clipboard>

Parameters

NameType
batchJobOrIdCopy to ClipboardstringCopy to Clipboard | BatchJobCopy to Clipboard

Returns

PromiseCopy to Clipboard<BatchJobCopy to Clipboard>

Defined in

medusa/src/services/batch-job.ts:270


complete

complete(batchJobOrIdCopy to Clipboard): PromiseCopy to Clipboard<BatchJobCopy to Clipboard>

Parameters

NameType
batchJobOrIdCopy to ClipboardstringCopy to Clipboard | BatchJobCopy to Clipboard

Returns

PromiseCopy to Clipboard<BatchJobCopy to Clipboard>

Defined in

medusa/src/services/batch-job.ts:252


confirm

confirm(batchJobOrIdCopy to Clipboard): PromiseCopy to Clipboard<BatchJobCopy to Clipboard>

Parameters

NameType
batchJobOrIdCopy to ClipboardstringCopy to Clipboard | BatchJobCopy to Clipboard

Returns

PromiseCopy to Clipboard<BatchJobCopy to Clipboard>

Defined in

medusa/src/services/batch-job.ts:234


create

create(dataCopy to Clipboard): PromiseCopy to Clipboard<BatchJobCopy to Clipboard>

Parameters

NameType
dataCopy to ClipboardBatchJobCreatePropsCopy to Clipboard

Returns

PromiseCopy to Clipboard<BatchJobCopy to Clipboard>

Defined in

medusa/src/services/batch-job.ts:144


listAndCount

listAndCount(selector?Copy to Clipboard, config?Copy to Clipboard): PromiseCopy to Clipboard<[BatchJobCopy to Clipboard[], numberCopy to Clipboard]>

Parameters

NameType
selectorCopy to ClipboardFilterableBatchJobPropsCopy to Clipboard
configCopy to ClipboardFindConfigCopy to Clipboard<BatchJobCopy to Clipboard>

Returns

PromiseCopy to Clipboard<[BatchJobCopy to Clipboard[], numberCopy to Clipboard]>

Defined in

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


prepareBatchJobForProcessing

prepareBatchJobForProcessing(dataCopy to Clipboard, reqCopy to Clipboard): PromiseCopy to Clipboard<CreateBatchJobInputCopy to Clipboard>

Parameters

NameType
dataCopy to ClipboardCreateBatchJobInputCopy to Clipboard
reqCopy to ClipboardRequestCopy to Clipboard<ParamsDictionaryCopy to Clipboard, anyCopy to Clipboard, anyCopy to Clipboard, ParsedQsCopy to Clipboard, RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard>>

Returns

PromiseCopy to Clipboard<CreateBatchJobInputCopy to Clipboard>

Defined in

medusa/src/services/batch-job.ts:367


retrieve

retrieve(batchJobIdCopy to Clipboard, config?Copy to Clipboard): PromiseCopy to Clipboard<BatchJobCopy to Clipboard>

Parameters

NameType
batchJobIdCopy to ClipboardstringCopy to Clipboard
configCopy to ClipboardFindConfigCopy to Clipboard<BatchJobCopy to Clipboard>

Returns

PromiseCopy to Clipboard<BatchJobCopy to Clipboard>

Defined in

medusa/src/services/batch-job.ts:104


setFailed

setFailed(batchJobOrIdCopy to Clipboard, error?Copy to Clipboard): PromiseCopy to Clipboard<BatchJobCopy to Clipboard>

Parameters

NameType
batchJobOrIdCopy to ClipboardstringCopy to Clipboard | BatchJobCopy to Clipboard
error?Copy to ClipboardstringCopy to Clipboard | BatchJobResultErrorCopy to Clipboard

Returns

PromiseCopy to Clipboard<BatchJobCopy to Clipboard>

Defined in

medusa/src/services/batch-job.ts:341


setPreProcessingDone

setPreProcessingDone(batchJobOrIdCopy to Clipboard): PromiseCopy to Clipboard<BatchJobCopy to Clipboard>

Parameters

NameType
batchJobOrIdCopy to ClipboardstringCopy to Clipboard | BatchJobCopy to Clipboard

Returns

PromiseCopy to Clipboard<BatchJobCopy to Clipboard>

Defined in

medusa/src/services/batch-job.ts:288


setProcessing

setProcessing(batchJobOrIdCopy to Clipboard): PromiseCopy to Clipboard<BatchJobCopy to Clipboard>

Parameters

NameType
batchJobOrIdCopy to ClipboardstringCopy to Clipboard | BatchJobCopy to Clipboard

Returns

PromiseCopy to Clipboard<BatchJobCopy to Clipboard>

Defined in

medusa/src/services/batch-job.ts:321


shouldRetryTransaction_

ProtectedCopy to Clipboard shouldRetryTransaction_(errCopy to Clipboard): booleanCopy to Clipboard

Parameters

NameType
errCopy to ClipboardRecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard> | { codeCopy to Clipboard: stringCopy to Clipboard }

Returns

booleanCopy to Clipboard

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

medusa/src/interfaces/transaction-base-service.ts:37


update

update(batchJobOrIdCopy to Clipboard, dataCopy to Clipboard): PromiseCopy to Clipboard<BatchJobCopy to Clipboard>

Parameters

NameType
batchJobOrIdCopy to ClipboardstringCopy to Clipboard | BatchJobCopy to Clipboard
dataCopy to ClipboardPartialCopy to Clipboard<PickCopy to Clipboard<BatchJobCopy to Clipboard, "context"Copy to Clipboard | "result"Copy to Clipboard>>

Returns

PromiseCopy to Clipboard<BatchJobCopy to Clipboard>

Defined in

medusa/src/services/batch-job.ts:161


updateStatus

ProtectedCopy to Clipboard updateStatus(batchJobOrIdCopy to Clipboard, statusCopy to Clipboard): PromiseCopy to Clipboard<BatchJobCopy to Clipboard>

Parameters

NameType
batchJobOrIdCopy to ClipboardstringCopy to Clipboard | BatchJobCopy to Clipboard
statusCopy to ClipboardBatchJobStatusCopy to Clipboard

Returns

PromiseCopy to Clipboard<BatchJobCopy to Clipboard>

Defined in

medusa/src/services/batch-job.ts:200


withTransaction

withTransaction(transactionManager?Copy to Clipboard): BatchJobServiceCopy to Clipboard

Parameters

NameType
transactionManager?Copy to ClipboardEntityManagerCopy to Clipboard

Returns

BatchJobServiceCopy to Clipboard

Inherited from

TransactionBaseService.withTransaction

Defined in

medusa/src/interfaces/transaction-base-service.ts:20

Was this page helpful?