Class CronScheduler

Privateconstructor

• new CronScheduler(): CronScheduler

  Returns CronScheduler

Private Static Readonlycalculator

Private Static Optionalinstance

Private Static Readonlyparser

schedule

• schedule(
      expr: CronInput,
      callback: () => void,
      options?: ScheduleOptions,
  ): ScheduleController

  Schedule a callback to run on the given cron schedule.

  Parameters

  • expr: CronInput

    A standard 5-field cron string, parsed cron object or special alias. The special '@reboot' alias fires the callback immediately once.

  • callback: () => void

    Function to invoke on each scheduled occurrence.

  • Optionaloptions: ScheduleOptions

    Optional ScheduleOptions with timezone.

  Returns ScheduleController

  A ScheduleController with stop(), on(), and off() methods.

  Example

  const job = scheduler.schedule( '0 * * * *', () => console.log( 'tick' ), { timezone: 'UTC' } );
  job.on( 'tick', () => console.log( 'about to fire' ) );
  job.stop();
  Copy

StaticgetInstance

• getInstance(): CronScheduler

  Get the CronScheduler instance.

  Returns CronScheduler