Skip to main content

Class: SerialBatch

@ima/core.SerialBatch

Basic implementation of the Execution interface. Provides the basic functionality for appending and validating jobs.

Hierarchy

Constructors

constructor

new SerialBatch(jobs?)

Parameters

NameTypeDefault value
jobsExecutionJob[][]

Inherited from

AbstractExecution.constructor

Defined in

packages/core/src/execution/AbstractExecution.ts:13

Properties

_jobs

Protected _jobs: ExecutionJob[]

Inherited from

AbstractExecution._jobs

Defined in

packages/core/src/execution/AbstractExecution.ts:11

Methods

_executeJob

_executeJob(stage, args): Promise<unknown>

Parameters

NameType
stageExecutionJob
argsunknown[]

Returns

Promise<unknown>

Defined in

packages/core/src/execution/SerialBatch.ts:22


_validateJob

_validateJob(job): boolean

Return true if the given job can be executed

Parameters

NameType
jobExecutionJob

Returns

boolean

Inherited from

AbstractExecution._validateJob

Defined in

packages/core/src/execution/AbstractExecution.ts:44


append

append(jobs): void

Adds a new job to be executed. The job is appended at the end of the list of current jobs therefore is executed last.

Parameters

NameTypeDescription
jobsExecutionJob | ExecutionJob[]The jobs to be executed.

Returns

void

Inherited from

AbstractExecution.append

Defined in

packages/core/src/execution/AbstractExecution.ts:22


execute

execute(...args): Promise<unknown>

Start executing collected jobs. In the end a Promise is returned with a resulting value. On the returned Promise a catch method can be called to prevent any unwanted interruption.

Parameters

NameTypeDescription
...argsunknown[]Arguments to be passed when executing jobs

Returns

Promise<unknown>

Overrides

AbstractExecution.execute

Defined in

packages/core/src/execution/SerialBatch.ts:8