Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ConfigSchema

Hierarchy

  • ConfigSchema

Index

Properties

Methods

Object literals

Properties

Static Private Readonly JSON_SCHEMA

JSON_SCHEMA: "https://json-schema.org/draft/2020-12/schema" = "https://json-schema.org/draft/2020-12/schema"

JSON schema URI stored in $schema property of the schema

readonly
memberof

ConfigSchema

Static Private Readonly SCHEMA_VERSION

SCHEMA_VERSION: "1.0" = "1.0"

Version number stored in $version property of the schema

readonly
memberof

ConfigSchema

Methods

Static Private _updateSchemaActive

  • HELPER function for updating the active layer's schema files This operation is divided in 2 steps:

    1. Update the schema file corresponding to the active layer
    2. Update the opposite (user/non-user) layer if it exists

    Parameters

    • opts: IConfigUpdateSchemaHelperOptions

      The various properties needed to accomplish a recursive UpdateSchema operation

    • Default value forceSetSchema: boolean = false

      Indicates if we should force the creation of the schema file even if the config doesn't exist (e.g. config init)

    • Default value checkContrastingLayer: boolean = true

      Indicates if we should check for the opposite (user/non-user) layer

    Returns IConfigUpdateSchemaPaths

    Object containing the updated schema paths

Static Private _updateSchemaAll

  • HELPER function for recursively updating schema files This operation is divided in 3 steps:

    1. Traverse UP the directory structure while updating the corresponding schema files
    2. Update both (User and Non-User) Global configuration's schema files
    3. Traverse DOWN the directory structure based on the depth specified

    Parameters

    Returns IConfigUpdateSchemaPaths

    Object containing the updated schema paths

Static Private _updateSchemaGlobal

Static buildSchema

Static findPropertyType

  • Find the type of a property based on schema info.

    Parameters

    • path: string

      Path to JSON property in config JSON

    • config: IConfig

      Team config properties

    • Optional schema: IConfigSchema

      Config schema definition. Defaults to profile schemas defined in Imperative config.

    Returns string | undefined

Static Private generateSchema

Static loadSchema

Static parseSchema

Static updateSchema

Object literals

Static Private Readonly explainSchemaSummary

explainSchemaSummary: object

Pretty explanation of the schema objects

readonly
memberof

ConfigSchema

$schema

$schema: string = "URL"

$version

$version: string = "Version"

explainedParentKey

explainedParentKey: string = "Schema"

ignoredKeys

ignoredKeys: null = null

properties

properties: object

defaults

defaults: string = "Default Definitions"

explainedParentKey

explainedParentKey: string = "Properties"

ignoredKeys

ignoredKeys: null = null

Generated using TypeDoc