Class Task`Abstract`

Represents a task.

Hierarchy (View Summary)

AkairoModule<TaskHandler, Task, TaskHandlerEvents>
- Task

Index

Constructors

Properties

category categoryID client delay? filepath handler id runOnStart

Methods

exec reload remove toString

Constructors

constructor

new Task(id: string, options?: TaskOptions): Task
Parameters
- id: string
  Task ID.
- options: TaskOptions = {}
  Options for the task.
Returns Task
Overrides AkairoModule.constructor
- Defined in src/struct/tasks/Task.ts:25

Properties

category

category: Category<string, Task>

The category this module belongs to.

categoryID

categoryID: string

The ID of the category this module belongs to.

client

client: AkairoClient<boolean, AkairoClientEvents>

The client thant instantiated this module.

`Optional`delay

delay?: number

The time in milliseconds between each time the task is run.

filepath

filepath: string

The filepath of this module.

handler

handler: TaskHandler

The handler for this module.

id

id: string

The ID of this module.

runOnStart

runOnStart: boolean

Whether or not to run the task on start.

Methods

`Abstract`exec

exec(...args: any[]): any
Executes the task.
Parameters
- ...args: any[]
  Arguments.
Returns any
- Defined in src/struct/tasks/Task.ts:39

reload

reload(): Promise<Task>
Reloads this module.

Returns Promise<Task>
Inherited from AkairoModule.reload
- Defined in src/struct/AkairoModule.ts:65

remove

remove(): Task
Removes this module.

Returns Task
Inherited from AkairoModule.remove
- Defined in src/struct/AkairoModule.ts:72

toString

toString(): string
Returns the ID of this module.

Returns string
Inherited from AkairoModule.toString
- Defined in src/struct/AkairoModule.ts:79