Skip to main content

IQScheduleExecutor

@quik/scheduler


@quik/scheduler / IQScheduleExecutor

Interface: IQScheduleExecutor

Defined in: scheduler/src/QExecutor.ts:16

Contract implemented by task scheduler executors.

Properties​

tasks​

readonly tasks: QTask[]

Defined in: scheduler/src/QExecutor.ts:21

Array of registered tasks managed by this executor. Contains all scheduled tasks regardless of their state.

Methods​

cleanup()​

cleanup(): void

Defined in: scheduler/src/QExecutor.ts:40

Cleanup the executors.

Returns​

void


register()​

register(...tasks): void

Defined in: scheduler/src/QExecutor.ts:35

Register one or more tasks to be executed.

Parameters​

tasks​

...Constructor<QTask>[]

Task constructors to register.

Returns​

void


start()​

start(): Promise<void>

Defined in: scheduler/src/QExecutor.ts:43

Start the scheduler.

Returns​

Promise<void>


stop()​

stop(): Promise<void>

Defined in: scheduler/src/QExecutor.ts:46

Stop all scheduled tasks.

Returns​

Promise<void>


transfer()​

transfer(originalExecutor): void

Defined in: scheduler/src/QExecutor.ts:28

Transfer state from another executor instance.

Parameters​

originalExecutor​

QExecutor

Executor to copy tasks from.

Returns​

void