-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathtemplate-148.html
93 lines (88 loc) · 56.3 KB
/
template-148.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
<link rel="stylesheet" href="./resources/styles/elf-template.css">
<h1 id="data-generator">Data generator</h1>
<p><code>DataGenerator</code> class from grid utility packages is for generating data for testing purpose. </p>
<p>To generate data for feeding into Grid, use <code>generateRecords(fields, options)</code> method.</p>
<p>To add custom field data, use <code>addFieldInfo(field, options or function)</code> method.</p>
<h2 id="usage">Usage</h2>
<p><code>DataGenerator</code> class is located in the utility package as shown in the code snippet below: </p>
<pre><code class="language-js">import {DataGenerator} from "@refinitiv-ui/efx-grid/utils";
var fields = ["id", "companyName", "market", "CF_LAST", "CF_NETCHNG", "industry"];
var genOptions = {
seed: 0,
numRows: 10
};
var records = DataGenerator.generateRecords(fields, genOptions);
</code></pre>
<code-sandbox hash="2bf55f09"><pre><code class="language-css">html hr {
margin: 5px;
}
html input {
width: 50% !important;
}
textarea {
width: 100%;
height: 300px;
}
</code></pre>
<pre><code class="language-html"><label for="field_in">Fields:</label>
<input id="field_in" value="id, companyName, market, CF_LAST, CF_NETCHNG, industry">
<hr>
<label for="seed_in">Seed:</label>
<input id="seed_in" type="number" value="0">
<hr>
<textarea id="msg_ta"></textarea>
</code></pre>
<pre><code class="language-javascript">import { halo } from './theme-loader.js'; // This line is only required for demo purpose. It is not relevant for your application.
await halo(); // This line is only required for demo purpose. It is not relevant for your application.
/* ---------------------------------- Note ----------------------------------
DataGenerator, Formatters and extensions are exposed to global scope
in the bundle file to make it easier to create live examples.
Importing formatters and extensions is still required in your application.
Please see the document for further information.
---------------------------------------------------------------------------*/
field_in.addEventListener("change", updateRecords);
seed_in.addEventListener("change", updateRecords);
function updateRecords() {
var fields = field_in.value.split(/\W+/);
var seedNum = +(seed_in.value);
if(Number.isNaN(seedNum)) {
seedNum = null;
}
var records = DataGenerator.generateRecords(fields, {
seed: seedNum,
numRows: 6
});
msg_ta.value = JSON.stringify(records, null, 2);
}
updateRecords();
</code></pre>
</code-sandbox><h2 style="margin-bottom:5px" id="api-refs">DataGenerator API Reference</h2>
<div id="elf-api-container"><div id="main-template" class="elf-template"> <section><header> <h1 class="subsection-title"><span class="attribs"><span class="type-signature"></span></span>DataGenerator<span class="signature">(seed<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h1> </header><article> <h3 class="subsection-title" id="type_definitions">Type Definitions</h3>
<div class="item"> <div class="item-type">typedef</div> <h4 class="name" id="~DataOptions">DataOptions</h4><div class="description"> Options for generating data</div> <h5>Type:</h5> <span class="param-type">Object</span> <h5>Properties:</h5> <div class="props"><table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>seed</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">Seed for randomization. If seed is not specified (default), new set of data will be generated every time. Otherwise, the same set of data will be generated.</td> </tr> <tr> <td class="name"><code>numRows</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">Number of rows to be generated</td> </tr> <tr> <td class="name"><code>rowCount</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">Alias to numRows</td> </tr> </tbody></table></div><div class="details"> </div></div>
<div class="item"> <div class="item-type">typedef</div> <h4 class="name" id="~FieldInformation">FieldInformation</h4><div class="description"> Information object for defining how data are generated for a specific field</div> <h5>Type:</h5> <span class="param-type">Object</span> <h5>Properties:</h5> <div class="props"><table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>type</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">Available types are number, float, boolean, set, function, and isoDate</td> </tr> <tr> <td class="name"><code>prefix</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">Add a text prefix to the data</td> </tr> <tr> <td class="name"><code>suffix</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">Add a text suffix to the data</td> </tr> <tr> <td class="name"><code>min</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">Minimum value of the numeric data</td> </tr> <tr> <td class="name"><code>max</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">Maximum value of the numeric data. This is exclusive (not included in the result).</td> </tr> <tr> <td class="name"><code>prec</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">Precision (place number after the decimal point) of the numeric data.</td> </tr> <tr> <td class="name"><code>fixedValue</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">Single/static/constant value</td> </tr> <tr> <td class="name"><code>members</code></td> <td class="type"> <span class="param-type">Array</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">List of possible data when the type is "set"</td> </tr> <tr> <td class="name"><code>generate</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">Function for generating data when the type is "function"</td> </tr> </tbody></table></div><div class="details"> </div></div> <h3 class="subsection-title" id="methods">Methods</h3>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id=".addFieldInfo"><span class="type-signature"></span>addFieldInfo<span class="signature">(field, options)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">field</div> <div class="type"> <span class="param-type">string</span> </div> </div> <div class="param"> <div class="name">options</div> <div class="type"> <span class="param-type"><a href="#/utilities/data-generator#~FieldInformation">DataGenerator~FieldInformation</a></span> | <span class="param-type">function</span> </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id=".generate"><span class="type-signature"></span>generate<span class="signature">(fields, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Array.<Array>}</span></h4> <div class="description"> Generate 2 dimensional array of data from the specified field and options. Note that 2D array data structure is not recommended for usage due to the position of fields/columns can be changed at runtime. </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">fields</div> <div class="type"> <span class="param-type">string</span> | <span class="param-type">Array.<string></span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">options</div> <div class="type"> <span class="param-type"><a href="#/utilities/data-generator#~DataOptions">DataGenerator~DataOptions</a></span> </div> <div class="attributes"> <optional> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Array.<Array></span> </div><div class="sub-content-desc"> 2D Array of data</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id=".generateRecord"><span class="type-signature"></span>generateRecord<span class="signature">(fields, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Object}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">fields</div> <div class="type"> <span class="param-type">string</span> | <span class="param-type">Array.<string></span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">options</div> <div class="type"> <span class="param-type"><a href="#/utilities/data-generator#~DataOptions">DataGenerator~DataOptions</a></span> </div> <div class="attributes"> <optional> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Object</span> </div><div class="sub-content-desc"> Object with the given fields as its keys</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id=".generateRecords"><span class="type-signature"></span>generateRecords<span class="signature">(fields, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Array.<Object>}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">fields</div> <div class="type"> <span class="param-type">string</span> | <span class="param-type">Array.<string></span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">options</div> <div class="type"> <span class="param-type">number</span> | <span class="param-type"><a href="#/utilities/data-generator#~DataOptions">DataGenerator~DataOptions</a></span> </div> <div class="attributes"> <optional> </div> <div class="description"> Configuration object or number of rows </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Array.<Object></span> </div><div class="sub-content-desc"> Array of object with the given fields as its keys</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id=".randBetween"><span class="type-signature"></span>randBetween<span class="signature">(min<span class="signature-attributes">opt</span>, max<span class="signature-attributes">opt</span>, seed<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {number}</span></h4> <div class="description"> Return a integer random number in the range min - max (inclusive of min, but not max). </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">min</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> <optional> </div> </div> <div class="param"> <div class="name">max</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> <optional> </div> <div class="description"> Exclusive value </div> </div> <div class="param"> <div class="name">seed</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> <optional> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">number</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id=".randBoolean"><span class="type-signature"></span>randBoolean<span class="signature">(seed<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {boolean}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">seed</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> <optional> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">boolean</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id=".randDate"><span class="type-signature"></span>randDate<span class="signature">(min<span class="signature-attributes">opt</span>, max<span class="signature-attributes">opt</span>, seed<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Date}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">min</div> <div class="type"> <span class="param-type">number</span> | <span class="param-type">Object</span> </div> <div class="attributes"> <optional> </div> <div class="description"> minimum timestamp or date object </div> </div> <div class="param"> <div class="name">max</div> <div class="type"> <span class="param-type">number</span> | <span class="param-type">Object</span> </div> <div class="attributes"> <optional> </div> <div class="description"> minimum timestamp or date object </div> </div> <div class="param"> <div class="name">seed</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> <optional> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Date</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id=".randIndex"><span class="type-signature"></span>randIndex<span class="signature">(max, seed<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {number}</span></h4> <div class="description"> Return a integer random number in the range 0 - max <br>(exclusive of max). It is usefull in some cases for example, <br>if you want to get a random member of an array, <br>just get a random index via randIndex(ary.length). </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">max</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> </div> <div class="description"> Exclusive value </div> </div> <div class="param"> <div class="name">seed</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> <optional> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">number</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id=".randInt"><span class="type-signature"></span>randInt<span class="signature">(min, max, seed<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {number}</span></h4> <div class="description"> Return an interger random number in the range min - max (inclusive of min and max). </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">min</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">max</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> </div> <div class="description"> Inclusive value </div> </div> <div class="param"> <div class="name">seed</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> <optional> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">number</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id=".randMember"><span class="type-signature"></span>randMember<span class="signature">(set, seed<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {*}</span></h4> <div class="description"> Return a random member of set or single character in the range of A to Z </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">set</div> <div class="type"> <span class="param-type">Array</span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">seed</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> <optional> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">*</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id=".randNumber"><span class="type-signature"></span>randNumber<span class="signature">(min<span class="signature-attributes">opt</span>, max<span class="signature-attributes">opt</span>, prec<span class="signature-attributes">opt</span>, seed<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {number}</span></h4> <div class="description"> Return a floating-point random number in the range min - max (inclusive of min, but not max) with prec digits of precision. </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">min</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> <optional> </div> <div class="default"> [default: 0] </div> </div> <div class="param"> <div class="name">max</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> <optional> </div> <div class="default"> [default: 100] </div> <div class="description"> Exclusive value </div> </div> <div class="param"> <div class="name">prec</div> <div class="type"> <span class="param-type">number</span> | <span class="param-type">null</span> </div> <div class="attributes"> <optional> </div> <div class="default"> </div> </div> <div class="param"> <div class="name">seed</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> <optional> </div> <div class="default"> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">number</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id=".randString"><span class="type-signature"></span>randString<span class="signature">(min<span class="signature-attributes">opt</span>, max<span class="signature-attributes">opt</span>, subType<span class="signature-attributes">opt</span>, seed<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {string}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">min</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> <optional> </div> </div> <div class="param"> <div class="name">max</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> <optional> </div> </div> <div class="param"> <div class="name">subType</div> <div class="type"> <span class="param-type">string</span> </div> <div class="attributes"> <optional> </div> <div class="description"> "w"/"W" = word, "s"/"S" = sentence </div> </div> <div class="param"> <div class="name">seed</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> <optional> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">string</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id=".toRecords"><span class="type-signature"></span>toRecords<span class="signature">(data2D, fields<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Array.<Object>}</span></h4> <div class="description"> Convert 2D Array to Array of records </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">data2D</div> <div class="type"> <span class="param-type">Array.<Array></span> </div> <div class="attributes"> </div> <div class="description"> Array of values </div> </div> <div class="param"> <div class="name">fields</div> <div class="type"> <span class="param-type">Array.<string></span> </div> <div class="attributes"> <optional> </div> <div class="description"> Keys to be mapped on the output records. </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Array.<Object></span> </div><div class="sub-content-desc"> records</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="generate"><span class="type-signature"></span>generate<span class="signature">(fields, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Array.<Array>}</span></h4> <div class="description"> Generate 2 dimensional array of data from the specified field and options. Note that 2D array data structure is not recommended for usage due to the position of fields/columns can be changed at runtime. </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">fields</div> <div class="type"> <span class="param-type">string</span> | <span class="param-type">Array.<string></span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">options</div> <div class="type"> <span class="param-type">number</span> | <span class="param-type"><a href="#/utilities/data-generator#~DataOptions">DataGenerator~DataOptions</a></span> </div> <div class="attributes"> <optional> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Array.<Array></span> </div><div class="sub-content-desc"> 2D Array of data</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="generateQuoteData"><span class="type-signature"></span>generateQuoteData<span class="signature">(field, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Object}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">field</div> <div class="type"> <span class="param-type">string</span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">options</div> <div class="type"> <span class="param-type"><a href="#/utilities/data-generator#~DataOptions">DataGenerator~DataOptions</a></span> </div> <div class="attributes"> <optional> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Object</span> </div><div class="sub-content-desc"> Object with value, formattedValue and other properties</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="generateRecords"><span class="type-signature"></span>generateRecords<span class="signature">(fields, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Array.<Object>}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">fields</div> <div class="type"> <span class="param-type">string</span> | <span class="param-type">Array.<string></span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">options</div> <div class="type"> <span class="param-type">number</span> | <span class="param-type">Object</span> </div> <div class="attributes"> <optional> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Array.<Object></span> </div><div class="sub-content-desc"> Array of data object</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getSeed"><span class="type-signature"></span>getSeed<span class="signature">()</span><span class="type-signature"> → {number}</span></h4> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">number</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="randBetween"><span class="type-signature"></span>randBetween<span class="signature">(min<span class="signature-attributes">opt</span>, max<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {number}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">min</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> <optional> </div> </div> <div class="param"> <div class="name">max</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> <optional> </div> <div class="description"> Exclusive value </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">number</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="randBoolean"><span class="type-signature"></span>randBoolean<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">boolean</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="randDate"><span class="type-signature"></span>randDate<span class="signature">(min<span class="signature-attributes">opt</span>, max<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Date}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">min</div> <div class="type"> <span class="param-type">number</span> | <span class="param-type">Object</span> </div> <div class="attributes"> <optional> </div> <div class="description"> minimum timestamp or date object </div> </div> <div class="param"> <div class="name">max</div> <div class="type"> <span class="param-type">number</span> | <span class="param-type">Object</span> </div> <div class="attributes"> <optional> </div> <div class="description"> minimum timestamp or date object </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Date</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="randIndex"><span class="type-signature"></span>randIndex<span class="signature">(max)</span><span class="type-signature"> → {number}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">max</div> <div class="type"> <span class="param-type">number</span> </div> <div class="description"> Exclusive value </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">number</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="randInt"><span class="type-signature"></span>randInt<span class="signature">(min, max)</span><span class="type-signature"> → {number}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">min</div> <div class="type"> <span class="param-type">number</span> </div> </div> <div class="param"> <div class="name">max</div> <div class="type"> <span class="param-type">number</span> </div> <div class="description"> Inclusive value </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">number</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="randMember"><span class="type-signature"></span>randMember<span class="signature">(set)</span><span class="type-signature"> → {*}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">set</div> <div class="type"> <span class="param-type">Array</span> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">*</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="randNumber"><span class="type-signature"></span>randNumber<span class="signature">(min<span class="signature-attributes">opt</span>, max<span class="signature-attributes">opt</span>, prec<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {number}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">min</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> <optional> </div> <div class="default"> [default: 0] </div> </div> <div class="param"> <div class="name">max</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> <optional> </div> <div class="default"> [default: 100] </div> <div class="description"> Exclusive value </div> </div> <div class="param"> <div class="name">prec</div> <div class="type"> <span class="param-type">number</span> | <span class="param-type">null</span> </div> <div class="attributes"> <optional> </div> <div class="default"> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">number</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="randString"><span class="type-signature"></span>randString<span class="signature">(min<span class="signature-attributes">opt</span>, max<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {string}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">min</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> <optional> </div> </div> <div class="param"> <div class="name">max</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> <optional> </div> <div class="description"> Exclusive value </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">string</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setSeed"><span class="type-signature"></span>setSeed<span class="signature">(seed)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">seed</div> <div class="type"> <span class="param-type">number</span> </div> </div> </div> <div class="details"> </div> </div> </article></section></div></div>