@openfabr/cdf / Exports / Custom
Class: Custom<IPC, GC, NC, CC, SC, RC>
Abstract class to be extended by projects to develop custom code in order to augment the baseline infra generated by a package.
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 Custom<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
enhanceWith
▸ Abstract enhanceWith(config, result, scope): Result<InfraPlanOutputs, PlanError>
Augmenting the generated infra baseline with project-specific operations.
Parameters
| Name | Type | Description |
|---|---|---|
config | InfraConfig<GC, NC, CC, SC, RC> | The project configuration in full. |
result | InfraPlan<IPC> | The baseline infra generated so far by the package. |
scope | any | Optional parent construct. |
Returns
Result<InfraPlanOutputs, PlanError>
Result that encapsulates either outputs InfraPlanOutputs if successful, or error PlanError if failed.