Class: ScheduledTaskHandler

Defined in: lib/ScheduledTaskHandler.ts:23

Constructors

new ScheduledTaskHandler()

new ScheduledTaskHandler(options: ScheduledTaskHandlerOptions): ScheduledTaskHandler

Defined in: lib/ScheduledTaskHandler.ts:37

Parameters

Parameter	Type
options	ScheduledTaskHandlerOptions

Returns

ScheduledTaskHandler

Properties

#client

private #client: BullClient

Defined in: lib/ScheduledTaskHandler.ts:34

---

#worker

private #worker: Worker

Defined in: lib/ScheduledTaskHandler.ts:35

---

options

readonly options: QueueOptions

Defined in: lib/ScheduledTaskHandler.ts:27

The queue options for the scheduled task handler.

---

queue

readonly queue: string

Defined in: lib/ScheduledTaskHandler.ts:32

The name of the queue associated with the scheduled task handler.

Accessors

client

Get Signature

get client(): BullClient

Defined in: lib/ScheduledTaskHandler.ts:64

Returns

BullClient

---

store

Get Signature

get private store(): ScheduledTaskStore

Defined in: lib/ScheduledTaskHandler.ts:233

Returns

ScheduledTaskStore

Methods

close()

close(): Promise<void>

Defined in: lib/ScheduledTaskHandler.ts:71

Closes the internal client and worker.

Returns

Promise<void>

---

create()

create<T>(task: T, options?: number | ScheduledTasksTaskOptions): Promise<ScheduledTasksJob<T>>

Defined in: lib/ScheduledTaskHandler.ts:84

Creates a scheduled task.

Type Parameters

Type Parameter
T extends ScheduledTasksResolvable

Parameters

Parameter	Type	Description
task	T	The task to be scheduled.
options?	number | ScheduledTasksTaskOptions	The options for the task.

Returns

Promise<ScheduledTasksJob<T>>

---

createRepeated()

createRepeated(tasks?: ScheduledTaskCreateRepeatedTask[]): Promise<void>

Defined in: lib/ScheduledTaskHandler.ts:124

Creates repeated tasks.

Parameters

Parameter	Type	Description
tasks?	ScheduledTaskCreateRepeatedTask[]	An optional array of tasks to create. If not provided, it will create tasks based on the stored repeated tasks.

Returns

Promise<void>

---

delete()

delete(id: string): Promise<void>

Defined in: lib/ScheduledTaskHandler.ts:156

Deletes a scheduled task by its ID.

Parameters

Parameter	Type	Description
id	string	The ID of the task to delete.

Returns

Promise<void>

---

get()

get<T>(id: T): Promise<undefined | Job<undefined>>

Defined in: lib/ScheduledTaskHandler.ts:188

Retrieves a scheduled task by its ID.

Type Parameters

Type Parameter
T extends never

Parameters

Parameter	Type	Description
id	T	The ID of the scheduled task to retrieve.

Returns

Promise<undefined | Job<undefined>>

---

list()

list(options: ScheduledTaskListOptions): Promise<Job<unknown>[]>

Defined in: lib/ScheduledTaskHandler.ts:166

Retrieves a list of scheduled tasks based on the provided options.

Parameters

Parameter	Type	Description
options	ScheduledTaskListOptions	The options for filtering the list of scheduled tasks.

Returns

Promise<Job<unknown>[]>

---

listRepeated()

listRepeated(options: ScheduledTaskListRepeatedOptions): Promise<RepeatableJob[]>

Defined in: lib/ScheduledTaskHandler.ts:177

Retrieves a list of repeated scheduled tasks based on the provided options.

Parameters

Parameter	Type	Description
options	ScheduledTaskListRepeatedOptions	The options for filtering the list of repeated scheduled tasks.

Returns

Promise<RepeatableJob[]>

---

resolveTask()

private resolveTask(task: ScheduledTasksResolvable): ScheduledTasksResolvablePayload

Defined in: lib/ScheduledTaskHandler.ts:237

Parameters

Parameter	Type
task	ScheduledTasksResolvable

Returns

ScheduledTasksResolvablePayload

---

run()

run(task: ScheduledTasksResolvable): Promise<undefined | null | number>

Defined in: lib/ScheduledTaskHandler.ts:202

Runs a scheduled task with the given name and payload.

Parameters

Parameter	Type	Description
task	ScheduledTasksResolvable	The name of the scheduled task to run.

Returns

Promise<undefined | null | number>

Remarks

undefined will be returned if the task was not found.