Skip to main content

Class: ScheduledTaskHandler

@sapphire/plugin-scheduled-tasks.ScheduledTaskHandler

Constructors

constructor

new ScheduledTaskHandler(options?): ScheduledTaskHandler

Parameters

NameType
options?ScheduledTaskHandlerOptions

Returns

ScheduledTaskHandler

Defined in

projects/plugins/packages/scheduled-tasks/src/lib/ScheduledTaskHandler.ts:23

Properties

#internalClient

Private #internalClient: null | BullClient = null

Defined in

projects/plugins/packages/scheduled-tasks/src/lib/ScheduledTaskHandler.ts:21


options

Readonly options: QueueOptions

Defined in

projects/plugins/packages/scheduled-tasks/src/lib/ScheduledTaskHandler.ts:19


queue

Readonly queue: string

Defined in

projects/plugins/packages/scheduled-tasks/src/lib/ScheduledTaskHandler.ts:20

Accessors

client

get client(): BullClient

Returns

BullClient

Defined in

projects/plugins/packages/scheduled-tasks/src/lib/ScheduledTaskHandler.ts:35


store

get store(): ScheduledTaskStore

Returns

ScheduledTaskStore

Defined in

projects/plugins/packages/scheduled-tasks/src/lib/ScheduledTaskHandler.ts:164

Methods

create

create<T>(task, payload?, options?): undefined | Promise<Job<T, any, string>>

Type parameters

NameType
Tunknown

Parameters

NameType
tasknever
payload?null | ScheduledTaskJob
options?number | ScheduledTasksTaskOptions

Returns

undefined | Promise<Job<T, any, string>>

Defined in

projects/plugins/packages/scheduled-tasks/src/lib/ScheduledTaskHandler.ts:39


createRepeated

createRepeated(tasks?): Promise<void>

Parameters

NameType
tasks?ScheduledTaskCreateRepeatedTask[]

Returns

Promise<void>

Defined in

projects/plugins/packages/scheduled-tasks/src/lib/ScheduledTaskHandler.ts:76


delete

delete(id): Promise<void>

Parameters

NameType
idstring

Returns

Promise<void>

Defined in

projects/plugins/packages/scheduled-tasks/src/lib/ScheduledTaskHandler.ts:100


get

get<T>(id): undefined | Promise<null | Job<T, any, string>>

Type parameters

NameType
Tunknown

Parameters

NameType
idstring

Returns

undefined | Promise<null | Job<T, any, string>>

Defined in

projects/plugins/packages/scheduled-tasks/src/lib/ScheduledTaskHandler.ts:127


list

list<T>(options): undefined | Promise<Job<T, any, string>[]>

Type parameters

NameType
Tunknown

Parameters

NameType
optionsScheduledTaskListOptions

Returns

undefined | Promise<Job<T, any, string>[]>

Defined in

projects/plugins/packages/scheduled-tasks/src/lib/ScheduledTaskHandler.ts:109


listRepeated

listRepeated(options): undefined | Promise<{ endDate: number ; id: string ; key: string ; name: string ; next: number ; pattern: string ; tz: string }[]>

Parameters

NameType
optionsScheduledTaskListRepeatedOptions

Returns

undefined | Promise<{ endDate: number ; id: string ; key: string ; name: string ; next: number ; pattern: string ; tz: string }[]>

Defined in

projects/plugins/packages/scheduled-tasks/src/lib/ScheduledTaskHandler.ts:118


run

run(task, payload): Promise<unknown>

Parameters

NameType
taskstring
payloadunknown

Returns

Promise<unknown>

Defined in

projects/plugins/packages/scheduled-tasks/src/lib/ScheduledTaskHandler.ts:135