# Module: constantBroker

Low level functions that enable management of constants data, meta-data from the framework, application and plugins.

Author:
  - Seth Hollingsead
Copyright:
  - Copyright © 2022-… by Seth Hollingsead. All rights reserved
Source:
  - brokers/constantBroker.js, line 1

### Requires

- module:configurator
- module:loggers
- module:data
- @haystacks/constants
- path

### Methods

#### (inner) addConstantsValidationData(constantsValidationData, contextName) → {boolean}

Adds a JSON object of constants validation data to the existing constants validation data.

##### Parameters:

Name | Type | Description
--- | --- | ---
`constantsValidationData` | object | The JSON object that contains the constants validation data that should be added to the validation data for the purpose of validation.
`contextName` | string | The type of data that should be added. Ex: Framework, Application, Plugin:PluginOne, Plugin:D-CAF

Author:
  - Seth Hollingsead
Source:
  - brokers/constantBroker.js, line 348

##### Returns:

True or False to indicate if the data was added successfully or not.

Type
  boolean

#### (inner) generateFrameworkConstantsValidationData() → {void}

Generate all of the framework constants validation data so that it cn be used to validate all of the framework constants.

Author:
  - Seth Hollingsead
Source:
  - brokers/constantBroker.js, line 50

##### Returns:

Type
  void

#### (inner) initializeConstantsValidationData() → {void}

Initializes the constants validation data structure.

Author:
  - Seth Hollingsead
Source:
  - brokers/constantBroker.js, line 29

##### Returns:

Type
  void

#### (inner) removePluginConstantsValidationData(pluginName) → {boolean}

Parses through the constants validation data and finds the constants validation data data associated with the named plugin. Then removes that data shredding it from existence at the edge of a black hole.

##### Parameters:

Name | Type | Description
--- | --- | ---
`pluginName` | string | The name of the plugin that should have its constants vaidation data removed from the D-data structure.

Author:
  - Seth Hollingsead
Source:
  - brokers/constantBroker.js, line 398

##### Returns:

True or False to indicate if the removal of the data was completed successfully or not.

Type
  boolean