Class ConfigValidator

Hierarchy

ConfigValidator

Index

Constructors

Methods

validate fromSchemaFile

Constructors

constructor

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

Methods

validate

validate(inputConfig: any, defaultConfig?: Record<string, unknown>): any
Validate the input config.

Returns
The input config with defaults applied.

Throws
On validation errors
Parameters
- inputConfig: any
  
  The input config file path (string) or parsed config (Object).
- defaultConfig: Record<string, unknown> = {}
  
  The default config options.
Returns any
- Defined in src/components/config-validator.ts:43

`Static` fromSchemaFile

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

Generated using TypeDoc