Module: @sapphire/plugin-scheduled-tasks
Namespaces
Classes
Interfaces
- ScheduledTaskCreateRepeatedTask
- ScheduledTaskHandlerOptions
- ScheduledTaskListOptions
- ScheduledTaskListRepeatedOptions
- ScheduledTaskOptions
- ScheduledTasks
- ScheduledTasksResolvablePayload
Type Aliases
BullClient
Ƭ BullClient: Queue<unknown>
A Bull queue client that can be used to schedule and manage scheduled tasks.
Defined in
projects/plugins/packages/scheduled-tasks/src/lib/types/ScheduledTaskTypes.ts:31
ScheduledTaskCustomJobOptions
Ƭ ScheduledTaskCustomJobOptions: Omit<JobsOptions, "repeat">
Custom options for a job in a scheduled task.
Defined in
projects/plugins/packages/scheduled-tasks/src/lib/structures/ScheduledTask.ts:57
ScheduledTaskListRepeatedReturnType
Ƭ ScheduledTaskListRepeatedReturnType: ReturnType<BullClient["getRepeatableJobs"]> extends Promise<infer U> ? U : never
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.
Defined in
projects/plugins/packages/scheduled-tasks/src/lib/types/ScheduledTaskTypes.ts:37
ScheduledTasksJob
Ƭ ScheduledTasksJob<T>: T extends ScheduledTasksResolvableNoPayload<infer R> ? Job<ScheduledTasksPayload<R>> : T extends ScheduledTasksResolvablePayload<infer R> ? Job<ScheduledTasksPayload<R>> : Job<undefined>
Type parameters
| Name |
|---|
T |
Defined in
projects/plugins/packages/scheduled-tasks/src/lib/types/ScheduledTaskTypes.ts:140
ScheduledTasksKeys
Ƭ ScheduledTasksKeys: keyof ScheduledTasks
The keys of ScheduledTasks.
Defined in
projects/plugins/packages/scheduled-tasks/src/lib/types/ScheduledTaskTypes.ts:92
ScheduledTasksKeysNoPayload
Ƭ ScheduledTasksKeysNoPayload: { [K in ScheduledTasksKeys]: ScheduledTasks[K] extends never ? K : undefined extends ScheduledTasks[K] ? K : never }[ScheduledTasksKeys]
The keys of ScheduledTasks with an optional or no payload.
Defined in
projects/plugins/packages/scheduled-tasks/src/lib/types/ScheduledTaskTypes.ts:97
ScheduledTasksPayload
Ƭ ScheduledTasksPayload<K>: ScheduledTasksKeys extends never ? undefined : ScheduledTasks[K] extends never ? undefined : ScheduledTasks[K]
The payload type of a ScheduledTasks entry.
Type parameters
| Name | Type |
|---|---|
K | extends ScheduledTasksKeys = ScheduledTasksKeys |
Defined in
projects/plugins/packages/scheduled-tasks/src/lib/types/ScheduledTaskTypes.ts:108
ScheduledTasksResolvable
Ƭ ScheduledTasksResolvable: ScheduledTasksKeysNoPayload | ScheduledTasksResolvableNoPayload | ScheduledTasksResolvablePayload
Defined in
projects/plugins/packages/scheduled-tasks/src/lib/types/ScheduledTaskTypes.ts:135
ScheduledTasksTaskOptions
Ƭ ScheduledTasksTaskOptions: { repeated: boolean } & { customJobOptions?: ScheduledTaskCustomJobOptions ; delay: number ; interval?: never ; pattern?: never ; timezone?: never } | { customJobOptions?: ScheduledTaskCustomJobOptions ; delay?: never ; interval: number ; pattern?: never ; timezone?: never } | { customJobOptions?: ScheduledTaskCustomJobOptions ; delay?: never ; interval?: never ; pattern: string ; timezone: string }
Options for a scheduled task.
Defined in
projects/plugins/packages/scheduled-tasks/src/lib/types/ScheduledTaskTypes.ts:42
Variables
ScheduledTaskEvents
• Const ScheduledTaskEvents: Object
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.
Type declaration
| Name | Type | Description |
|---|---|---|
ScheduledTaskError | "scheduledTaskError" | Event that is emitted when a task's "run" method throws an error |
ScheduledTaskFinished | "scheduledTaskFinished" | Event that is emitted when a task's "run" method finishes, regardless of whether an error occurred or not |
ScheduledTaskNotFound | "scheduledTaskNotFound" | Event that is emitted if a task piece is not found in the store |
ScheduledTaskRun | "scheduledTaskRun" | Event that is emitted before a task's "run" method is called |
ScheduledTaskStrategyClientError | "scheduledTaskStrategyClientError" | Event that is emitted when the scheduled task client encounters an error. |
ScheduledTaskStrategyConnectError | "scheduledTaskStrategyConnectError" | Event that is emitted when the scheduler fails to connect to the server (i.e. redis) |
ScheduledTaskStrategyWorkerError | "scheduledTaskStrategyWorkerError" | Event that is emitted when the scheduled task worker encounters an error. |
ScheduledTaskSuccess | "scheduledTaskSuccess" | Event that is emitted when a tasks's "run" method is successful |
Defined in
projects/plugins/packages/scheduled-tasks/src/lib/types/ScheduledTaskEvents.ts:7
version
• Const version: string = '[VI]{{inject}}[/VI]'
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.
Note to Sapphire developers: This needs to explicitly be string so it is not typed as the string that gets replaced by esbuild
Defined in
projects/plugins/packages/scheduled-tasks/src/index.ts:41
Functions
loadListeners
▸ loadListeners(): void
Returns
void
Defined in
projects/plugins/packages/scheduled-tasks/src/listeners/_load.ts:8