@openfabr/cdf / Exports / Planner
Class: Planner<IPC, GC, NC, CC, SC, RC>
Abstract class to be extended by packages to generate infra baseline.
Type parameters
| Name | Type |
|---|---|
IPC | extends InfraPlanConstructs |
GC | extends GeneralConfig |
NC | extends NetworkConfig |
CC | extends ComponentConfig |
SC | extends ServiceConfig |
RC | extends RelationConfig |
Table of contents
Constructors
Methods
Constructors
constructor
• new Planner<IPC, GC, NC, CC, SC, RC>()
Type parameters
| Name | Type |
|---|---|
IPC | extends InfraPlanConstructs |
GC | extends GeneralConfig |
NC | extends NetworkConfig |
CC | extends ComponentConfig |
SC | extends ServiceConfig |
RC | extends RelationConfig |
Methods
runWith
▸ Abstract runWith(config, scope): Result<InfraPlan<IPC>, PlanError>
Provisioning infra according to the configuration.
Parameters
| Name | Type | Description |
|---|---|---|
config | InfraConfig<GC, NC, CC, SC, RC> | The project configuration in full. |
scope | any | Optional parent construct. |
Returns
Result<InfraPlan<IPC>, PlanError>
Result that encapsulates either the infra baseline InfraPlan if successful, or error PlanError if failed.