beef-npm
Version:
Node.js package to install and interact with BeEF (Browser Exploitation Framework)
1,165 lines (244 loc) • 13.1 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Namespace: browser_jools</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">Namespace: browser_jools</h1>
<section>
<header>
<h2>browser_jools</h2>
</header>
<article>
<div class="container-overview">
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_browser_jools.js.html">lib/browser_jools.js</a>, <a href="lib_browser_jools.js.html#line1">line 1</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id=".exports.version"><span class="type-signature">(static) </span>exports.version<span class="type-signature"></span></h4>
<div class="description">
<p>version</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_browser_jools.js.html">lib/browser_jools.js</a>, <a href="lib_browser_jools.js.html#line382">line 382</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".require.resolve"><span class="type-signature">(static) </span>require.resolve<span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_browser_jools.js.html">lib/browser_jools.js</a>, <a href="lib_browser_jools.js.html#line34">line 34</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id=".Jools"><span class="type-signature">(static) </span>Jools<span class="signature">(rules)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Jools constructor.</p>
<p>A rule consists of:</p>
<ul>
<li>Descriptive name</li>
<li>One or more conditions</li>
<li>One or more consequences, which are fired when all conditions evaluate to true.</li>
</ul>
</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>rules</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_browser_jools.js.html">lib/browser_jools.js</a>, <a href="lib_browser_jools.js.html#line394">line 394</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".module.exports.paramNames"><span class="type-signature">(static) </span>module.exports.paramNames<span class="signature">(f)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Returns an array of parameter names of the function f</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>f</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_browser_jools.js.html">lib/browser_jools.js</a>, <a href="lib_browser_jools.js.html#line453">line 453</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".module.exports.paramsToArguments"><span class="type-signature">(static) </span>module.exports.paramsToArguments<span class="signature">(obj, params)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Creates an array of arguments</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>obj</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>params</code></td>
<td class="type">
<span class="param-type">Array</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_browser_jools.js.html">lib/browser_jools.js</a>, <a href="lib_browser_jools.js.html#line471">line 471</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".normalizeArray"><span class="type-signature">(static) </span>normalizeArray<span class="signature">(parts, allowAboveRoot)</span><span class="type-signature"></span></h4>
<div class="description">
<p>resolves . and .. elements in a path array with directory names there
must be no slashes, empty elements, or device names (c:) in the array
(so also no leading and trailing slashes - it does not distinguish
relative and absolute paths)</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>parts</code></td>
<td class="type">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>allowAboveRoot</code></td>
<td class="type">
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_browser_jools.js.html">lib/browser_jools.js</a>, <a href="lib_browser_jools.js.html#line242">line 242</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".require"><span class="type-signature">(static) </span>require<span class="signature">(file, cwd)</span><span class="type-signature"></span></h4>
<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>file</code></td>
<td class="type">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>cwd</code></td>
<td class="type">
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_browser_jools.js.html">lib/browser_jools.js</a>, <a href="lib_browser_jools.js.html#line10">line 10</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".require.alias"><span class="type-signature">(static) </span>require.alias<span class="signature">()</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_browser_jools.js.html">lib/browser_jools.js</a>, <a href="lib_browser_jools.js.html#line121">line 121</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".require.define"><span class="type-signature">(static) </span>require.define<span class="signature">()</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_browser_jools.js.html">lib/browser_jools.js</a>, <a href="lib_browser_jools.js.html#line152">line 152</a>
</li></ul></dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="beef.are.html">are</a></li><li><a href="beef.browser.html">browser</a></li><li><a href="beef.browser.cookie.html">cookie</a></li><li><a href="beef.browser.popup.html">popup</a></li><li><a href="beef.dom.html">dom</a></li><li><a href="beef.encode.base64.html">base64</a></li><li><a href="beef.encode.json.html">json</a></li><li><a href="beef.geolocation.html">geolocation</a></li><li><a href="beef.hardware.html">hardware</a></li><li><a href="beef.init.html">init</a></li><li><a href="beef.logger.html">logger</a></li><li><a href="beef.mitb.html">mitb</a></li><li><a href="beef.net.html">net</a></li><li><a href="beef.net.connection.html">connection</a></li><li><a href="beef.net.cors.html">cors</a></li><li><a href="beef.net.dns.html">dns</a></li><li><a href="beef.net.local.html">local</a></li><li><a href="beef.net.portscanner.html">portscanner</a></li><li><a href="beef.net.requester.html">requester</a></li><li><a href="beef.net.xssrays.html">xssrays</a></li><li><a href="beef.os.html">os</a></li><li><a href="beef.session.html">session</a></li><li><a href="beef.timeout.html">timeout</a></li><li><a href="beef.updater.html">updater</a></li><li><a href="beef.webrtc.html">webrtc</a></li><li><a href="beef.websocket.html">websocket</a></li><li><a href="BeefJS.html">BeefJS</a></li><li><a href="browser_jools.html">browser_jools</a></li><li><a href="platform.html">platform</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Thu Jan 02 2020 16:29:11 GMT+1000 (Australian Eastern Standard Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>