Skip to main content

Interface: ScheduledTaskOptions

Defined in: lib/structures/ScheduledTask.ts:33

Options for configuring a scheduled task.

Extends​

  • Options

Properties​

customJobOptions?​

optional customJobOptions: ScheduledTaskCustomJobOptions

Defined in: lib/structures/ScheduledTask.ts:45

Custom options to pass to the job scheduler.

interval?​

optional interval: null | number

Defined in: lib/structures/ScheduledTask.ts:37

The interval (in milliseconds) at which the task should run.

pattern?​

optional pattern: null | string

Defined in: lib/structures/ScheduledTask.ts:41

A cron pattern specifying when the task should run.

timezone?​

optional timezone: null | string

Defined in: lib/structures/ScheduledTask.ts:51

The timezone to use for the task.

Default​

'UTC'