Skip to main content

Interface: ScheduledTaskOptions

Options for configuring a scheduled task.

Extends​

  • Options

Properties​

customJobOptions?​

optional customJobOptions: ScheduledTaskCustomJobOptions

Custom options to pass to the job scheduler.

Defined in​

lib/structures/ScheduledTask.ts:45


interval?​

optional interval: null | number

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

Defined in​

lib/structures/ScheduledTask.ts:37


pattern?​

optional pattern: null | string

A cron pattern specifying when the task should run.

Defined in​

lib/structures/ScheduledTask.ts:41


timezone?​

optional timezone: null | string

The timezone to use for the task.

Default​

'UTC'

Defined in​

lib/structures/ScheduledTask.ts:51