This is the main initialization for the plugin. It contains the entry point and all public functions for the plugin.
Requires
- module:plugin.constants
- module:warden
- module:allPluginConstantsValidationMetadata
- module:loggers
- module:pluginData
- @haystacks/async
- @haystacks/constants
- url
- dotenv
- path
Methods
(inner) initializePlugin(inputMetaData) → {object}
Collects all of the plugin data and provides it to the Haystacks platform so it can be used at run-time to provide enhanced capabilities to the application that loads this plugin.
Parameters:
| Name | Type | Description |
|---|---|---|
inputMetaData |
object | A JSON object that contains meta-data needed by the plugin. In particular this contains a Haystacks context data object that can be used to inject into a new instance of Haystacks, such that the new instance of Haystacks will act and behave exactly like the host application instance of Haystacks. Including being able to make calls back to Haystacks, for the purpose of loading and parsing files, or any number of other operations that need to be done. |
Returns:
A JSON object that contains all of the data that the plugin provides to the Haystacks platform.
- Type
- object