Skip to content

@openfabr/cdf / Exports / InfraConfig

Class: InfraConfig<GC, NC, CC, SC, RC>

Concrete class that models the configuration for an infra project when using a package. It has 5 top-level sections (general, network, components, services and relations), each of which is expected to extended by packages for their own needs.

Usually there is no need to extend this class.

Type parameters

Name Type
GC extends GeneralConfig
NC extends NetworkConfig
CC extends ComponentConfig
SC extends ServiceConfig
RC extends RelationConfig

Table of contents

Constructors

Properties

Constructors

constructor

new InfraConfig<GC, NC, CC, SC, RC>(general, network, components, services, relations)

Type parameters

Name Type
GC extends GeneralConfig
NC extends NetworkConfig
CC extends ComponentConfig
SC extends ServiceConfig
RC extends RelationConfig

Parameters

Name Type Description
general GC Top-level general section.
network NC Top-level network section.
components TraitConfig<CC>[] Top-level components section which carries a list of trait sub-sections.
services RuntimeConfig<SC>[] Top-level services section which carries a list of runtime sub-sections.
relations RC[] Top-level relations section which carries a list of relation sub-section.

Defined in

src/lib/config.ts:150

Properties

components

Readonly components: TraitConfig<CC>[]

Top-level components section which carries a list of trait sub-sections.

Defined in

src/lib/config.ts:162


general

Readonly general: GC

Top-level general section.

Defined in

src/lib/config.ts:154


network

Readonly network: NC

Top-level network section.

Defined in

src/lib/config.ts:158


relations

Readonly relations: RC[]

Top-level relations section which carries a list of relation sub-section.

Defined in

src/lib/config.ts:170


services

Readonly services: RuntimeConfig<SC>[]

Top-level services section which carries a list of runtime sub-sections.

Defined in

src/lib/config.ts:166