Files

Shahed Nasser 02d5c1da88 docs: update Typedoc and regenerate references (#1994 )

* generated new services reference

* changed from automatic push to automated pull request

* updated typedoc, regenerated JS Client reference

* regenerated the reference after updating typedoc

* added action for js client

2022-08-04 17:29:52 +03:00

10 KiB

Raw Blame History

Class: BatchJobService

Hierarchy

TransactionBaseService<BatchJobService>

↳ BatchJobService

Constructors

constructor

• new BatchJobService(__namedParameters)

Parameters

Name	Type
`__namedParameters`	`InjectedDependencies`

Overrides

TransactionBaseService<BatchJobService>.constructor

Defined in

packages/medusa/src/services/batch-job.ts:93

Properties

batchJobRepository_

• Protected Readonly batchJobRepository_: typeof BatchJobRepository

Defined in

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

batchJobStatusMapToProps

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

Defined in

packages/medusa/src/services/batch-job.ts:45

configModule

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

Inherited from

TransactionBaseService.configModule

Defined in

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

container

• Protected Readonly container: unknown

Inherited from

TransactionBaseService.container

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:12

eventBus_

• Protected Readonly eventBus_: EventBusService

Defined in

packages/medusa/src/services/batch-job.ts:42

manager_

• Protected manager_: EntityManager

Overrides

TransactionBaseService.manager_

Defined in

packages/medusa/src/services/batch-job.ts:38

strategyResolver_

• Protected Readonly strategyResolver_: StrategyResolverService

Defined in

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

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Overrides

TransactionBaseService.transactionManager_

Defined in

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

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

packages/medusa/src/services/batch-job.ts:27

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

packages/medusa/src/interfaces/transaction-base-service.ts:53

cancel

▸ cancel(batchJobOrId): Promise<BatchJob>

Parameters

Name	Type
`batchJobOrId`	`string` \| `BatchJob`

Returns

Promise<BatchJob>

Defined in

packages/medusa/src/services/batch-job.ts:274

complete

▸ complete(batchJobOrId): Promise<BatchJob>

Parameters

Name	Type
`batchJobOrId`	`string` \| `BatchJob`

Returns

Promise<BatchJob>

Defined in

packages/medusa/src/services/batch-job.ts:256

confirm

▸ confirm(batchJobOrId): Promise<BatchJob>

Parameters

Name	Type
`batchJobOrId`	`string` \| `BatchJob`

Returns

Promise<BatchJob>

Defined in

packages/medusa/src/services/batch-job.ts:238

create

▸ create(data): Promise<BatchJob>

Parameters

Name	Type
`data`	`BatchJobCreateProps`

Returns

Promise<BatchJob>

Defined in

packages/medusa/src/services/batch-job.ts:143

listAndCount

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

Parameters

Name	Type
`selector`	`FilterableBatchJobProps`
`config`	`FindConfig`<`BatchJob`>

Returns

Promise<[BatchJob[], number]>

Defined in

packages/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

packages/medusa/src/services/batch-job.ts:370

retrieve

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

Parameters

Name	Type
`batchJobId`	`string`
`config`	`FindConfig`<`BatchJob`>

Returns

Promise<BatchJob>

Defined in

packages/medusa/src/services/batch-job.ts:112

setFailed

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

Parameters

Name	Type
`batchJobOrId`	`string` \| `BatchJob`
`error?`	`BatchJobResultError`

Returns

Promise<BatchJob>

Defined in

packages/medusa/src/services/batch-job.ts:344

setPreProcessingDone

▸ setPreProcessingDone(batchJobOrId): Promise<BatchJob>

Parameters

Name	Type
`batchJobOrId`	`string` \| `BatchJob`

Returns

Promise<BatchJob>

Defined in

packages/medusa/src/services/batch-job.ts:292

setProcessing

▸ setProcessing(batchJobOrId): Promise<BatchJob>

Parameters

Name	Type
`batchJobOrId`	`string` \| `BatchJob`

Returns

Promise<BatchJob>

Defined in

packages/medusa/src/services/batch-job.ts:324

shouldRetryTransaction_

▸ Protected shouldRetryTransaction_(err): boolean

Parameters

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

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:34

update

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

Parameters

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

Returns

Promise<BatchJob>

Defined in

packages/medusa/src/services/batch-job.ts:162

updateStatus

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

Parameters

Name	Type
`batchJobOrId`	`string` \| `BatchJob`
`status`	`BatchJobStatus`

Returns

Promise<BatchJob>

Defined in

packages/medusa/src/services/batch-job.ts:203

withTransaction

▸ withTransaction(transactionManager?): BatchJobService

Parameters

Name	Type
`transactionManager?`	`EntityManager`

Returns

BatchJobService

Inherited from

TransactionBaseService.withTransaction

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:16

10 KiB Raw Blame History

Class: BatchJobService

Hierarchy

Constructors

constructor

Parameters

Overrides

Defined in

Properties

batchJobRepository_

Defined in

batchJobStatusMapToProps

Defined in

configModule

Inherited from

Defined in

container

Inherited from

Defined in

eventBus_

Defined in

manager_

Overrides

Defined in

strategyResolver_

Defined in

transactionManager_

Overrides

Defined in

Events

Type declaration

Defined in

Methods

atomicPhase_

Type parameters

Parameters

Returns

Inherited from

Defined in

cancel

Parameters

Returns

Defined in

complete

Parameters

Returns

Defined in

confirm

Parameters

Returns

Defined in

create

Parameters

Returns

Defined in

listAndCount

Parameters

Returns

Defined in

prepareBatchJobForProcessing

Parameters

Returns

Defined in

retrieve

Parameters

Returns

Defined in

setFailed

Parameters

Returns

Defined in

setPreProcessingDone

Parameters

Returns

Defined in

setProcessing

Parameters

Returns

Defined in

shouldRetryTransaction_

10 KiB

Raw Blame History