Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Task

Base class for all Klasa Task pieces. See {@tutorial CreatingTasks} for more information how to use this class to build custom tasks.

tutorial

CreatingTasks

Hierarchy

  • Piece
    • Task

Index

Constructors

constructor

  • new Task(store: Store<Piece>, directory: string, file: keyof string[], options?: PieceOptions): Task
  • since

    0.0.1

    Parameters

    • store: Store<Piece>

      The store this piece is for

    • directory: string

      The base directory to the pieces folder

    • file: keyof string[]

      The path from the pieces folder to the piece file

    • Optional options: PieceOptions

      The options for this piece

    Returns Task

Properties

Readonly client

client: Client

The client this Piece was created with.

since

0.0.1

Readonly directory

directory: string

The base directory this Piece is stored in.

since

0.0.1

enabled

enabled: boolean

Whether or not the Piece is enabled.

since

0.0.1

Readonly file

file: keyof string[]

The file location where this Piece is stored.

since

0.0.1

name

name: string

The name of the Piece.

since

0.0.1

Readonly store

store: Store<Piece>

The store this Piece is from.

since

0.0.1

Accessors

path

  • get path(): string
  • The absolute path to this piece

    since

    0.0.1

    Returns string

type

  • get type(): string
  • The type of piece this is

    since

    0.0.1

    Returns string

Methods

disable

  • disable(): this
  • Disables this piece

    since

    0.0.1

    chainable

    Returns this

enable

  • enable(): this
  • Enables this piece

    since

    0.0.1

    chainable

    Returns this

init

  • init(): unknown
  • The init method to be optionally overwritten in actual pieces

    since

    0.0.1

    Returns unknown

reload

  • reload(): Promise<Piece | null>
  • Reloads this piece

    since

    0.0.1

    Returns Promise<Piece | null>

    The newly loaded piece

Abstract run

  • The run method to be overwritten in actual Task pieces

    since

    0.5.0

    Parameters

    • data: TaskData

      The data from the ScheduledTask instance

    Returns Promise<void>

toJSON

  • toJSON(): Record<string, unknown>
  • Defines the JSON.stringify behavior of this piece.

    Returns Record<string, unknown>

toString

  • toString(): string
  • Defines toString behavior for pieces

    since

    0.0.1

    Returns string

    This piece name

unload

  • unload(): boolean
  • Unloads this piece

    since

    0.0.1

    Returns boolean

Generated using TypeDoc