Skip to main content

Class: Piece<O>

The piece to be stored in Store instances.

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

Whether or not the piece is enabled.

Defined in

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


location

โ€ข Readonly location: PieceLocation

The location metadata for the piece's file.

Defined in

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


name

โ€ข Readonly name: string

The name of the piece.

Defined in

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


options

โ€ข Readonly options: O

The raw options passed to this Piece

Defined in

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


store

โ€ข Readonly store: Store<Piece<PieceOptions>>

The store that contains the piece.

Defined in

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

Accessors

container

โ€ข get container(): Container

A reference to the Container object for ease of use.

see container

Returns

Container

Defined in

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

Methods

onLoad

โ–ธ onLoad(): unknown

Per-piece listener that is called when the piece is loaded into the store. Useful to set-up asynchronous initialization tasks.

Returns

unknown

Defined in

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


onUnload

โ–ธ onUnload(): unknown

Per-piece listener that is called when the piece is unloaded from the store. Useful to set-up clean-up tasks.

Returns

unknown

Defined in

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


reload

โ–ธ reload(): Promise<void>

Reloads the piece by loading the same path in the store.

Returns

Promise<void>

Defined in

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


toJSON

โ–ธ toJSON(): PieceJSON

Defines the JSON.stringify behavior of this piece.

Returns

PieceJSON

Defined in

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


unload

โ–ธ unload(): Promise<void>

Unloads and disables the piece.

Returns

Promise<void>

Defined in

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