IScheduler.every - common/src/index.ts

method IScheduler.every



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

Schedule a recurring job that fires every intervalMs milliseconds.

Type Parameters



T = unknown



name: string

Unique job name



intervalMs: number

Interval in milliseconds



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