Skip to main content

Interface: PieceContext

The context for the piece, contains extra information from the store, the piece's path, and the store that loaded it.

Properties

name

Readonly name: string

The module's name extracted from the path.

Defined in

projects/pieces/src/lib/structures/Piece.ts:24


path

Readonly path: string

The path the module was loaded from, relative to PieceContext.root.

Defined in

projects/pieces/src/lib/structures/Piece.ts:19


root

Readonly root: string

The root directory the piece was loaded from.

Defined in

projects/pieces/src/lib/structures/Piece.ts:14


store

Readonly store: Store<Piece<PieceOptions>>

The store that loaded the piece.

Defined in

projects/pieces/src/lib/structures/Piece.ts:29