Class: ScheduledTask
scheduled-tasks/src.ScheduledTask
Hierarchy
Piece↳
ScheduledTask
Constructors
constructor
• new ScheduledTask(context, options)
Parameters
| Name | Type |
|---|---|
context | PieceContext |
options | ScheduledTaskOptions |
Overrides
Piece.constructor
Defined in
projects/plugins/packages/scheduled-tasks/src/lib/structures/ScheduledTask.ts:9
Properties
bullJobOptions
• Optional Readonly bullJobOptions: unknown
Defined in
projects/plugins/packages/scheduled-tasks/src/lib/structures/ScheduledTask.ts:7
cron
• Readonly cron: null | string
Defined in
projects/plugins/packages/scheduled-tasks/src/lib/structures/ScheduledTask.ts:6
enabled
• enabled: boolean
Whether or not the piece is enabled.
Inherited from
Piece.enabled
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:447
interval
• Readonly interval: null | number
Defined in
projects/plugins/packages/scheduled-tasks/src/lib/structures/ScheduledTask.ts:5
location
• Readonly location: PieceLocation
The location metadata for the piece's file.
Inherited from
Piece.location
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:439
name
• Readonly name: string
The name of the piece.
Inherited from
Piece.name
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:443
options
• Readonly options: PieceOptions
The raw options passed to this {@link Piece}
Inherited from
Piece.options
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:451
store
• Readonly store: Store<Piece<PieceOptions>>
The store that contains the piece.
Inherited from
Piece.store
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:435
Accessors
container
• get container(): Container
A reference to the {@link Container} object for ease of use.
see container
Returns
Container
Inherited from
Piece.container
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:457
Methods
onLoad
▸ onLoad(): unknown
Per-piece listener that is called when the piece is loaded into the store. Useful to set-up asynchronous initialization tasks.
Returns
unknown
Inherited from
Piece.onLoad
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:462
onUnload
▸ onUnload(): unknown
Per-piece listener that is called when the piece is unloaded from the store. Useful to set-up clean-up tasks.
Returns
unknown
Inherited from
Piece.onUnload
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:467
reload
▸ reload(): Promise<void>
Reloads the piece by loading the same path in the store.
Returns
Promise<void>
Inherited from
Piece.reload
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:475
run
▸ Abstract run(payload): unknown
Parameters
| Name | Type |
|---|---|
payload | unknown |
Returns
unknown
Defined in
projects/plugins/packages/scheduled-tasks/src/lib/structures/ScheduledTask.ts:18
toJSON
▸ toJSON(): PieceJSON
Defines the JSON.stringify behavior of this piece.
Returns
PieceJSON
Inherited from
Piece.toJSON
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:479
unload
▸ unload(): Promise<void>
Unloads and disables the piece.
Returns
Promise<void>
Inherited from
Piece.unload
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:471