Class ConfigValidator

Hierarchy

  • ConfigValidator

Constructors

constructor

Methods

validate fromSchemaFile

Constructors

constructor

  • Construct a validator of YAML files.

    Parameters

    • schema: any

      The JSON schema file object.

    Returns ConfigValidator

Methods

validate

  • 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

Static fromSchemaFile

Settings

Member Visibility

Theme

Generated using TypeDoc