Class: Piece<O>
The piece to be stored in Store instances.
Type parameters​
| Name | Type |
|---|---|
O | extends PieceOptions = PieceOptions |
Hierarchy​
Piece↳
AliasPiece
Constructors​
constructor​
• new Piece<O>(context, options?)
Type parameters​
| Name | Type |
|---|---|
O | extends PieceOptions = PieceOptions |
Parameters​
| Name | Type |
|---|---|
context | PieceContext |
options | PieceOptions |
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​
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​
Defined in​
projects/pieces/src/lib/structures/Piece.ts:128
unload​
â–¸ unload(): Promise<void>
Unloads and disables the piece.
Returns​
Promise<void>