Skip to main content

Interface: SchedulerOptions

Options for the @scheduler annotation.

Properties

cron

cron: `${string} ${string} ${string} ${string} ${string}` | `${string} ${string} ${string} ${string}`

The cron expression (in UTC) to schedule the function on.


exclusive

Optional exclusive: boolean

Whether the scheduler should be exclusive. If set to true, the scheduler will not trigger if the previous scheduler is still running. Default: true.


id

Optional id: string

The ID of the scheduler. Must be unique. If not provided the ID of the scheduler is constructed as 'ClassName:FunctionName'.