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
options?PieceOptions

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:452

Properties

enabled

enabled: boolean

Whether or not the piece is enabled.

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:447


location

Readonly location: PieceLocation

The location metadata for the piece's file.

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:439


name

Readonly name: string

The name of the piece.

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:443


options

Readonly options: O

The raw options passed to this Piece

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:451


store

Readonly store: Store<Piece<PieceOptions>>

The store that contains the piece.

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:435

Accessors

container

get container(): Container

A reference to the {@link Container} object for ease of use.

see container

Returns

Container

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:457

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/index.d.ts:462


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/index.d.ts:467


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/index.d.ts:475


toJSON

toJSON(): PieceJSON

Defines the JSON.stringify behavior of this piece.

Returns

PieceJSON

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:479


unload

unload(): Promise<void>

Unloads and disables the piece.

Returns

Promise<void>

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:471