Class CronJobAbstract

constructor

• new CronJob(overrideName?: string): CronJob

  Parameters

  • OptionaloverrideName: string

  Returns CronJob

Abstract ReadonlyinitialConfig

active

• get active(): boolean

  Whether or not the cron job is currently active.

  Returns boolean

name

• get name(): string

  The name of the cron job.

  Returns string

changeCron

• changeCron(cronExpression: string): Promise<void>

  Changes the cron expression.

  Parameters

  • cronExpression: string

    The new cron expression to change to.

  Returns Promise<void>

disable

• disable(): Promise<void>

  Disables the cron job.

  Returns Promise<void>

enable

• enable(): Promise<void>

  Enables the cron job.

  Returns Promise<void>

init

• init(): Promise<void>

  Initializes the cron job.

  Returns Promise<void>

AbstractonTick

• onTick(): void | Promise<void>

  The method that is called on every cron execution.

  Returns void | Promise<void>

runOnError

• runOnError(error: unknown): Promise<void>

  Runs whenever the execution of the cron job throws an error. This is a wrapper around this.onError that already provides things like disabling the cron job if it's configured that way and logging the error.

  Parameters

  • error: unknown

    The error that was thrown.

  Returns Promise<void>

runOnTick

• runOnTick(): Promise<void>

  Runs whenever the cron expression fires. This is a wrapper around this.onTick that takes care of validation, error handling and updating cron job data.

  Returns Promise<void>

update

• update(data: Partial): Promise<void>

  Updates the cron jobs.

  Parameters

  • data: Partial

    The data to update the cron job with.

  Returns Promise<void>