Class: Piece<Options, StoreName>
The piece to be stored in Store instances.
Type parameters
| Name | Type |
|---|---|
Options | extends PieceOptions = PieceOptions |
StoreName | extends StoreRegistryKey = StoreRegistryKey |
Hierarchy
-
Piece↳
Listener
Constructors
constructor
• new Piece<Options, StoreName>(context, options?): Piece<Options, StoreName>
Type parameters
| Name | Type |
|---|---|
Options | extends PieceOptions = PieceOptions |
StoreName | extends keyof StoreRegistryEntries = keyof StoreRegistryEntries |
Parameters
| Name | Type |
|---|---|
context | LoaderContext<StoreName> |
options? | PieceOptions |
Returns
Piece<Options, StoreName>
Defined in
node_modules/@sapphire/pieces/dist/esm/index.d.mts:239
Properties
enabled
• enabled: boolean
Whether or not the piece is enabled.
Defined in
node_modules/@sapphire/pieces/dist/esm/index.d.mts:234
location
• Readonly location: PieceLocation
The location metadata for the piece's file.
Defined in
node_modules/@sapphire/pieces/dist/esm/index.d.mts:226
name
• Readonly name: string
The name of the piece.
Defined in
node_modules/@sapphire/pieces/dist/esm/index.d.mts:230
options
• Readonly options: Options
The raw options passed to this Piece
Defined in
node_modules/@sapphire/pieces/dist/esm/index.d.mts:238
store
• Readonly store: StoreRegistryEntries[StoreName]
The store that contains the piece.
Defined in
node_modules/@sapphire/pieces/dist/esm/index.d.mts:222
Accessors
container
• get container(): Container
A reference to the Container object for ease of use.
Returns
See
container
Defined in
node_modules/@sapphire/pieces/dist/esm/index.d.mts:244
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
node_modules/@sapphire/pieces/dist/esm/index.d.mts:249
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
node_modules/@sapphire/pieces/dist/esm/index.d.mts:254
reload
▸ reload(): Promise<void>
Reloads the piece by loading the same path in the store.
Returns
Promise<void>
Defined in
node_modules/@sapphire/pieces/dist/esm/index.d.mts:262
toJSON
▸ toJSON(): PieceJSON
Defines the JSON.stringify behavior of this piece.
Returns
Defined in
node_modules/@sapphire/pieces/dist/esm/index.d.mts:266
unload
▸ unload(): Promise<void>
Unloads and disables the piece.
Returns
Promise<void>
Defined in
node_modules/@sapphire/pieces/dist/esm/index.d.mts:258