Skip to main content

Class: Utility

@sapphire/plugin-utilities-store.Utility

Since

1.0.0

Hierarchy​

  • Piece

    ↳ Utility

Constructors​

constructor​

• new Utility(context, options?)

Parameters​

NameType
contextPieceContext
options?PieceOptions

Inherited from​

Piece.constructor

Defined in​

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

Properties​

enabled​

• enabled: boolean

Whether or not the piece is enabled.

Inherited from​

Piece.enabled

Defined in​

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

location​

• Readonly location: PieceLocation

The location metadata for the piece's file.

Inherited from​

Piece.location

Defined in​

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

name​

• Readonly name: string

The name of the piece.

Inherited from​

Piece.name

Defined in​

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

options​

• Readonly options: PieceOptions

The raw options passed to this Piece

Inherited from​

Piece.options

Defined in​

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

store​

• Readonly store: Store<Piece<PieceOptions>>

The store that contains the piece.

Inherited from​

Piece.store

Defined in​

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

Accessors​

container​

• get container(): Container

A reference to the Container object for ease of use.

See

container

Returns​

Container

Inherited from​

Piece.container

Defined in​

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

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

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

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

toJSON​

▸ toJSON(): PieceJSON

Defines the JSON.stringify behavior of this piece.

Returns​

PieceJSON

Inherited from​

Piece.toJSON

Defined in​

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

unload​

▸ unload(): Promise<void>

Unloads and disables the piece.

Returns​

Promise<void>

Inherited from​

Piece.unload

Defined in​

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