Class: ScheduledTaskHandler
@sapphire/plugin-scheduled-tasks.ScheduledTaskHandler
Constructors
constructor
• new ScheduledTaskHandler(options): ScheduledTaskHandler
Parameters
| Name | Type |
|---|---|
options | ScheduledTaskHandlerOptions |
Returns
Defined in
projects/plugins/packages/scheduled-tasks/src/lib/ScheduledTaskHandler.ts:37
Properties
#client
• Private #client: BullClient
Defined in
projects/plugins/packages/scheduled-tasks/src/lib/ScheduledTaskHandler.ts:34
#worker
• Private #worker: Worker<any, any, string>
Defined in
projects/plugins/packages/scheduled-tasks/src/lib/ScheduledTaskHandler.ts:35
options
• Readonly options: QueueOptions
The queue options for the scheduled task handler.
Defined in
projects/plugins/packages/scheduled-tasks/src/lib/ScheduledTaskHandler.ts:27
queue
• Readonly queue: string
The name of the queue associated with the scheduled task handler.
Defined in
projects/plugins/packages/scheduled-tasks/src/lib/ScheduledTaskHandler.ts:32
Accessors
client
• get client(): BullClient
Returns
Defined in
projects/plugins/packages/scheduled-tasks/src/lib/ScheduledTaskHandler.ts:64
store
• get store(): ScheduledTaskStore
Returns
Defined in
projects/plugins/packages/scheduled-tasks/src/lib/ScheduledTaskHandler.ts:235
Methods
close
▸ close(): Promise<void>
Closes the internal client and worker.
Returns
Promise<void>
Defined in
projects/plugins/packages/scheduled-tasks/src/lib/ScheduledTaskHandler.ts:71
create
▸ create<T>(task, options?): Promise<ScheduledTasksJob<T>>
Creates a scheduled task.
Type parameters
| Name | Type |
|---|---|
T | extends ScheduledTasksResolvable |
Parameters
| Name | Type | Description |
|---|---|---|
task | T | The task to be scheduled. |
options? | number | ScheduledTasksTaskOptions | The options for the task. |
Returns
Defined in
projects/plugins/packages/scheduled-tasks/src/lib/ScheduledTaskHandler.ts:85
createRepeated
▸ createRepeated(tasks?): Promise<void>
Creates repeated tasks.
Parameters
| Name | 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>
Defined in
projects/plugins/packages/scheduled-tasks/src/lib/ScheduledTaskHandler.ts:125
delete
▸ delete(id): Promise<void>
Deletes a scheduled task by its ID.
Parameters
| Name | Type | Description |
|---|---|---|
id | string | The ID of the task to delete. |
Returns
Promise<void>
Defined in
projects/plugins/packages/scheduled-tasks/src/lib/ScheduledTaskHandler.ts:157
get
▸ get<T>(id): Promise<undefined | Job<undefined, any, string>>
Retrieves a scheduled task by its ID.
Type parameters
| Name | Type |
|---|---|
T | extends never |
Parameters
| Name | Type | Description |
|---|---|---|
id | T | The ID of the scheduled task to retrieve. |
Returns
Promise<undefined | Job<undefined, any, string>>
Defined in
projects/plugins/packages/scheduled-tasks/src/lib/ScheduledTaskHandler.ts:189
list
▸ list(options): Promise<Job<unknown, any, string>[]>
Retrieves a list of scheduled tasks based on the provided options.
Parameters
| Name | Type | Description |
|---|---|---|
options | ScheduledTaskListOptions | The options for filtering the list of scheduled tasks. |
Returns
Promise<Job<unknown, any, string>[]>
Defined in
projects/plugins/packages/scheduled-tasks/src/lib/ScheduledTaskHandler.ts:167
listRepeated
▸ listRepeated(options): Promise<RepeatableJob[]>
Retrieves a list of repeated scheduled tasks based on the provided options.
Parameters
| Name | Type | Description |
|---|---|---|
options | ScheduledTaskListRepeatedOptions | The options for filtering the list of repeated scheduled tasks. |
Returns
Promise<RepeatableJob[]>
Defined in
projects/plugins/packages/scheduled-tasks/src/lib/ScheduledTaskHandler.ts:178
resolveTask
▸ resolveTask(task): ScheduledTasksResolvablePayload<never>
Parameters
| Name | Type |
|---|---|
task | ScheduledTasksResolvable |
Returns
ScheduledTasksResolvablePayload<never>
Defined in
projects/plugins/packages/scheduled-tasks/src/lib/ScheduledTaskHandler.ts:239
run
▸ run(task): Promise<undefined | null | number>
Runs a scheduled task with the given name and payload.
Parameters
| Name | 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.
Defined in
projects/plugins/packages/scheduled-tasks/src/lib/ScheduledTaskHandler.ts:204