Skip to main content

@sapphire/plugin-scheduled-tasks

Namespaces

NamespaceDescription
ScheduledTaskThe namespace for ScheduledTask.

Classes

ClassDescription
ScheduledTaskRepresents a scheduled task that can be run at a specified interval or pattern.
ScheduledTaskHandler-
ScheduledTaskStoreA store for managing scheduled tasks.

Interfaces

InterfaceDescription
ScheduledTaskCreateRepeatedTaskRepresents a scheduled task that will be repeated at a specified interval.
ScheduledTaskHandlerOptionsOptions for a scheduled task handler.
ScheduledTaskListOptionsOptions for listing scheduled tasks.
ScheduledTaskListRepeatedOptionsOptions for listing repeated scheduled tasks.
ScheduledTaskOptionsOptions for configuring a scheduled task.
ScheduledTasksThe registered tasks and their payload types. When registering new ones, it is recommended to use
ScheduledTasksResolvableNoPayloadAn entry in ScheduledTasks that has no payload.
ScheduledTasksResolvablePayloadAn entry in ScheduledTasks with it's associated payload.

Type Aliases

Type aliasDescription
BullClientA Bull queue client that can be used to schedule and manage scheduled tasks.
ScheduledTaskCustomJobOptionsCustom options for a job in a scheduled task.
ScheduledTaskListRepeatedReturnTypeThe return type of the getRepeatableJobs method of a Bull client.
ScheduledTasksJob-
ScheduledTasksKeysThe keys of ScheduledTasks.
ScheduledTasksKeysNoPayloadThe keys of ScheduledTasks with an optional or no payload.
ScheduledTasksPayloadThe payload type of a ScheduledTasks entry.
ScheduledTasksResolvable-
ScheduledTasksTaskOptionsOptions for a scheduled task.

Variables

VariableDescription
ScheduledTaskEventsEvents emitted during the process setting up the scheduler and running a task.
versionThe @sapphire/plugin-scheduled-tasks version that you are currently using.

Functions

FunctionDescription
loadListeners-