hayd-caf
Version:
Haystacks D-CAF: Distinguished Cloud Automation Framework is a web/cloud/SaaS/mobile GUI automation plugin that leverages a suite of business rules and a factory pattern to auto-generate functions and strings for logging that are used to execute test acti
340 lines (119 loc) • 7.42 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Module: main</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Module: main</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="description"><p>This is the main initialization for the plugin.
It contains the entry point and all public functions for the plugin.</p></div>
<dl class="details">
<dt class="tag-author">Author:</dt>
<dd class="tag-author">
<ul>
<li>Seth Hollingsead</li>
</ul>
</dd>
<dt class="tag-copyright">Copyright:</dt>
<dd class="tag-copyright"><ul class="dummy"><li>Copyright © 2023-… by Seth Hollingsead. All rights reserved</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="main.js.html">main.js</a>, <a href="main.js.html#line1">line 1</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Requires</h3>
<ul>
<li>module:plugin.constants</li>
<li><a href="module-warden.html">module:warden</a></li>
<li><a href="module-allPluginConstantsValidationMetadata.html">module:allPluginConstantsValidationMetadata</a></li>
<li><a href="module-loggers.html">module:loggers</a></li>
<li><a href="module-pluginData.html">module:pluginData</a></li>
<li><a href="https://www.npmjs.com/package/@haystacks/async">@haystacks/async</a></li>
<li><a href="https://www.npmjs.com/package/@haystacks/constants">@haystacks/constants</a></li>
<li><a href="https://www.npmjs.com/package/url">url</a></li>
<li><a href="https://www.npmjs.com/package/dotenv">dotenv</a></li>
<li><a href="https://www.npmjs.com/package/path">path</a></li>
</ul>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="~initializePlugin"><span class="type-signature">(inner) </span>initializePlugin<span class="signature">(inputMetaData)</span><span class="type-signature"> → {object}</span></h4>
<div class="description">
<p>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.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>inputMetaData</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>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.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-author">Author:</dt>
<dd class="tag-author">
<ul>
<li>Seth Hollingsead</li>
</ul>
</dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="main.js.html">main.js</a>, <a href="main.js.html#line77">line 77</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>A JSON object that contains all of the data that the plugin
provides to the Haystacks platform.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-allPluginConstantsValidationMetadata.html">allPluginConstantsValidationMetadata</a></li><li><a href="module-chiefCommander.html">chiefCommander</a></li><li><a href="module-chiefConfiguration.html">chiefConfiguration</a></li><li><a href="module-chiefData.html">chiefData</a></li><li><a href="module-chiefRules.html">chiefRules</a></li><li><a href="module-chiefTheme.html">chiefTheme</a></li><li><a href="module-chiefWorkflow.html">chiefWorkflow</a></li><li><a href="module-commandBroker.html">commandBroker</a></li><li><a href="module-commandsLibrary.html">commandsLibrary</a></li><li><a href="module-dCafCommands.html">dCafCommands</a></li><li><a href="module-dataBroker.html">dataBroker</a></li><li><a href="module-loggers.html">loggers</a></li><li><a href="module-main.html">main</a></li><li><a href="module-pluginData.html">pluginData</a></li><li><a href="module-ruleBroker.html">ruleBroker</a></li><li><a href="module-rulesLibrary.html">rulesLibrary</a></li><li><a href="module-selectorConstruction.html">selectorConstruction</a></li><li><a href="module-warden.html">warden</a></li><li><a href="plugin.business.constants.module_validation.html">plugin.business.constants.validation</a></li><li><a href="plugin.business.module_constants.html">plugin.business.constants</a></li><li><a href="plugin.command.constants.module_validation.html">plugin.command.constants.validation</a></li><li><a href="plugin.command.module_constants.html">plugin.command.constants</a></li><li><a href="plugin.constants.module_validation.html">plugin.constants.validation</a></li><li><a href="plugin.message.constants.module_validation.html">plugin.message.constants.validation</a></li><li><a href="plugin.message.module_constants.html">plugin.message.constants</a></li><li><a href="plugin.module_constants.html">plugin.constants</a></li><li><a href="plugin.system.constants.module_validation.html">plugin.system.constants.validation</a></li><li><a href="plugin.system.module_constants.html">plugin.system.constants</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Fri Apr 28 2023 18:01:37 GMT-0500 (Central Daylight Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>