Skip to content

packages/scheduler/src

Classes

ClassDescription
CronExpressionsCron expression presets
FixedCronExpressionFixed cron expression
ScheduleModuleModule for scheduling tasks (cron, interval, timeout)
SchedulerService for scheduling tasks
SchedulerRegistryRegistry for managing multiple schedulers

Functions

FunctionDescription
CronDecorator for cron jobs
getSchedulerGet the global scheduler instance
IntervalDecorator for interval jobs
isValidCronExpressionValidates 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
registerScheduledJobsScans instance for methods decorated with Cron, Interval, Timeout, or ScheduleAt and registers them with the global Scheduler.
ScheduleAtDecorator for scheduled jobs at a specific date
TimeoutDecorator for timeout jobs

Interfaces

InterfaceDescription
CronExpressionRepresents a cron expression for scheduled tasks
CronTaskOptionsOptions for cron tasks
IntervalTaskOptionsOptions for interval tasks
ISchedulerThe scheduler interface defining scheduling operations
ScheduledJobMetadataScheduled job metadata
ScheduledTaskBase interface for a scheduled task
ScheduleModuleOptionsModule configuration options
SchedulerConfigConfiguration options for Scheduler
SchedulerTaskOptionsTask options for scheduled tasks
TaskHandleTask handle for controlling scheduled tasks
TimeoutTaskOptionsOptions for timeout tasks

Type Aliases

Type AliasDescription
TaskCallbackType for task callback function

Enumerations

EnumerationDescription
ScheduledJobTypeScheduled job types

Variables

VariableDescription
SCHEDULED_JOBS_METADATA-

Released under the MIT License.