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
351 lines (120 loc) • 7.38 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Module: dCafCommands</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: dCafCommands</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="description"><p>Contains all of the commands for the hayD-Caf 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="commandsBlob_commands_dCafCommands.js.html">commandsBlob/commands/dCafCommands.js</a>, <a href="commandsBlob_commands_dCafCommands.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="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/path">path</a></li>
</ul>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="~buildBrowserActionFunction"><span class="type-signature">(inner) </span>buildBrowserActionFunction<span class="signature">(inputData, inputMetaData)</span><span class="type-signature"> → {array.<boolean, object>}</span></h4>
<div class="description">
<p>Creates a function that can be used to execute an action against a browser or HTML interface of some kind.</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>inputData</code></td>
<td class="type">
<span class="param-type">array.<string></span>
</td>
<td class="description last"><p>An array that could actually contain anything,
depending on what the user entered. But the function filters all of that internally and
extracts the case the user has entered a list of meta-data that should be used for construction the browser action.
inputData[0] === 'buildBrowserActionFunction'
inputData[1] === CSS-locator
inputData[2] === parent
inputData[n] === action (default/override)</p></td>
</tr>
<tr>
<td class="name"><code>inputMetaData</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Not used for this command.</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="commandsBlob_commands_dCafCommands.js.html">commandsBlob/commands/dCafCommands.js</a>, <a href="commandsBlob_commands_dCafCommands.js.html#line27">line 27</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>An array that contains a boolean to indicate that the application should not exit,
and a JSON object that contains data about the object after the change was made.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">array.<boolean, 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>