Contains middle or low-level data management functions.
- Copyright:
- Copyright © 2023-… by Seth Hollingsead. All rights reserved
- Source:
Requires
- module:plugin.constants
- module:loggers
- module:pluginData
- @haystacks/async
- @haystacks/constants
- path
Methods
(inner) initData() → {void}
Initialize the data that will be used by the plugin to load all of the plugin content and export it to the Haystacks platform.
- Source:
Returns:
- Type
- void
(inner) loadCommandAliasesData(aliasesPath) → {object}
Loads the plugin command aliases data by calling the Haystacks platform to load and parse the command aliases data from the specified path.
Parameters:
| Name | Type | Description |
|---|---|---|
aliasesPath |
string | The fully qualified path to the command aliases folder with all of the command aliases data for the plugin. |
- Source:
Returns:
A JSON object that contains all of the command aliases data loaded and parsed from the specified path.
- Type
- object
(inner) loadConfigData(configPath) → {object}
Calls the Haystacks platform to load the configuration data, parse it and return it as a JSON object.
Parameters:
| Name | Type | Description |
|---|---|---|
configPath |
string | The path to the plugin configuration data that must be loaded. |
- Source:
Returns:
A JSON object that contains all of the configuration data loaded and parsed from the specified path.
- Type
- object
(inner) loadThemesData(themesPath) → {object}
Loads the plugin themes data by calling the Haystacks platform to load and parse the themes data from the specified path.
Parameters:
| Name | Type | Description |
|---|---|---|
themesPath |
string | The fully qualified path to the themes folder with all of the themes data for the plugin. |
- Source:
Returns:
A JSON object that contains all of the themes paths data loaded and parsed from the specified path.
- Type
- object
(inner) loadWorkflowsData(workflowsPath) → {object}
Loads the plugin workflows data by calling the Haystacks platform to load and parse the workflows data from the specified path.
Parameters:
| Name | Type | Description |
|---|---|---|
workflowsPath |
string | The fully qualified path to the workflows folder with all of the workflows data for the plugin. |
- Source:
Returns:
A JSON object that contains all of the workflows data loaded and parsed from the specified path.
- Type
- object