Function scheduler

Decorator that marks a function as a scheduler. The function will be called according to the provided cron expression.

To read more about schedulers, see the documentation.

scheduler(
    id: string,
    cronExpression:
        | `${string} ${string} ${string} ${string} ${string}`
        | `${string} ${string} ${string} ${string}`,
    exclusive?: boolean,
): ActionMethodDecorator<SchedulerAction>
Decorator that marks a function as a scheduler. The function will be called according to the provided cron expression.

To read more about schedulers, see the documentation.
Parameters
- id: string
  The ID of the scheduler. Should be unique.
- cronExpression:
  | `${string} ${string} ${string} ${string} ${string}`
  | `${string} ${string} ${string} ${string}`
  The cron expression (in UTC) to schedule the function on.
- Optionalexclusive: 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.
Returns ActionMethodDecorator<SchedulerAction>
scheduler(options: SchedulerOptions): ActionMethodDecorator<SchedulerAction>
Decorator that marks a function as a scheduler. The function will be called according to the provided cron expression.

To read more about schedulers, see the documentation.
Parameters
- options: SchedulerOptions
Returns ActionMethodDecorator<SchedulerAction>