Class ConfigValidator

Index

Constructors

Methods

validate fromSchemaFile

Constructors

constructor

new ConfigValidator(schema): ConfigValidator
Construct a validator of YAML files.
Parameters
- schema: any
  The JSON schema file object.
Returns ConfigValidator
- Defined in src/components/config-validator.ts:34

Methods

validate

validate(inputConfig, defaultConfig?): any
Validate the input config.
Parameters
- inputConfig: any
  The input config file path (string) or parsed config (Object).
- defaultConfig: Record<string, unknown> = {}
  The default config options.
Returns any
The input config with defaults applied.

Throws
On validation errors
- Defined in src/components/config-validator.ts:44

`Static` fromSchemaFile

fromSchemaFile(filename): ConfigValidator
Parameters
- filename: string
Returns ConfigValidator
- Defined in src/components/config-validator.ts:74

Generated using TypeDoc