BatchJobService
Hierarchy
TransactionBaseService↳
BatchJobService
Constructors
constructor
new BatchJobService(«destructured»)
Parameters
| Name |
|---|
«destructured» |
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
-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.
| Name |
|---|
TResult |
TError |
Parameters
| Name | Description |
|---|---|
work | (transactionManager: EntityManager) => Promise<TResult> |
isolationOrErrorHandler? | IsolationLevel | (error: TError) => Promise<void | TResult> |
maybeErrorHandlerOrDontFail? | (error: TError) => Promise<void | TResult> |
Returns
Promise<TResult>
-Promise: 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 |
|---|
batchJobOrId |
Returns
Promise<BatchJob>
-Promise:
-BatchJob:
Defined in
medusa/src/services/batch-job.ts:270
complete
complete(batchJobOrId): Promise<BatchJob>
Parameters
| Name |
|---|
batchJobOrId |
Returns
Promise<BatchJob>
-Promise:
-BatchJob:
Defined in
medusa/src/services/batch-job.ts:252
confirm
confirm(batchJobOrId): Promise<BatchJob>
Parameters
| Name |
|---|
batchJobOrId |
Returns
Promise<BatchJob>
-Promise:
-BatchJob:
Defined in
medusa/src/services/batch-job.ts:234
create
create(data): Promise<BatchJob>
Parameters
| Name |
|---|
data |
Returns
Promise<BatchJob>
-Promise:
-BatchJob:
Defined in
medusa/src/services/batch-job.ts:144
listAndCount
listAndCount(selector?, config?): Promise<[BatchJob[], number]>
Parameters
| Name |
|---|
selector |
config |
Returns
Promise<[BatchJob[], number]>
-Promise:
-BatchJob[]:
-number: (optional)
Defined in
medusa/src/services/batch-job.ts:132
prepareBatchJobForProcessing
prepareBatchJobForProcessing(data, req): Promise<CreateBatchJobInput>
Parameters
| Name |
|---|
data |
req |
Returns
Promise<CreateBatchJobInput>
-Promise:
Defined in
medusa/src/services/batch-job.ts:367
retrieve
retrieve(batchJobId, config?): Promise<BatchJob>
Parameters
| Name |
|---|
batchJobId |
config |
Returns
Promise<BatchJob>
-Promise:
-BatchJob:
Defined in
medusa/src/services/batch-job.ts:104
setFailed
setFailed(batchJobOrId, error?): Promise<BatchJob>
Parameters
| Name |
|---|
batchJobOrId |
error? |
Returns
Promise<BatchJob>
-Promise:
-BatchJob:
Defined in
medusa/src/services/batch-job.ts:341
setPreProcessingDone
setPreProcessingDone(batchJobOrId): Promise<BatchJob>
Parameters
| Name |
|---|
batchJobOrId |
Returns
Promise<BatchJob>
-Promise:
-BatchJob:
Defined in
medusa/src/services/batch-job.ts:288
setProcessing
setProcessing(batchJobOrId): Promise<BatchJob>
Parameters
| Name |
|---|
batchJobOrId |
Returns
Promise<BatchJob>
-Promise:
-BatchJob:
Defined in
medusa/src/services/batch-job.ts:321
shouldRetryTransaction_
Protected shouldRetryTransaction_(err): boolean
Parameters
| Name |
|---|
err |
Returns
boolean
-boolean: (optional)
Inherited from
TransactionBaseService.shouldRetryTransaction_
Defined in
medusa/src/interfaces/transaction-base-service.ts:37
update
update(batchJobOrId, data): Promise<BatchJob>
Parameters
| Name |
|---|
batchJobOrId |
data |
Returns
Promise<BatchJob>
-Promise:
-BatchJob:
Defined in
medusa/src/services/batch-job.ts:161
updateStatus
Protected updateStatus(batchJobOrId, status): Promise<BatchJob>
Parameters
| Name |
|---|
batchJobOrId |
status |
Returns
Promise<BatchJob>
-Promise:
-BatchJob:
Defined in
medusa/src/services/batch-job.ts:200
withTransaction
withTransaction(transactionManager?): BatchJobService
Parameters
| Name |
|---|
transactionManager? |
Returns
-BatchJobService:
Inherited from
TransactionBaseService.withTransaction