Skip to main content

Interface: ScheduledTaskOptions

@sapphire/plugin-scheduled-tasks.ScheduledTaskOptions

Options for configuring a scheduled task.

Hierarchy​

  • Options

    ↳ ScheduledTaskOptions

Properties​

customJobOptions​

• Optional customJobOptions: ScheduledTaskCustomJobOptions

Custom options to pass to the job scheduler.

Defined in​

projects/plugins/packages/scheduled-tasks/src/lib/structures/ScheduledTask.ts:45

enabled​

• Optional Readonly enabled: boolean

Whether or not the piece should be enabled. If set to false, the piece will be unloaded.

Default

true

Inherited from​

Piece.Options.enabled

Defined in​

node_modules/@sapphire/pieces/dist/esm/index.d.mts:204

interval​

• Optional interval: null | number

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

Defined in​

projects/plugins/packages/scheduled-tasks/src/lib/structures/ScheduledTask.ts:37

name​

• Optional Readonly name: string

The name for the piece.

Default

''

Inherited from​

Piece.Options.name

Defined in​

node_modules/@sapphire/pieces/dist/esm/index.d.mts:199

pattern​

• Optional pattern: null | string

A cron pattern specifying when the task should run.

Defined in​

projects/plugins/packages/scheduled-tasks/src/lib/structures/ScheduledTask.ts:41

timezone​

• Optional timezone: null | string

The timezone to use for the task.

Default

'UTC'

Defined in​

projects/plugins/packages/scheduled-tasks/src/lib/structures/ScheduledTask.ts:51