@sapphire/plugin-scheduled-tasks
Namespaces
Namespace | Description |
---|---|
ScheduledTask | The namespace for ScheduledTask. |
Classes
Class | Description |
---|---|
ScheduledTask | Represents a scheduled task that can be run at a specified interval or pattern. |
ScheduledTaskHandler | - |
ScheduledTaskStore | A store for managing scheduled tasks. |
Interfaces
Interface | Description |
---|---|
ScheduledTaskCreateRepeatedTask | Represents a scheduled task that will be repeated at a specified interval. |
ScheduledTaskHandlerOptions | Options for a scheduled task handler. |
ScheduledTaskListOptions | Options for listing scheduled tasks. |
ScheduledTaskListRepeatedOptions | Options for listing repeated scheduled tasks. |
ScheduledTaskOptions | Options for configuring a scheduled task. |
ScheduledTasks | The registered tasks and their payload types. When registering new ones, it is recommended to use module augmentation so custom ones are registered. |
ScheduledTasksResolvableNoPayload | An entry in ScheduledTasks that has no payload. |
ScheduledTasksResolvablePayload | An entry in ScheduledTasks with it's associated payload. |
Type Aliases
Type alias | Description |
---|---|
BullClient | A Bull queue client that can be used to schedule and manage scheduled tasks. |
ScheduledTaskCustomJobOptions | Custom options for a job in a scheduled task. |
ScheduledTaskListRepeatedReturnType | The return type of the getRepeatableJobs method of a Bull client. If the return type of getRepeatableJobs is a Promise, this type extracts the resolved type. |
ScheduledTasksJob | - |
ScheduledTasksKeys | The keys of ScheduledTasks. |
ScheduledTasksKeysNoPayload | The keys of ScheduledTasks with an optional or no payload. |
ScheduledTasksPayload | The payload type of a ScheduledTasks entry. |
ScheduledTasksResolvable | - |
ScheduledTasksTaskOptions | Options for a scheduled task. |
Variables
Variable | Description |
---|---|
ScheduledTaskEvents | Events emitted during the process setting up the scheduler and running a task. You can use these events to trace the progress for debugging purposes. |
version | The @sapphire/plugin-scheduled-tasks version that you are currently using. An example use of this is showing it of in a bot information command. |
Functions
Function | Description |
---|---|
loadListeners | - |