medusa-store/www/apps/docs/content/references/services/classes/BatchJobService.md

Class: BatchJobService

Hierarchy

• TransactionBaseService

  ↳ BatchJobService

Constructors

constructor

• new BatchJobService(«destructured»)

Parameters

Name	Type
«destructured»	InjectedDependencies

Overrides

TransactionBaseService.constructor

Defined in

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

Properties

__configModule__

• Protected Optional Readonly __configModule__: Record<string, unknown>

Inherited from

TransactionBaseService.__configModule__

Defined in

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

---

__container__

• Protected Readonly __container__: any

Inherited from

TransactionBaseService.__container__

Defined in

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

---

__moduleDeclaration__

• Protected Optional Readonly __moduleDeclaration__: Record<string, unknown>

Inherited from

TransactionBaseService.__moduleDeclaration__

Defined in

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

---

batchJobRepository_

• Protected Readonly batchJobRepository_: Repository<BatchJob>

Defined in

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

---

batchJobStatusMapToProps

• Protected batchJobStatusMapToProps: Map<BatchJobStatus, { entityColumnName: string ; eventType: string }>

Defined in

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

---

eventBus_

• Protected Readonly eventBus_: EventBusService

Defined in

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

---

manager_

• Protected manager_: EntityManager

Inherited from

TransactionBaseService.manager_

Defined in

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

---

strategyResolver_

• Protected Readonly strategyResolver_: StrategyResolverService

Defined in

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

---

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Inherited from

TransactionBaseService.transactionManager_

Defined in

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

---

Events

▪ Static Readonly Events: Object

Type declaration

Name	Type
CANCELED	string
COMPLETED	string
CONFIRMED	string
CREATED	string
FAILED	string
PRE_PROCESSED	string
PROCESSING	string
UPDATED	string

Defined in

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

Accessors

activeManager_

• Protected get activeManager_(): EntityManager

Returns

EntityManager

Inherited from

TransactionBaseService.activeManager_

Defined in

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

Methods

atomicPhase_

▸ Protected atomicPhase_<TResult, TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>

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
TResult
TError

Parameters

Name	Type	Description
work	(transactionManager: EntityManager) => Promise<TResult>	the 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<TResult>

the result of the transactional work

Inherited from

TransactionBaseService.atomicPhase_

Defined in

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

---

cancel

▸ cancel(batchJobOrId): Promise<BatchJob>

Parameters

Name	Type
batchJobOrId	string | BatchJob

Returns

Promise<BatchJob>

Defined in

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

---

complete

▸ complete(batchJobOrId): Promise<BatchJob>

Parameters

Name	Type
batchJobOrId	string | BatchJob

Returns

Promise<BatchJob>

Defined in

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

---

confirm

▸ confirm(batchJobOrId): Promise<BatchJob>

Parameters

Name	Type
batchJobOrId	string | BatchJob

Returns

Promise<BatchJob>

Defined in

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

---

create

▸ create(data): Promise<BatchJob>

Parameters

Name	Type
data	BatchJobCreateProps

Returns

Promise<BatchJob>

Defined in

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

---

listAndCount

▸ listAndCount(selector?, config?): Promise<[BatchJob[], number]>

Parameters

Name	Type
selector	FilterableBatchJobProps
config	FindConfig<BatchJob>

Returns

Promise<[BatchJob[], number]>

Defined in

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

---

prepareBatchJobForProcessing

▸ prepareBatchJobForProcessing(data, req): Promise<CreateBatchJobInput>

Parameters

Name	Type
data	CreateBatchJobInput
req	Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

Returns

Promise<CreateBatchJobInput>

Defined in

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

---

retrieve

▸ retrieve(batchJobId, config?): Promise<BatchJob>

Parameters

Name	Type
batchJobId	string
config	FindConfig<BatchJob>

Returns

Promise<BatchJob>

Defined in

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

---

setFailed

▸ setFailed(batchJobOrId, error?): Promise<BatchJob>

Parameters

Name	Type
batchJobOrId	string | BatchJob
error?	string | BatchJobResultError

Returns

Promise<BatchJob>

Defined in

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

---

setPreProcessingDone

▸ setPreProcessingDone(batchJobOrId): Promise<BatchJob>

Parameters

Name	Type
batchJobOrId	string | BatchJob

Returns

Promise<BatchJob>

Defined in

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

---

setProcessing

▸ setProcessing(batchJobOrId): Promise<BatchJob>

Parameters

Name	Type
batchJobOrId	string | BatchJob

Returns

Promise<BatchJob>

Defined in

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

---

shouldRetryTransaction_

▸ Protected shouldRetryTransaction_(err): boolean

Parameters

Name	Type
err	Record<string, unknown> | { code: string }

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

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

---

update

▸ update(batchJobOrId, data): Promise<BatchJob>

Parameters

Name	Type
batchJobOrId	string | BatchJob
data	Partial<Pick<BatchJob, "context" | "result">>

Returns

Promise<BatchJob>

Defined in

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

---

updateStatus

▸ Protected updateStatus(batchJobOrId, status): Promise<BatchJob>

Parameters

Name	Type
batchJobOrId	string | BatchJob
status	BatchJobStatus

Returns

Promise<BatchJob>

Defined in

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

---

withTransaction

▸ withTransaction(transactionManager?): BatchJobService

Parameters

Name	Type
transactionManager?	EntityManager

Returns

BatchJobService

Inherited from

TransactionBaseService.withTransaction

Defined in

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