Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Finalizer

Base class for all Klasa Finalizers. See {@tutorial CreatingFinalizers} for more information how to use this class to build custom finalizers.

tutorial

CreatingFinalizers

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new Finalizer(store: Store<Piece>, directory: string, file: keyof string[], options?: PieceOptions): Finalizer
  • 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 Finalizer

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

Protected _run

  • _run(message: Message, command: Command, responses: Message[] | undefined, runTime: Stopwatch): Promise<void>

  • Run a finalizer and catch any uncaught promises

    since

    0.5.0

    Parameters

    • message: Message

      The message that called the command

    • command: Command

      The command this finalizer is for (may be different than message.command)

    • responses: Message[] | undefined

      The bot's response message, if one is returned

    • runTime: Stopwatch

      The time it took to generate the command

    Returns Promise<void>

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

  • run(message: Message, command: Command, responses: Message[] | undefined, runTime: Stopwatch): Promise<unknown> | unknown

  • The run method to be overwritten in actual finalizers

    since

    0.0.1

    Parameters

    • message: Message

      The message used to trigger this finalizer

    • command: Command

      The command this finalizer is for (may be different than message.command)

    • responses: Message[] | undefined

      The bot's response message, if one is returned

    • runTime: Stopwatch

      The time it took to generate the command

    Returns Promise<unknown> | unknown

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