packages/scheduler/src
Classes
| Class | Description |
|---|---|
| CronExpressions | Cron expression presets |
| FixedCronExpression | Fixed cron expression |
| ScheduleModule | Module for scheduling tasks (cron, interval, timeout) |
| Scheduler | Service for scheduling tasks |
| SchedulerRegistry | Registry for managing multiple schedulers |
Functions
| Function | Description |
|---|---|
| Cron | Decorator for cron jobs |
| getScheduler | Get the global scheduler instance |
| Interval | Decorator for interval jobs |
| isValidCronExpression | Validates if a string is a valid cron expression Supports 5-segment (minute hour day month day-of-week) and 6-segment (second minute hour day month day-of-week) formats |
| registerScheduledJobs | Scans instance for methods decorated with Cron, Interval, Timeout, or ScheduleAt and registers them with the global Scheduler. |
| ScheduleAt | Decorator for scheduled jobs at a specific date |
| Timeout | Decorator for timeout jobs |
Interfaces
| Interface | Description |
|---|---|
| CronExpression | Represents a cron expression for scheduled tasks |
| CronTaskOptions | Options for cron tasks |
| IntervalTaskOptions | Options for interval tasks |
| IScheduler | The scheduler interface defining scheduling operations |
| ScheduledJobMetadata | Scheduled job metadata |
| ScheduledTask | Base interface for a scheduled task |
| ScheduleModuleOptions | Module configuration options |
| SchedulerConfig | Configuration options for Scheduler |
| SchedulerTaskOptions | Task options for scheduled tasks |
| TaskHandle | Task handle for controlling scheduled tasks |
| TimeoutTaskOptions | Options for timeout tasks |
Type Aliases
| Type Alias | Description |
|---|---|
| TaskCallback | Type for task callback function |
Enumerations
| Enumeration | Description |
|---|---|
| ScheduledJobType | Scheduled job types |
Variables
| Variable | Description |
|---|---|
| SCHEDULED_JOBS_METADATA | - |