IScheduler.delay - common/src/index.ts

method IScheduler.delay



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

Schedule a one-shot delayed job.

The job fires once after delayMs and is then auto-removed.

Type Parameters



T = unknown



name: string

Unique job name



delayMs: number

Delay in milliseconds



handler: SchedulerJobHandler<T>

Callback to invoke when the delay expires

optional



options: ScheduleOptions<T>

Optional payload and retry config

Promise<void>

Error

If a job with name is already scheduled