Skip to main content

@sapphire/pieces v4.2.2

Namespaces

NamespaceDescription
AliasPiece-
Piece-
Store-

Enumerations

EnumerationDescription
LoaderErrorType-

Classes

ClassDescription
AliasPieceThe piece to be stored in AliasStore instances.
AliasStoreThe store class which contains AliasPieces.
LoaderErrorDescribes a loader error with a type for easy identification.
LoaderStrategyA multi-purpose feature-complete loader strategy supporting multi-piece modules as well as supporting both ECMAScript
MissingExportsErrorDescribes a LoaderErrorType.EmptyModule loader error and adds a path for easy identification.
PieceThe piece to be stored in Store instances.
PieceLocationThe metadata class used for Pieces.
StoreThe store class which contains Pieces.
StoreRegistryA strict-typed store registry. This is available in container.

Interfaces

InterfaceDescription
AliasPieceJSONThe return type of AliasPiece.toJSON.
AliasPieceOptions-
ContainerRepresents the type of the properties injected into the container, which is available at container.
HydratedModuleDataThe hydrated module data.
ILoaderStrategyAn abstracted loader strategy interface.
LoaderPieceContextThe context for the piece, contains extra information from the store,
ModuleDataThe module data information.
PieceContext-
PieceJSONThe return type of Piece.toJSON.
PieceLocationJSONThe return type of PieceLocation.toJSON.
PieceOptionsThe options for the Piece.
RootDataRepresents the root data.
StoreLogger-
StoreManagerManuallyRegisteredPieceAn entry for a manually registered piece using ().
StoreManuallyRegisteredPieceAn entry for a manually registered piece using ().
StoreOptionsThe options for the store, this features both hooks (changes the behaviour) and handlers (similar to event listeners).
StoreRegistryEntriesThe StoreRegistry's registry, use module augmentation against this interface when adding new stores.

Type Aliases

Type aliasDescription
AsyncPreloadResultRepresents the return data from ILoaderStrategy.preload
FilterResultThe result from the filter.
ILoaderResultRepresents the return data from ILoaderStrategy.load.
ILoaderResultEntryRepresents an entry from ILoaderResult.
PieceOfType utility to get the Piece given its Store's name.
PreloadResultRepresents the return data from ILoaderStrategy.preload
StoreOfType utility to get the Store given its name.
StoreRegistryKeyA type utility to get the keys of StoreRegistryEntries.
StoreRegistryValueA type utility to get the values of StoreRegistryEntries.

Variables

VariableDescription
VirtualPath-
containerThe injected variables that will be accessible to any place. To add an extra property, simply add a property with a

Functions

FunctionDescription
getRootData-
parseRootDataRetrieves the root data of the project.