Skip to main content

Class: AliasPiece<Options, StoreName>

The piece to be stored in AliasStore instances.

Type parameters

NameType
Optionsextends AliasPieceOptions = AliasPieceOptions
StoreNameextends StoreRegistryKey = StoreRegistryKey

Hierarchy

Constructors

constructor

new AliasPiece<Options, StoreName>(context, options?): AliasPiece<Options, StoreName>

Type parameters

NameType
Optionsextends AliasPieceOptions = AliasPieceOptions
StoreNameextends keyof StoreRegistryEntries = keyof StoreRegistryEntries

Parameters

NameType
contextLoaderContext<StoreName>
options?AliasPieceOptions

Returns

AliasPiece<Options, StoreName>

Overrides

Piece.constructor

Defined in

node_modules/@sapphire/pieces/dist/esm/index.d.mts:878

Properties

aliases

aliases: readonly string[]

The aliases for the piece.

Defined in

node_modules/@sapphire/pieces/dist/esm/index.d.mts:877


enabled

enabled: boolean

Whether or not the piece is enabled.

Inherited from

Piece.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.

Inherited from

Piece.location

Defined in

node_modules/@sapphire/pieces/dist/esm/index.d.mts:226


name

Readonly name: string

The name of the piece.

Inherited from

Piece.name

Defined in

node_modules/@sapphire/pieces/dist/esm/index.d.mts:230


options

Readonly options: Options

The raw options passed to this Piece

Inherited from

Piece.options

Defined in

node_modules/@sapphire/pieces/dist/esm/index.d.mts:238


store

Readonly store: StoreRegistryEntries[StoreName]

The store that contains the piece.

Inherited from

Piece.store

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

Container

See

container

Inherited from

Piece.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

Inherited from

Piece.onLoad

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

Inherited from

Piece.onUnload

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>

Inherited from

Piece.reload

Defined in

node_modules/@sapphire/pieces/dist/esm/index.d.mts:262


toJSON

toJSON(): AliasPieceJSON

Defines the JSON.stringify behavior of this alias piece.

Returns

AliasPieceJSON

Overrides

Piece.toJSON

Defined in

node_modules/@sapphire/pieces/dist/esm/index.d.mts:882


unload

unload(): Promise<void>

Unloads and disables the piece.

Returns

Promise<void>

Inherited from

Piece.unload

Defined in

node_modules/@sapphire/pieces/dist/esm/index.d.mts:258