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:23
Properties
#internalClient
• Private
#internalClient: null
| BullClient
= null
Defined in
projects/plugins/packages/scheduled-tasks/src/lib/ScheduledTaskHandler.ts:21
options
• Readonly
options: QueueOptions
Defined in
projects/plugins/packages/scheduled-tasks/src/lib/ScheduledTaskHandler.ts:19
queue
• Readonly
queue: string
Defined in
projects/plugins/packages/scheduled-tasks/src/lib/ScheduledTaskHandler.ts:20
Accessors
client
• get
client(): BullClient
Returns
Defined in
projects/plugins/packages/scheduled-tasks/src/lib/ScheduledTaskHandler.ts:35
store
• get
store(): ScheduledTaskStore
Returns
Defined in
projects/plugins/packages/scheduled-tasks/src/lib/ScheduledTaskHandler.ts:164
Methods
create
▸ create<T
>(task
, payload?
, options?
): undefined
| Promise
<Job
<T
, any
, string
>>
Type parameters
Name | Type |
---|---|
T | unknown |
Parameters
Name | Type |
---|---|
task | never |
payload? | null | ScheduledTaskJob |
options? | number | ScheduledTasksTaskOptions |
Returns
undefined
| Promise
<Job
<T
, any
, string
>>
Defined in
projects/plugins/packages/scheduled-tasks/src/lib/ScheduledTaskHandler.ts:39
createRepeated
▸ createRepeated(tasks?
): Promise
<void
>
Parameters
Name | Type |
---|---|
tasks? | ScheduledTaskCreateRepeatedTask [] |
Returns
Promise
<void
>
Defined in
projects/plugins/packages/scheduled-tasks/src/lib/ScheduledTaskHandler.ts:76
delete
▸ delete(id
): Promise
<void
>
Parameters
Name | Type |
---|---|
id | string |
Returns
Promise
<void
>
Defined in
projects/plugins/packages/scheduled-tasks/src/lib/ScheduledTaskHandler.ts:100
get
▸ get<T
>(id
): undefined
| Promise
<null
| Job
<T
, any
, string
>>
Type parameters
Name | Type |
---|---|
T | unknown |
Parameters
Name | Type |
---|---|
id | string |
Returns
undefined
| Promise
<null
| Job
<T
, any
, string
>>
Defined in
projects/plugins/packages/scheduled-tasks/src/lib/ScheduledTaskHandler.ts:127
list
▸ list<T
>(options
): undefined
| Promise
<Job
<T
, any
, string
>[]>
Type parameters
Name | Type |
---|---|
T | unknown |
Parameters
Name | Type |
---|---|
options | ScheduledTaskListOptions |
Returns
undefined
| Promise
<Job
<T
, any
, string
>[]>
Defined in
projects/plugins/packages/scheduled-tasks/src/lib/ScheduledTaskHandler.ts:109
listRepeated
▸ listRepeated(options
): undefined
| Promise
<{ endDate
: number
; id
: string
; key
: string
; name
: string
; next
: number
; pattern
: string
; tz
: string
}[]>
Parameters
Name | Type |
---|---|
options | ScheduledTaskListRepeatedOptions |
Returns
undefined
| Promise
<{ endDate
: number
; id
: string
; key
: string
; name
: string
; next
: number
; pattern
: string
; tz
: string
}[]>
Defined in
projects/plugins/packages/scheduled-tasks/src/lib/ScheduledTaskHandler.ts:118
run
▸ run(task
, payload
): Promise
<unknown
>
Parameters
Name | Type |
---|---|
task | string |
payload | unknown |
Returns
Promise
<unknown
>
Defined in
projects/plugins/packages/scheduled-tasks/src/lib/ScheduledTaskHandler.ts:135