Skip to main content

Class: StagedJobService

Provides layer to manipulate users.

Hierarchy​

  • TransactionBaseService

    ↳ StagedJobService

Constructors​

constructor​

• new StagedJobService(__namedParameters)

Parameters​

NameType
__namedParametersStagedJobServiceProps

Overrides​

TransactionBaseService.constructor

Defined in​

medusa/src/services/staged-job.ts:22

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


manager_​

• Protected manager_: EntityManager

Inherited from​

TransactionBaseService.manager_

Defined in​

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


stagedJobRepository_​

• Protected stagedJobRepository_: Repository<StagedJob> & { insertBulk: (jobToCreates: _QueryDeepPartialEntity<StagedJob>[]) => Promise<StagedJob[]> }

Defined in​

medusa/src/services/staged-job.ts:20


transactionManager_​

• Protected transactionManager_: undefined | EntityManager

Inherited from​

TransactionBaseService.transactionManager_

Defined in​

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

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​

NameTypeDescription
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


create​

▸ create(data): Promise<StagedJob[]>

Parameters​

NameType
dataEmitData<unknown> | EmitData<unknown>[]

Returns​

Promise<StagedJob[]>

Defined in​

medusa/src/services/staged-job.ts:45


delete​

▸ delete(stagedJobIds): Promise<void>

Parameters​

NameType
stagedJobIdsstring | string[]

Returns​

Promise<void>

Defined in​

medusa/src/services/staged-job.ts:37


list​

▸ list(config): Promise<StagedJob[]>

Parameters​

NameType
configFindConfig<StagedJob>

Returns​

Promise<StagedJob[]>

Defined in​

medusa/src/services/staged-job.ts:29


shouldRetryTransaction_​

▸ Protected shouldRetryTransaction_(err): boolean

Parameters​

NameType
errRecord<string, unknown> | { code: string }

Returns​

boolean

Inherited from​

TransactionBaseService.shouldRetryTransaction_

Defined in​

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


withTransaction​

▸ withTransaction(transactionManager?): StagedJobService

Parameters​

NameType
transactionManager?EntityManager

Returns​

StagedJobService

Inherited from​

TransactionBaseService.withTransaction

Defined in​

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

Was this section helpful?