Module: @sapphire/plugin-scheduled-tasks
Namespaces
Classes
Interfaces
- ScheduledTaskCreateRepeatedTask
- ScheduledTaskHandlerOptions
- ScheduledTaskJob
- ScheduledTaskListOptions
- ScheduledTaskListRepeatedOptions
- ScheduledTaskOptions
- ScheduledTasks
Type Aliases
BullClient
Ƭ BullClient: Queue
<ScheduledTaskJob
| null
>
Defined in
projects/plugins/packages/scheduled-tasks/src/lib/types/ScheduledTaskTypes.ts:18
ScheduledTaskListRepeatedReturnType
Ƭ ScheduledTaskListRepeatedReturnType: ReturnType
<BullClient
["getRepeatableJobs"
]> extends Promise
<infer U> ? U
: never
Defined in
projects/plugins/packages/scheduled-tasks/src/lib/types/ScheduledTaskTypes.ts:20
ScheduledTasksTaskOptions
Ƭ ScheduledTasksTaskOptions: { repeated
: boolean
} & { customJobOptions?
: any
; delay
: number
; interval?
: never
; pattern?
: never
} | { customJobOptions?
: any
; delay?
: never
; interval
: number
; pattern?
: never
} | { customJobOptions?
: any
; delay?
: never
; interval?
: never
; pattern
: string
}
Defined in
projects/plugins/packages/scheduled-tasks/src/lib/types/ScheduledTaskTypes.ts:22
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 |
ScheduledTaskStrategyConnectError | "scheduledTaskStrategyConnectError" | Event that is emitted when the scheduler fails to connect to the server (i.e. redis) |
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:5