Skip to content

Commit af30dab

Browse files
r37r0m0d3lr37r0m0d3l
committed
feat: update documentation
1 parent 91670e3 commit af30dab

File tree

2 files changed

+205
-27
lines changed

2 files changed

+205
-27
lines changed

‎docs/enums/generate.NAMESPACE.html

Lines changed: 205 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,205 @@
1+
<!doctype html>
2+
<html class="default no-js">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6+
<title>NAMESPACE | @corefunc/v8</title>
7+
<meta name="description" content="">
8+
<meta name="viewport" content="width=device-width, initial-scale=1">
9+
<link rel="stylesheet" href="../assets/css/main.css">
10+
<script async src="../assets/js/search.js" id="search-script"></script>
11+
</head>
12+
<body>
13+
<header>
14+
<div class="tsd-page-toolbar">
15+
<div class="container">
16+
<div class="table-wrap">
17+
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
18+
<div class="field">
19+
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
20+
<input id="tsd-search-field" type="text" />
21+
</div>
22+
<ul class="results">
23+
<li class="state loading">Preparing search index...</li>
24+
<li class="state failure">The search index is not available</li>
25+
</ul>
26+
<ul class="results-priority" style="display:none">
27+
</ul>
28+
<a href="../index.html" class="title">@corefunc/v8</a>
29+
</div>
30+
<div class="table-cell" id="tsd-widgets">
31+
<div id="tsd-filter">
32+
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
33+
<div class="tsd-filter-group">
34+
<div class="tsd-select" id="tsd-filter-visibility">
35+
<span class="tsd-select-label">All</span>
36+
<ul class="tsd-select-list">
37+
<li data-value="public">Public</li>
38+
<li data-value="protected">Public/Protected</li>
39+
<li data-value="private" class="selected">All</li>
40+
</ul>
41+
</div>
42+
<input type="checkbox" id="tsd-filter-inherited" checked />
43+
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
44+
<input type="checkbox" id="tsd-filter-externals" checked />
45+
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
46+
<input type="checkbox" id="tsd-filter-only-exported" />
47+
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
48+
</div>
49+
</div>
50+
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
51+
</div>
52+
</div>
53+
</div>
54+
</div>
55+
<div class="tsd-page-title">
56+
<div class="container">
57+
<ul class="tsd-breadcrumb">
58+
<li>
59+
<a href="../modules/generate.html">generate</a>
60+
</li>
61+
<li>
62+
<a href="generate.NAMESPACE.html">NAMESPACE</a>
63+
</li>
64+
</ul>
65+
</div>
66+
</div>
67+
</header>
68+
<div class="container container-main">
69+
<div class="row">
70+
<div class="col-3 col-menu menu-sticky-wrap menu-highlight">
71+
<nav class="tsd-navigation primary">
72+
<ul>
73+
<li class=" ">
74+
<a href="../modules.html">Modules</a>
75+
</li>
76+
<li class="label tsd-is-external">
77+
<span>Externals</span>
78+
</li>
79+
<li class=" tsd-kind-module tsd-is-external">
80+
<a href="../modules/base64.html">base64</a>
81+
</li>
82+
<li class=" tsd-kind-module tsd-is-external">
83+
<a href="../modules/clone.html">clone</a>
84+
</li>
85+
<li class=" tsd-kind-module tsd-is-external">
86+
<a href="../modules/deserialize.html">deserialize</a>
87+
</li>
88+
<li class="current tsd-kind-module tsd-is-external">
89+
<a href="../modules/generate.html">generate</a>
90+
</li>
91+
<li class=" tsd-kind-module tsd-is-external">
92+
<a href="../modules/serialize.html">serialize</a>
93+
</li>
94+
</ul>
95+
</nav>
96+
</div>
97+
<div class="col-7 offset-3 col-content">
98+
<h1>Enumeration NAMESPACE</h1>
99+
<section class="tsd-panel-group tsd-index-group">
100+
<section class="tsd-panel tsd-index-panel">
101+
<div class="tsd-index-content">
102+
<section class="tsd-index-section tsd-is-external">
103+
<h3>Enumeration members</h3>
104+
<ul class="tsd-index-list">
105+
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="generate.NAMESPACE.html#DNS" class="tsd-kind-icon">DNS</a></li>
106+
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="generate.NAMESPACE.html#OID" class="tsd-kind-icon">OID</a></li>
107+
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="generate.NAMESPACE.html#URL" class="tsd-kind-icon">URL</a></li>
108+
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="generate.NAMESPACE.html#X500" class="tsd-kind-icon">X500</a></li>
109+
</ul>
110+
</section>
111+
</div>
112+
</section>
113+
</section>
114+
<section class="tsd-panel-group tsd-member-group tsd-is-external">
115+
<h2>Enumeration members</h2>
116+
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
117+
<a name="DNS" class="tsd-anchor"></a>
118+
<h3>DNS</h3>
119+
<div class="tsd-signature tsd-kind-icon">DNS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;6ba7b810-9dad-11d1-80b4-00c04fd430c8&quot;</span></div>
120+
<aside class="tsd-sources">
121+
<ul>
122+
<li>Defined in generate/uuid5.ts:58</li>
123+
</ul>
124+
</aside>
125+
</section>
126+
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
127+
<a name="OID" class="tsd-anchor"></a>
128+
<h3>OID</h3>
129+
<div class="tsd-signature tsd-kind-icon">OID<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;6ba7b812-9dad-11d1-80b4-00c04fd430c8&quot;</span></div>
130+
<aside class="tsd-sources">
131+
<ul>
132+
<li>Defined in generate/uuid5.ts:59</li>
133+
</ul>
134+
</aside>
135+
</section>
136+
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
137+
<a name="URL" class="tsd-anchor"></a>
138+
<h3>URL</h3>
139+
<div class="tsd-signature tsd-kind-icon">URL<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;6ba7b811-9dad-11d1-80b4-00c04fd430c8&quot;</span></div>
140+
<aside class="tsd-sources">
141+
<ul>
142+
<li>Defined in generate/uuid5.ts:60</li>
143+
</ul>
144+
</aside>
145+
</section>
146+
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
147+
<a name="X500" class="tsd-anchor"></a>
148+
<h3>X500</h3>
149+
<div class="tsd-signature tsd-kind-icon">X500<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;6ba7b814-9dad-11d1-80b4-00c04fd430c8&quot;</span></div>
150+
<aside class="tsd-sources">
151+
<ul>
152+
<li>Defined in generate/uuid5.ts:61</li>
153+
</ul>
154+
</aside>
155+
</section>
156+
</section>
157+
<!--{&quot;options&quot;:&quot;D:\\r37r0m0d3l\\corefunc\\v8\\typedoc.json&quot;,&quot;tsconfig&quot;:&quot;D:\\r37r0m0d3l\\corefunc\\v8&quot;,&quot;packages&quot;:[],&quot;entryPoints&quot;:[&quot;D:\\r37r0m0d3l\\corefunc\\v8\\base64\\index.ts&quot;,&quot;D:\\r37r0m0d3l\\corefunc\\v8\\clone\\index.ts&quot;,&quot;D:\\r37r0m0d3l\\corefunc\\v8\\deserialize\\index.ts&quot;,&quot;D:\\r37r0m0d3l\\corefunc\\v8\\generate\\index.ts&quot;,&quot;D:\\r37r0m0d3l\\corefunc\\v8\\serialize\\index.ts&quot;],&quot;exclude&quot;:[&quot;**/*+(index|.spec|.e2e).ts&quot;],&quot;externalPattern&quot;:[&quot;D:\\r37r0m0d3l\\corefunc\\v8\\**\\*.ts&quot;],&quot;excludeExternals&quot;:false,&quot;excludeNotDocumented&quot;:false,&quot;excludeInternal&quot;:false,&quot;excludePrivate&quot;:false,&quot;excludeProtected&quot;:false,&quot;disableSources&quot;:false,&quot;includes&quot;:&quot;&quot;,&quot;media&quot;:&quot;&quot;,&quot;watch&quot;:false,&quot;preserveWatchOutput&quot;:false,&quot;emit&quot;:false,&quot;out&quot;:&quot;D:\\r37r0m0d3l\\corefunc\\v8\\docs&quot;,&quot;json&quot;:&quot;&quot;,&quot;pretty&quot;:true,&quot;theme&quot;:&quot;./node_modules/typedoc-neo-theme/bin/default&quot;,&quot;highlightTheme&quot;:&quot;light-plus&quot;,&quot;name&quot;:&quot;&quot;,&quot;includeVersion&quot;:false,&quot;excludeTags&quot;:[],&quot;readme&quot;:&quot;&quot;,&quot;defaultCategory&quot;:&quot;Other&quot;,&quot;categoryOrder&quot;:[],&quot;categorizeByGroup&quot;:true,&quot;sort&quot;:[&quot;kind&quot;,&quot;instance-first&quot;,&quot;alphabetical&quot;],&quot;gitRevision&quot;:&quot;&quot;,&quot;gitRemote&quot;:&quot;origin&quot;,&quot;gaID&quot;:&quot;&quot;,&quot;gaSite&quot;:&quot;auto&quot;,&quot;hideGenerator&quot;:false,&quot;toc&quot;:[],&quot;disableOutputCheck&quot;:false,&quot;help&quot;:false,&quot;version&quot;:false,&quot;showConfig&quot;:false,&quot;plugin&quot;:[],&quot;logger&quot;:&quot;console&quot;,&quot;logLevel&quot;:1,&quot;treatWarningsAsErrors&quot;:false,&quot;listInvalidSymbolLinks&quot;:false}-->
158+
</div>
159+
<div class="col-2 col-menu secondary-menu">
160+
<nav class="tsd-navigation secondary menu-sticky">
161+
<ul class="before-current">
162+
</ul>
163+
<ul class="current">
164+
<li class="current tsd-kind-enum tsd-parent-kind-module tsd-is-external root">
165+
<a href="generate.NAMESPACE.html" class="tsd-kind-icon">NAMESPACE</a>
166+
<ul>
167+
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
168+
<a href="generate.NAMESPACE.html#DNS" class="tsd-kind-icon">DNS</a>
169+
</li>
170+
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
171+
<a href="generate.NAMESPACE.html#OID" class="tsd-kind-icon">OID</a>
172+
</li>
173+
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
174+
<a href="generate.NAMESPACE.html#URL" class="tsd-kind-icon">URL</a>
175+
</li>
176+
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
177+
<a href="generate.NAMESPACE.html#X500" class="tsd-kind-icon">X500</a>
178+
</li>
179+
</ul>
180+
</li>
181+
</ul>
182+
<ul class="after-current">
183+
<li class=" tsd-kind-variable tsd-parent-kind-module tsd-is-external root">
184+
<a href="../modules/generate.html#generateUuid4" class="tsd-kind-icon">generate<wbr>Uuid4</a>
185+
</li>
186+
<li class=" tsd-kind-function tsd-parent-kind-module tsd-is-external root">
187+
<a href="../modules/generate.html#generateNumber" class="tsd-kind-icon">generate<wbr>Number</a>
188+
</li>
189+
<li class=" tsd-kind-function tsd-parent-kind-module tsd-is-external root">
190+
<a href="../modules/generate.html#generateUuid5" class="tsd-kind-icon">generate<wbr>Uuid5</a>
191+
</li>
192+
</ul>
193+
</nav>
194+
</div>
195+
</div>
196+
</div>
197+
<footer class="with-border-bottom">
198+
</footer>
199+
<div class="container tsd-generator">
200+
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
201+
</div>
202+
<div class="overlay"></div>
203+
<script src="../assets/js/main.js"></script>
204+
</body>
205+
</html>

‎docs/index.html

Lines changed: 0 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -105,9 +105,6 @@ <h2>Reference</h2>
105105
<a href="#quotbase64quot" id="quotbase64quot" style="color: inherit; text-decoration: none;">
106106
<h3>&quot;Base64&quot;</h3>
107107
</a>
108-
<a href="#base64decode" id="base64decode" style="color: inherit; text-decoration: none;">
109-
<h4>base64Decode</h4>
110-
</a>
111108
<details>
112109
<summary><b>base64Decode(base64Text, encoding, start, end)</b></summary>
113110
Decodes to a string according to the specified character encoding in encoding.
@@ -120,9 +117,6 @@ <h4>base64Decode</h4>
120117
<a href="#quotclonequot" id="quotclonequot" style="color: inherit; text-decoration: none;">
121118
<h3>&quot;Clone&quot;</h3>
122119
</a>
123-
<a href="#clone" id="clone" style="color: inherit; text-decoration: none;">
124-
<h4>clone</h4>
125-
</a>
126120
<details>
127121
<summary><b>clone(value, setPrototype)</b></summary>
128122
Deep clone object. Note: don't use on objects containing Functions.
@@ -194,9 +188,6 @@ <h4>clone</h4>
194188
<span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #001080">beta</span><span style="color: #000000">.</span><span style="color: #001080">message</span><span style="color: #000000">);</span>
195189
</code></pre>
196190
</details>
197-
<a href="#clonemarshalling" id="clonemarshalling" style="color: inherit; text-decoration: none;">
198-
<h4>cloneMarshalling</h4>
199-
</a>
200191
<details>
201192
<summary><b>cloneMarshalling(value)</b></summary>
202193
Deep clone object and sets the prototype. Note: don't use on objects containing Functions.
@@ -219,9 +210,6 @@ <h4>cloneMarshalling</h4>
219210
<span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #001080">omegaTwo</span><span style="color: #000000">);</span>
220211
</code></pre>
221212
</details>
222-
<a href="#cloneshallow" id="cloneshallow" style="color: inherit; text-decoration: none;">
223-
<h4>cloneShallow</h4>
224-
</a>
225213
<details>
226214
<summary><b>cloneShallow(value)</b></summary>
227215
Deep clone any object to plain object.
@@ -247,9 +235,6 @@ <h4>cloneShallow</h4>
247235
<a href="#quotdeserializequot" id="quotdeserializequot" style="color: inherit; text-decoration: none;">
248236
<h3>&quot;Deserialize&quot;</h3>
249237
</a>
250-
<a href="#deserializefromstring" id="deserializefromstring" style="color: inherit; text-decoration: none;">
251-
<h4>deserializeFromString</h4>
252-
</a>
253238
<details>
254239
<summary><b>deserializeFromString(binaryString)</b></summary>
255240
Deserialize string to object value.
@@ -274,9 +259,6 @@ <h4>deserializeFromString</h4>
274259
<a href="#quotgeneratequot" id="quotgeneratequot" style="color: inherit; text-decoration: none;">
275260
<h3>&quot;Generate&quot;</h3>
276261
</a>
277-
<a href="#generatenumber" id="generatenumber" style="color: inherit; text-decoration: none;">
278-
<h4>generateNumber</h4>
279-
</a>
280262
<details>
281263
<summary><b>generateNumber(minimum, maximum)</b></summary>
282264
Secure random number generator. Integers only.
@@ -289,9 +271,6 @@ <h4>generateNumber</h4>
289271
<span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #001080">integer</span><span style="color: #000000">);</span>
290272
</code></pre>
291273
</details>
292-
<a href="#generateuuid4" id="generateuuid4" style="color: inherit; text-decoration: none;">
293-
<h4>generateUuid4</h4>
294-
</a>
295274
<details>
296275
<summary><b>generateUuid4()</b></summary>
297276
Generates a random RFC 4122 version 4 UUID.
@@ -303,9 +282,6 @@ <h4>generateUuid4</h4>
303282
<span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #795E26">generateUuid4</span><span style="color: #000000">());</span>
304283
</code></pre>
305284
</details>
306-
<a href="#generateuuid5" id="generateuuid5" style="color: inherit; text-decoration: none;">
307-
<h4>generateUuid5</h4>
308-
</a>
309285
<details>
310286
<summary><b>generateUuid5()</b></summary>
311287
Generates a RFC 4122 version 5 UUID.
@@ -322,9 +298,6 @@ <h4>generateUuid5</h4>
322298
<a href="#quotserializequot" id="quotserializequot" style="color: inherit; text-decoration: none;">
323299
<h3>&quot;Serialize&quot;</h3>
324300
</a>
325-
<a href="#serializetostring" id="serializetostring" style="color: inherit; text-decoration: none;">
326-
<h4>serializeToString</h4>
327-
</a>
328301
<details>
329302
<summary><b>serializeToString(value)</b></summary>
330303
Serialize value to binary string.

0 commit comments

Comments
 (0)