Class: Piece<Options, StoreName>
The piece to be stored in Store instances.
Extended by
Type Parameters
| Type Parameter | Default type |
|---|---|
Options extends PieceOptions | PieceOptions |
StoreName extends StoreRegistryKey | StoreRegistryKey |
Constructors
new Piece()
new Piece<
Options,StoreName>(context:LoaderContext<StoreName>,options:PieceOptions):Piece<Options,StoreName>
Parameters
| Parameter | Type |
|---|---|
context | LoaderContext<StoreName> |
options | PieceOptions |
Returns
Piece<Options, StoreName>
Defined in
projects/pieces/src/lib/structures/Piece.ts:82
Properties
enabled
enabled:
boolean
Whether or not the piece is enabled.
Defined in
projects/pieces/src/lib/structures/Piece.ts:75
location
readonlylocation:PieceLocation
The location metadata for the piece's file.
Defined in
projects/pieces/src/lib/structures/Piece.ts:65
name
readonlyname:string
The name of the piece.
Defined in
projects/pieces/src/lib/structures/Piece.ts:70
options
readonlyoptions:Options
The raw options passed to this Piece
Defined in
projects/pieces/src/lib/structures/Piece.ts:80
store
readonlystore:StoreOf<StoreName>
The store that contains the piece.
Defined in
projects/pieces/src/lib/structures/Piece.ts:60
Accessors
container
getcontainer():Container
A reference to the Container object for ease of use.
See
container
Returns
Defined in
projects/pieces/src/lib/structures/Piece.ts:94
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:102
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:110
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:125
toJSON()
toJSON():
PieceJSON
Defines the JSON.stringify behavior of this piece.
Returns
Defined in
projects/pieces/src/lib/structures/Piece.ts:132
unload()
unload():
Promise<void>
Unloads and disables the piece.
Returns
Promise<void>