Skip to main content

Class: Piece<O>

Type parameters

NameType
Oextends PieceOptions = PieceOptions

Hierarchy

Constructors

constructor

new Piece<O>(context, options?)

Type parameters

NameType
Oextends PieceOptions = PieceOptions

Parameters

NameType
contextPieceContext
optionsPieceOptions

Defined in

projects/pieces/src/lib/structures/Piece.ts:78

Properties

enabled

enabled: boolean

Defined in

projects/pieces/src/lib/structures/Piece.ts:71


location

Readonly location: PieceLocation

Defined in

projects/pieces/src/lib/structures/Piece.ts:61


name

Readonly name: string

Defined in

projects/pieces/src/lib/structures/Piece.ts:66


options

Readonly options: O

Defined in

projects/pieces/src/lib/structures/Piece.ts:76


store

Readonly store: Store<Piece<PieceOptions>>

Defined in

projects/pieces/src/lib/structures/Piece.ts:56

Accessors

container

get container(): Container

Returns

Container

Defined in

projects/pieces/src/lib/structures/Piece.ts:90

Methods

onLoad

onLoad(): unknown

Returns

unknown

Defined in

projects/pieces/src/lib/structures/Piece.ts:98


onUnload

onUnload(): unknown

Returns

unknown

Defined in

projects/pieces/src/lib/structures/Piece.ts:106


reload

reload(): Promise<void>

Returns

Promise<void>

Defined in

projects/pieces/src/lib/structures/Piece.ts:121


toJSON

toJSON(): PieceJSON

Returns

PieceJSON

Defined in

projects/pieces/src/lib/structures/Piece.ts:128


unload

unload(): Promise<void>

Returns

Promise<void>

Defined in

projects/pieces/src/lib/structures/Piece.ts:113