Class BasePiece<T>

Type parameters

T

Hierarchy

BasePiece
- Command
- Event
- Monitor
- Task

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BasePiece(client: MoonlightClient, pool: BasePool<string, T>, options?: BasePieceOptions): BasePiece

- Defined in home/runner/work/moonlight/moonlight/src/lib/structures/BasePiece.ts:34
Parameters
- client: MoonlightClient
- pool: BasePool<string, T>
- Optional options: BasePieceOptions
Returns BasePiece

Properties

Readonly client

client: MoonlightClient

Optional Readonly description

description: undefined | string

The description of the piece

disabled

disabled: boolean

Whether or not this piece is disabled

name

name: string | undefined

The name of the piece

options

options: BasePieceOptions | undefined

Readonly pool

pool: BasePool<string, T>

The pool this piece is part of

Methods

disable

disable(): void

- Defined in home/runner/work/moonlight/moonlight/src/lib/structures/BasePiece.ts:32
Returns void

enable

enable(): void

- Defined in home/runner/work/moonlight/moonlight/src/lib/structures/BasePiece.ts:28
Returns void

init

init(): void

- Defined in home/runner/work/moonlight/moonlight/src/lib/structures/BasePiece.ts:21
A function that runs at the bot startup once

Returns void

reload

reload(): void

- Defined in home/runner/work/moonlight/moonlight/src/lib/structures/BasePiece.ts:26
A function that reloads the file

Returns void

run

run(...arg: any[]): void

- Defined in home/runner/work/moonlight/moonlight/src/lib/structures/BasePiece.ts:16
Parameters
- Rest ...arg: any[]
Returns void

Generated using TypeDoc