Class SpecsFactory

The SpecsFactory class is used under the hood when loading your YAML specs.

This class is also accessible if you want to build your specs from code.

Hierarchy

SpecsFactory

Index

Constructors

Properties

Methods

appendSpec getSpec getSpecs

Constructors

constructor

new SpecsFactory(container: FactoryCtorInitParams): SpecsFactory
Parameters
- container: FactoryCtorInitParams
Returns SpecsFactory
- Defined in SpecsFactory.ts:16

Properties

`Private` specs

specs: ConfigSpecs

Methods

appendSpec

appendSpec(module: string, newSpec: ConfigItem): ConfigSpecs
Parameters
- module: string
- newSpec: ConfigItem
Returns ConfigSpecs
- Defined in SpecsFactory.ts:40

getSpec

getSpec(name: string, description: string, options?: ConfigItemOptions): ConfigItem
Parameters
- name: string
- description: string
- Optional options: ConfigItemOptions
Returns ConfigItem
- Defined in SpecsFactory.ts:23

getSpecs

getSpecs(): ConfigSpecs
Returns ConfigSpecs
- Defined in SpecsFactory.ts:36

Generated using TypeDoc