Interface: IScheduler

Defined in: packages/scheduler/src/interfaces/scheduler.interface.ts:116

The scheduler interface defining scheduling operations

Methods

cancelAllTasks()

cancelAllTasks(): void;

Defined in: packages/scheduler/src/interfaces/scheduler.interface.ts:156

Cancel all scheduled tasks

Returns

void

---

getTasks()

getTasks(): TaskHandle[];

Defined in: packages/scheduler/src/interfaces/scheduler.interface.ts:161

Get all active tasks

Returns

TaskHandle[]

---

scheduleAt()

scheduleAt(
   date, 
   callback, 
   options?
): TaskHandle;

Defined in: packages/scheduler/src/interfaces/scheduler.interface.ts:147

Schedule a task to run at a specific date

Parameters

Parameter	Type
date	Date
callback	TaskCallback
options?	TimeoutTaskOptions

Returns

TaskHandle

---

scheduleCron()

scheduleCron(
   cronExpression, 
   callback, 
   options?
): TaskHandle;

Defined in: packages/scheduler/src/interfaces/scheduler.interface.ts:120

Schedule a task to run at a cron time

Parameters

Parameter	Type
cronExpression	string | CronExpression
callback	TaskCallback
options?	CronTaskOptions

Returns

TaskHandle

---

scheduleInterval()

scheduleInterval(
   intervalMs, 
   callback, 
   options?
): TaskHandle;

Defined in: packages/scheduler/src/interfaces/scheduler.interface.ts:129

Schedule a task to run at fixed intervals

Parameters

Parameter	Type
intervalMs	number
callback	TaskCallback
options?	IntervalTaskOptions

Returns

TaskHandle

---

scheduleTimeout()

scheduleTimeout(
   delayMs, 
   callback, 
   options?
): TaskHandle;

Defined in: packages/scheduler/src/interfaces/scheduler.interface.ts:138

Schedule a task to run once after a delay

Parameters

Parameter	Type
delayMs	number
callback	TaskCallback
options?	TimeoutTaskOptions

Returns

TaskHandle