Skip to main content

Class: Piece<Options, StoreName>

The piece to be stored in Store instances.

Extended by

Type parameters

Type parameterValue
Options extends PieceOptionsPieceOptions
StoreName extends StoreRegistryKeyStoreRegistryKey

Constructors

new Piece()

new Piece<Options, StoreName>(context: LoaderContext<StoreName>, options: PieceOptions): Piece<Options, StoreName>

Parameters

ParameterType
contextLoaderContext<StoreName>
optionsPieceOptions

Returns

Piece<Options, StoreName>

Source

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

Properties

enabled

enabled: boolean

Whether or not the piece is enabled.

Source

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


location

readonly location: PieceLocation

The location metadata for the piece's file.

Source

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


name

readonly name: string

The name of the piece.

Source

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


options

readonly options: Options

The raw options passed to this Piece

Source

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


store

readonly store: StoreOf<StoreName>

The store that contains the piece.

Source

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

Accessors

container

get container(): Container

A reference to the Container object for ease of use.

See

container

Returns

Container

Source

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

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

Source

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


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

Source

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


reload()

reload(): Promise<void>

Reloads the piece by loading the same path in the store.

Returns

Promise<void>

Source

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


toJSON()

toJSON(): PieceJSON

Defines the JSON.stringify behavior of this piece.

Returns

PieceJSON

Source

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


unload()

unload(): Promise<void>

Unloads and disables the piece.

Returns

Promise<void>

Source

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