IScheduler.cron - common/src/index.ts

method IScheduler.cron



IScheduler.cron<T = unknown>(name: string,
expression: string,
handler: SchedulerJobHandler<T>,
options?: ScheduleOptions<T>
): Promise<void>

Schedule a recurring job using a 5-field cron expression (UTC).

Type Parameters



T = unknown



name: string

Unique job name



expression: string

5-field cron expression



handler: SchedulerJobHandler<T>

Callback to invoke on each fire

optional



options: ScheduleOptions<T>

Optional payload and retry config

Promise<void>

Error

If a job with name is already scheduled