Class: Piece<O>

Type parameters

Name	Type
O	extends PieceOptions = PieceOptions

Hierarchy

• Piece

  ↳ AliasPiece

  ↳ InteractionHandler

  ↳ Listener

  ↳ Precondition

Constructors

constructor

• new Piece<O>(context, options?)

Type parameters

Name	Type
O	extends PieceOptions = PieceOptions

Parameters

Name	Type
context	PieceContext
options?	PieceOptions

Defined in

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

Properties

enabled

• enabled: boolean

Defined in

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

---

location

• Readonly location: PieceLocation

Defined in

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

---

name

• Readonly name: string

Defined in

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

---

options

• Readonly options: O

Defined in

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

---

store

• Readonly store: Store<Piece<PieceOptions>>

Defined in

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

Accessors

container

• get container(): Container

Returns

Container

Defined in

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

Methods

onLoad

▸ onLoad(): unknown

Returns

unknown

Defined in

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

---

onUnload

▸ onUnload(): unknown

Returns

unknown

Defined in

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

---

reload

▸ reload(): Promise<void>

Returns

Promise<void>

Defined in

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

---

toJSON

▸ toJSON(): PieceJSON

Returns

PieceJSON

Defined in

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

---

unload

▸ unload(): Promise<void>

Returns

Promise<void>

Defined in

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