Class: AliasPiece<Options, StoreName>

The piece to be stored in AliasStore instances.

Extends

• Piece<Options, StoreName>

Type parameters

Type parameter	Value
Options extends AliasPieceOptions	AliasPieceOptions
StoreName extends StoreRegistryKey	StoreRegistryKey

Constructors

new AliasPiece()

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

Parameters

Parameter	Type
context	LoaderContext<StoreName>
options	AliasPieceOptions

Returns

AliasPiece<Options, StoreName>

Overrides

Piece . constructor

Source

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

Properties

aliases

aliases: readonly string[]

The aliases for the piece.

Source

projects/pieces/src/lib/structures/AliasPiece.ts:22

---

enabled

enabled: boolean

Whether or not the piece is enabled.

Inherited from

Piece . enabled

Source

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

---

location

readonly location: PieceLocation

The location metadata for the piece's file.

Inherited from

Piece . location

Source

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

---

name

readonly name: string

The name of the piece.

Inherited from

Piece . name

Source

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

---

options

readonly options: Options

The raw options passed to this Piece

Inherited from

Piece . options

Source

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

---

store

readonly store: StoreOf<StoreName>

The store that contains the piece.

Inherited from

Piece . store

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

Inherited from

Piece . onLoad

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

Inherited from

Piece . onUnload

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>

Inherited from

Piece . reload

Source

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

---

toJSON()

toJSON(): AliasPieceJSON

Defines the JSON.stringify behavior of this alias piece.

Returns

AliasPieceJSON

Overrides

Piece . toJSON

Source

projects/pieces/src/lib/structures/AliasPiece.ts:32

---

unload()

unload(): Promise<void>

Unloads and disables the piece.

Returns

Promise<void>

Inherited from

Piece . unload

Source

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