Class RunningCrons<Context, Name>

constructor

• new RunningCrons<Context, Name extends string>(
      context: Context,
      crons: readonly Readonly<CronDefinition<Context, Name>>[],
      options?: Readonly<RunningCronsOptions>,
  ): RunningCrons<Context, Name>

  Type Parameters

  • Context
  • Name extends string

  Parameters

  • context: Context
  • crons: readonly Readonly<CronDefinition<Context, Name>>[]
  • options: Readonly<RunningCronsOptions> = {}

  Returns RunningCrons<Context, Name>

Readonlycontext

Readonlycrons

ReadonlycronStatuses

Readonlyoptions

destroy

• destroy(): void

  Clean up resources and stop all crons.

  Returns void

pauseAll

• pauseAll(): void

  Pause all cron jobs. This does not affect any currently running crons. It merely prevents the next scheduled executions from running.

  Returns void

pauseCron

• pauseCron(name: Name): boolean

  Pause a specific cron job. This does not affect any currently running jobs for the cron. It merely prevents the next scheduled execution from running.

  Parameters

  • name: Name

  Returns boolean

  false if no cron by the given name was found or if the cron was already paused.

resumeAll

• resumeAll(): void

  Resume all paused cron jobs.

  Returns void

resumeCron

• resumeCron(name: Name): boolean

  Resume a specific cron job.

  Parameters

  • name: Name

  Returns boolean

  false if no cron by the given name was found or if the cron was already resumed.