Class: Scheduler

Defined in: packages/scheduler/src/services/scheduler.service.ts:27

Service for scheduling tasks

Implements

• IScheduler
• OnModuleDestroy

Constructors

Constructor

new Scheduler(config?): Scheduler;

Defined in: packages/scheduler/src/services/scheduler.service.ts:46

Create a new scheduler

Parameters

Parameter	Type
config	SchedulerConfig

Returns

Scheduler

Methods

cancelAllTasks()

cancelAllTasks(): void;

Defined in: packages/scheduler/src/services/scheduler.service.ts:186

Cancel all scheduled tasks

Returns

void

Implementation of

IScheduler.cancelAllTasks

---

getTasks()

getTasks(): TaskHandle[];

Defined in: packages/scheduler/src/services/scheduler.service.ts:197

Get all active tasks

Returns

TaskHandle[]

Implementation of

IScheduler.getTasks

---

onModuleDestroy()

onModuleDestroy(): void;

Defined in: packages/scheduler/src/services/scheduler.service.ts:50

Returns

void

Implementation of

OnModuleDestroy.onModuleDestroy

---

scheduleAt()

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

Defined in: packages/scheduler/src/services/scheduler.service.ts:156

Schedule a task to run at a specific date

Parameters

Parameter	Type
date	Date
callback	TaskCallback
options	TimeoutTaskOptions

Returns

TaskHandle

Implementation of

IScheduler.scheduleAt

---

scheduleCron()

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

Defined in: packages/scheduler/src/services/scheduler.service.ts:82

Schedule a task to run at a cron time

Parameters

Parameter	Type
cronExpression	string | CronExpression
callback	TaskCallback
options	CronTaskOptions

Returns

TaskHandle

Implementation of

IScheduler.scheduleCron

---

scheduleInterval()

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

Defined in: packages/scheduler/src/services/scheduler.service.ts:107

Schedule a task to run at fixed intervals

Parameters

Parameter	Type
intervalMs	number
callback	TaskCallback
options	IntervalTaskOptions

Returns

TaskHandle

Implementation of

IScheduler.scheduleInterval

---

scheduleTimeout()

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

Defined in: packages/scheduler/src/services/scheduler.service.ts:129

Schedule a task to run once after a delay

Parameters

Parameter	Type
delayMs	number
callback	TaskCallback
options	TimeoutTaskOptions

Returns

TaskHandle

Implementation of

IScheduler.scheduleTimeout