Class: BlueprintBuilder<BlueprintType, ContextType>
Class: BlueprintBuilder<BlueprintType, ContextType>
Class representing a BlueprintBuilder for the Stone.js framework.
The BlueprintBuilder is responsible for constructing and configuring the dynamic, complex structured options required by the Stone.js framework. It introspects various modules, extracts metadata, and builds the "blueprint" object which serves as the primary configuration for the Stone.js application. This class also manages middleware used to process and populate the configuration during the application setup.
The BlueprintBuilder allows users to create a unified configuration that is used to initialize and bootstrap the Stone.js application, ensuring all necessary metadata is aggregated into a blueprint that can be used consistently throughout the application lifecycle.
Author
Mr. Stone evensstone@gmail.com
Type Parameters
BlueprintType
BlueprintType extends IBlueprint = IBlueprint
ContextType
ContextType extends BlueprintContext<BlueprintType> = BlueprintContext<BlueprintType>
Implements
IBlueprintBuilder<BlueprintType>
Methods
build()
build(modules): Promise<BlueprintType>;
Build the configuration blueprint by extracting metadata from the provided modules.
Parameters
modules
unknown[]
The modules to build the configuration from.
Returns
Promise<BlueprintType>
The configuration blueprint.
Example
const BlueprintBuilder = BlueprintBuilder.create(Config.create());
const blueprint = await BlueprintBuilder.build(rawModules);
Implementation of
create()
static create<BlueprintType, ContextType>(blueprint): BlueprintBuilder<BlueprintType, ContextType>;
Create a BlueprintBuilder.
Type Parameters
BlueprintType
BlueprintType extends IBlueprint = IBlueprint
ContextType
ContextType extends BlueprintContext<BlueprintType, | PipeClass | ClassType<any>> = BlueprintContext<BlueprintType, | PipeClass | ClassType<any>>
Parameters
blueprint
BlueprintType
The blueprint to create a BlueprintBuilder.
Returns
BlueprintBuilder<BlueprintType, ContextType>
A new BlueprintBuilder instance.