lcars-library-node
Version:
NodeJS module for creating a library for the LCARS dashboard system
981 lines (648 loc) • 27.1 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>Random - lcars-library-node</title>
<link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css">
<link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
<link rel="icon" href="../assets/favicon.ico">
<script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script>
</head>
<body class="yui3-skin-sam">
<div id="doc">
<div id="hd" class="yui3-g header">
<div class="yui3-u-3-4">
<h1><img src="../assets/css/logo.png" title="lcars-library-node" width="117" height="52"></h1>
</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: 0.0.0</em>
</div>
</div>
<div id="bd" class="yui3-g">
<div class="yui3-u-1-4">
<div id="docs-sidebar" class="sidebar apidocs">
<div id="api-list">
<h2 class="off-left">APIs</h2>
<div id="api-tabview" class="tabview">
<ul class="tabs">
<li><a href="#api-classes">Classes</a></li>
<li><a href="#api-modules">Modules</a></li>
</ul>
<div id="api-tabview-filter">
<input type="search" id="api-filter" placeholder="Type to filter APIs">
</div>
<div id="api-tabview-panel">
<ul id="api-classes" class="apis classes">
<li><a href="../classes/Circulation.html">Circulation</a></li>
<li><a href="../classes/Distress.html">Distress</a></li>
<li><a href="../classes/Edge.html">Edge</a></li>
<li><a href="../classes/Element.html">Element</a></li>
<li><a href="../classes/Event.html">Event</a></li>
<li><a href="../classes/Exception.html">Exception</a></li>
<li><a href="../classes/External.html">External</a></li>
<li><a href="../classes/LCARSLibrary.html">LCARSLibrary</a></li>
<li><a href="../classes/LCARSServer.html">LCARSServer</a></li>
<li><a href="../classes/Modification.html">Modification</a></li>
<li><a href="../classes/Random.html">Random</a></li>
<li><a href="../classes/Search.html">Search</a></li>
<li><a href="../classes/Session.html">Session</a></li>
<li><a href="../classes/Set.html">Set</a></li>
<li><a href="../classes/Storage.html">Storage</a></li>
<li><a href="../classes/Terminal.html">Terminal</a></li>
<li><a href="../classes/User.html">User</a></li>
</ul>
<ul id="api-modules" class="apis modules">
<li><a href="../modules/Connections.html">Connections</a></li>
<li><a href="../modules/Elements.html">Elements</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="yui3-u-3-4">
<div id="api-options">
Show:
<label for="api-show-inherited">
<input type="checkbox" id="api-show-inherited" checked>
Inherited
</label>
<label for="api-show-protected">
<input type="checkbox" id="api-show-protected">
Protected
</label>
<label for="api-show-private">
<input type="checkbox" id="api-show-private">
Private
</label>
<label for="api-show-deprecated">
<input type="checkbox" id="api-show-deprecated">
Deprecated
</label>
</div>
<div class="apidocs">
<div id="docs-main">
<div class="content">
<h1>Random Class</h1>
<div class="box meta">
<div class="foundat">
Defined in: <a href="../files/library_util_random.js.html#l2"><code>library\util\random.js:2</code></a>
</div>
Module: <a href="../modules/Elements.html">Elements</a>
</div>
<div class="box intro">
<p>Provides static references to randomization functions.</p>
</div>
<div class="constructor">
<h2>Constructor</h2>
<div id="method_Random" class="method item">
<h3 class="name"><code>Random</code></h3>
<span class="paren">()</span>
<span class="flag static">static</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_util_random.js.html#l2"><code>library\util\random.js:2</code></a>
</p>
</div>
<div class="description">
</div>
</div>
</div>
<div id="classdocs" class="tabview">
<ul class="api-class-tabs">
<li class="api-class-tab index"><a href="#index">Index</a></li>
<li class="api-class-tab methods"><a href="#methods">Methods</a></li>
<li class="api-class-tab properties"><a href="#properties">Properties</a></li>
</ul>
<div>
<div id="index" class="api-class-tabpanel index">
<h2 class="off-left">Item Index</h2>
<div class="index-section methods">
<h3>Methods</h3>
<ul class="index-list methods">
<li class="index-item method">
<a href="#method_edgeID">edgeID</a>
</li>
<li class="index-item method">
<a href="#method_elementID">elementID</a>
</li>
<li class="index-item method">
<a href="#method_eventID">eventID</a>
</li>
<li class="index-item method">
<a href="#method_exceptionID">exceptionID</a>
</li>
<li class="index-item method">
<a href="#method_float">float</a>
</li>
<li class="index-item method">
<a href="#method_int">int</a>
</li>
<li class="index-item method">
<a href="#method_sessionID">sessionID</a>
</li>
<li class="index-item method">
<a href="#method_setID">setID</a>
</li>
<li class="index-item method">
<a href="#method_string">string</a>
</li>
<li class="index-item method">
<a href="#method_terminalID">terminalID</a>
</li>
</ul>
</div>
<div class="index-section properties">
<h3>Properties</h3>
<ul class="index-list properties">
<li class="index-item property private">
<a href="#property_alphanumeric">alphanumeric</a>
</li>
</ul>
</div>
</div>
<div id="methods" class="api-class-tabpanel">
<h2 class="off-left">Methods</h2>
<div id="method_edgeID" class="method item">
<h3 class="name"><code>edgeID</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code class="optional">[now]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">String</span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_util_random.js.html#l120"><code>library\util\random.js:120</code></a>
</p>
</div>
<div class="description">
<p>Return an identifier for Events.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name optional">[now]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Timestamp for marking the ID strictly for uniqueness. Defaults to Date.now().</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">String</span>:
<p>A string for identifying an edge.</p>
</div>
</div>
</div>
<div id="method_elementID" class="method item">
<h3 class="name"><code>elementID</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code class="optional">[now]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">String</span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_util_random.js.html#l110"><code>library\util\random.js:110</code></a>
</p>
</div>
<div class="description">
<p>Return an identifier for Events.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name optional">[now]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Timestamp for marking the ID strictly for uniqueness. Defaults to Date.now().</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">String</span>:
<p>A string for identifying an element.</p>
</div>
</div>
</div>
<div id="method_eventID" class="method item">
<h3 class="name"><code>eventID</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code class="optional">[now]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">String</span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_util_random.js.html#l100"><code>library\util\random.js:100</code></a>
</p>
</div>
<div class="description">
<p>Return an identifier for Events.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name optional">[now]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Timestamp for marking the ID strictly for uniqueness. Defaults to Date.now().</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">String</span>:
<p>A string for identifying an event.</p>
</div>
</div>
</div>
<div id="method_exceptionID" class="method item">
<h3 class="name"><code>exceptionID</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code class="optional">[now]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">String</span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_util_random.js.html#l90"><code>library\util\random.js:90</code></a>
</p>
</div>
<div class="description">
<p>Return an identifier for Exceptions.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name optional">[now]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Timestamp for marking the ID strictly for uniqueness. Defaults to Date.now().</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">String</span>:
<p>A string for identifying a exception.</p>
</div>
</div>
</div>
<div id="method_float" class="method item">
<h3 class="name"><code>float</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>range</code>
</li>
<li class="arg">
<code class="optional">[min]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Number</span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_util_random.js.html#l18"><code>library\util\random.js:18</code></a>
</p>
</div>
<div class="description">
<p>Return a floating point number.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">range</code>
<span class="type">Number</span>
<div class="param-description">
<p>The range/spread in which the returned number
should originate.</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[min]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>The minimum starting value to offset the returned
number specified by the range. If omitted, the returned number is
between 0 and this value.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Number</span>:
<p>A number from within the specified range.</p>
</div>
</div>
</div>
<div id="method_int" class="method item">
<h3 class="name"><code>int</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>range</code>
</li>
<li class="arg">
<code class="optional">[min]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Integer</span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_util_random.js.html#l35"><code>library\util\random.js:35</code></a>
</p>
</div>
<div class="description">
<p>Return an integer point number.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">range</code>
<span class="type">Number</span>
<div class="param-description">
<p>The range/spread in which the returned numbenr
should originate.</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[min]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>The minimum starting value to offset the returned
number specified by the range. If omitted, the returned number is
between 0 and this value.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Integer</span>:
<p>A number from within the specified range.</p>
</div>
</div>
</div>
<div id="method_sessionID" class="method item">
<h3 class="name"><code>sessionID</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code class="optional">[now]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">String</span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_util_random.js.html#l80"><code>library\util\random.js:80</code></a>
</p>
</div>
<div class="description">
<p>Return an identifier for Sessions.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name optional">[now]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Timestamp for marking the ID strictly for uniqueness. Defaults to Date.now().</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">String</span>:
<p>A string for identifying a session.</p>
</div>
</div>
</div>
<div id="method_setID" class="method item">
<h3 class="name"><code>setID</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code class="optional">[now]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">String</span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_util_random.js.html#l130"><code>library\util\random.js:130</code></a>
</p>
</div>
<div class="description">
<p>Return an identifier for Sets.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name optional">[now]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Timestamp for marking the ID strictly for uniqueness. Defaults to Date.now().</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">String</span>:
<p>A string for identifying a set.</p>
</div>
</div>
</div>
<div id="method_string" class="method item">
<h3 class="name"><code>string</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>len</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">String</span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_util_random.js.html#l52"><code>library\util\random.js:52</code></a>
</p>
</div>
<div class="description">
<p>Return a String of the specified length.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">len</code>
<span class="type">Number</span>
<div class="param-description">
<p>The length of the String to return.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">String</span>:
<p>A string with the specified length.</p>
</div>
</div>
</div>
<div id="method_terminalID" class="method item">
<h3 class="name"><code>terminalID</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code class="optional">[now]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">String</span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_util_random.js.html#l70"><code>library\util\random.js:70</code></a>
</p>
</div>
<div class="description">
<p>Return an identifier for Terminals.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name optional">[now]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Timestamp for marking the ID strictly for uniqueness. Defaults to Date.now().</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">String</span>:
<p>A string for identifying a terminal.</p>
</div>
</div>
</div>
</div>
<div id="properties" class="api-class-tabpanel">
<h2 class="off-left">Properties</h2>
<div id="property_alphanumeric" class="property item private">
<h3 class="name"><code>alphanumeric</code></h3>
<span class="type">Array</span>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_util_random.js.html#l10"><code>library\util\random.js:10</code></a>
</p>
</div>
<div class="description">
<p>Quick reference array for generating random strings</p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<script src="../assets/vendor/prettify/prettify-min.js"></script>
<script>prettyPrint();</script>
<script src="../assets/js/yui-prettify.js"></script>
<script src="../assets/../api.js"></script>
<script src="../assets/js/api-filter.js"></script>
<script src="../assets/js/api-list.js"></script>
<script src="../assets/js/api-search.js"></script>
<script src="../assets/js/apidocs.js"></script>
</body>
</html>