Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Monitor

Base class for all Klasa Monitors. See {@tutorial CreatingMonitors} for more information how to use this class to build custom monitors.

tutorial

CreatingMonitors

Hierarchy

Index

Constructors

constructor

Properties

allowedTypes

allowedTypes: MessageType[]

The types of messages allowed for this monitor

since

0.5.0

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

ignoreBots

ignoreBots: boolean

Whether the monitor ignores bots or not

since

0.0.1

ignoreEdits

ignoreEdits: boolean

Whether the monitor ignores edits or not

since

0.5.0

ignoreOthers

ignoreOthers: boolean

Whether the monitor ignores others or not

since

0.4.0

ignoreSelf

ignoreSelf: boolean

Whether the monitor ignores itself or not

since

0.0.1

ignoreWebhooks

ignoreWebhooks: boolean

Whether the monitor ignores webhooks or not

since

0.5.0

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): 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): Promise<unknown>

shouldRun

  • shouldRun(message: Message): boolean

toJSON

  • toJSON(): Record<string, any>

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