Skip to content

Commit 20011df

Browse files
actions-useractions-user
committed
docs: Generate documentation.
1 parent f7bdaa9 commit 20011df

51 files changed

Lines changed: 30402 additions & 0 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs-release/assets/css/main.css‎

Lines changed: 2609 additions & 0 deletions
Large diffs are not rendered by default.

‎docs-release/assets/images/icons.png‎

9.39 KB
Loading

‎docs-release/assets/images/icons@2x.png‎

27.5 KB
Loading

‎docs-release/assets/images/widgets.png‎

8.43 KB
Loading

‎docs-release/assets/images/widgets@2x.png‎

7.63 KB
Loading

‎docs-release/assets/js/main.js‎

Lines changed: 248 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs-release/assets/js/search.js‎

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs-release/classes/AdvancedClient.html‎

Lines changed: 2429 additions & 0 deletions
Large diffs are not rendered by default.

‎docs-release/classes/Argument.html‎

Lines changed: 268 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,268 @@
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>Argument
7+
| Advanced Command-Handler - v3.0.0</title>
8+
<meta name="description" content="Documentation for Advanced Command-Handler - v3.0.0">
9+
<meta name="viewport" content="width=device-width, initial-scale=1">
10+
<link rel="stylesheet" href="../assets/css/main.css">
11+
<script async src="../assets/js/search.js" id="search-script"></script>
12+
</head>
13+
<body>
14+
<header>
15+
<div class="tsd-page-toolbar">
16+
<div class="container">
17+
<div class="table-wrap">
18+
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json"
19+
data-base="..">
20+
<div class="field">
21+
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
22+
<input id="tsd-search-field" type="text" />
23+
</div>
24+
<ul class="results">
25+
<li class="state loading">Preparing search index...</li>
26+
<li class="state failure">The search index is not available</li>
27+
</ul>
28+
<a href="../index.html" class="title">Advanced Command-Handler - v3.0.0</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+
</div>
47+
</div>
48+
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
49+
</div>
50+
</div>
51+
</div>
52+
</div>
53+
<div class="tsd-page-title">
54+
<div class="container">
55+
<ul class="tsd-breadcrumb">
56+
<li>
57+
<a href="../modules.html">Advanced Command-Handler - v3.0.0</a>
58+
</li>
59+
<li>
60+
<a href="Argument.html">Argument</a>
61+
</li>
62+
</ul>
63+
<h1>Class Argument&lt;T&gt;</h1>
64+
</div>
65+
</div>
66+
</header>
67+
<div class="container container-main">
68+
<div class="row">
69+
<div class="col-8 col-content">
70+
<section class="tsd-panel tsd-type-parameters">
71+
<h3>Type parameters</h3>
72+
<ul class="tsd-type-parameters">
73+
<li>
74+
<h4>T</h4>
75+
</li>
76+
</ul>
77+
</section>
78+
<section class="tsd-panel tsd-hierarchy">
79+
<h3>Hierarchy</h3>
80+
<ul class="tsd-hierarchy">
81+
<li>
82+
<span class="target">Argument</span>
83+
</li>
84+
</ul>
85+
</section>
86+
<section class="tsd-panel-group tsd-index-group">
87+
<h2>Index</h2>
88+
<section class="tsd-panel tsd-index-panel">
89+
<div class="tsd-index-content">
90+
<section class="tsd-index-section ">
91+
<h3>Constructors</h3>
92+
<ul class="tsd-index-list">
93+
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter"><a href="Argument.html#constructor"
94+
class="tsd-kind-icon">constructor</a></li>
95+
</ul>
96+
</section>
97+
<section class="tsd-index-section ">
98+
<h3>Properties</h3>
99+
<ul class="tsd-index-list">
100+
<li class="tsd-kind-property tsd-parent-kind-class"><a href="Argument.html#options"
101+
class="tsd-kind-icon">options</a></li>
102+
<li class="tsd-kind-property tsd-parent-kind-class"><a href="Argument.html#parser"
103+
class="tsd-kind-icon">parser</a></li>
104+
<li class="tsd-kind-property tsd-parent-kind-class"><a href="Argument.html#type"
105+
class="tsd-kind-icon">type</a></li>
106+
<li class="tsd-kind-property tsd-parent-kind-class"><a href="Argument.html#validator"
107+
class="tsd-kind-icon">validator</a></li>
108+
</ul>
109+
</section>
110+
</div>
111+
</section>
112+
</section>
113+
<section class="tsd-panel-group tsd-member-group ">
114+
<h2>Constructors</h2>
115+
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter">
116+
<a name="constructor" class="tsd-anchor"></a>
117+
<h3>constructor</h3>
118+
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter">
119+
<li class="tsd-signature tsd-kind-icon">new <wbr>Argument&lt;T&gt;<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><a href="../enums/ArgumentType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">ArgumentType</a>, options<span class="tsd-signature-symbol">: </span><a href="../interfaces/ArgumentOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ArgumentOptions</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span>, validator<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArgumentValidator</span>, parser<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArgumentParser</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Argument.html" class="tsd-signature-type" data-tsd-kind="Class">Argument</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></li>
120+
</ul>
121+
<ul class="tsd-descriptions">
122+
<li class="tsd-description">
123+
<aside class="tsd-sources">
124+
<ul>
125+
<li>Defined in <a href="https://github.com/Advanced-Command-Handler/Advanced-Command-Handler/tree/master/src/classes/arguments/Argument.ts#L52">source/src/classes/arguments/Argument.ts:52</a></li>
126+
</ul>
127+
</aside>
128+
<h4 class="tsd-type-parameters-title">Type parameters</h4>
129+
<ul class="tsd-type-parameters">
130+
<li>
131+
<h4>T</h4>
132+
</li>
133+
</ul>
134+
<h4 class="tsd-parameters-title">Parameters</h4>
135+
<ul class="tsd-parameters">
136+
<li>
137+
<h5>type: <a href="../enums/ArgumentType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">ArgumentType</a></h5>
138+
</li>
139+
<li>
140+
<h5>options: <a href="../interfaces/ArgumentOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ArgumentOptions</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h5>
141+
</li>
142+
<li>
143+
<h5>validator: <span class="tsd-signature-type">ArgumentValidator</span></h5>
144+
</li>
145+
<li>
146+
<h5>parser: <span class="tsd-signature-type">ArgumentParser</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h5>
147+
</li>
148+
</ul>
149+
<h4 class="tsd-returns-title">Returns <a href="Argument.html" class="tsd-signature-type" data-tsd-kind="Class">Argument</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h4>
150+
</li>
151+
</ul>
152+
</section>
153+
</section>
154+
<section class="tsd-panel-group tsd-member-group ">
155+
<h2>Properties</h2>
156+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
157+
<a name="options" class="tsd-anchor"></a>
158+
<h3>options</h3>
159+
<div class="tsd-signature tsd-kind-icon">options<span class="tsd-signature-symbol">:</span> <a href="../interfaces/ArgumentOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ArgumentOptions</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></div>
160+
<aside class="tsd-sources">
161+
</aside>
162+
</section>
163+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
164+
<a name="parser" class="tsd-anchor"></a>
165+
<h3>parser</h3>
166+
<div class="tsd-signature tsd-kind-icon">parser<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ArgumentParser</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></div>
167+
<aside class="tsd-sources">
168+
</aside>
169+
</section>
170+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
171+
<a name="type" class="tsd-anchor"></a>
172+
<h3>type</h3>
173+
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../enums/ArgumentType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">ArgumentType</a></div>
174+
<aside class="tsd-sources">
175+
</aside>
176+
</section>
177+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
178+
<a name="validator" class="tsd-anchor"></a>
179+
<h3>validator</h3>
180+
<div class="tsd-signature tsd-kind-icon">validator<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ArgumentValidator</span></div>
181+
<aside class="tsd-sources">
182+
</aside>
183+
</section>
184+
</section>
185+
</div>
186+
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
187+
<nav class="tsd-navigation primary">
188+
<ul>
189+
<li class=" ">
190+
<a href="../modules.html">Exports</a>
191+
</li>
192+
</ul>
193+
</nav>
194+
<nav class="tsd-navigation secondary menu-sticky">
195+
<ul class="before-current">
196+
</ul>
197+
<ul class="current">
198+
<li class="current tsd-kind-class tsd-has-type-parameter">
199+
<a href="Argument.html" class="tsd-kind-icon">Argument</a>
200+
<ul>
201+
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter">
202+
<a href="Argument.html#constructor" class="tsd-kind-icon">constructor</a>
203+
</li>
204+
<li class=" tsd-kind-property tsd-parent-kind-class">
205+
<a href="Argument.html#options" class="tsd-kind-icon">options</a>
206+
</li>
207+
<li class=" tsd-kind-property tsd-parent-kind-class">
208+
<a href="Argument.html#parser" class="tsd-kind-icon">parser</a>
209+
</li>
210+
<li class=" tsd-kind-property tsd-parent-kind-class">
211+
<a href="Argument.html#type" class="tsd-kind-icon">type</a>
212+
</li>
213+
<li class=" tsd-kind-property tsd-parent-kind-class">
214+
<a href="Argument.html#validator" class="tsd-kind-icon">validator</a>
215+
</li>
216+
</ul>
217+
</li>
218+
</ul>
219+
<ul class="after-current">
220+
</ul>
221+
</nav>
222+
</div>
223+
</div>
224+
</div>
225+
<footer class="with-border-bottom">
226+
<div class="container">
227+
<h2>Legend</h2>
228+
<div class="tsd-legend-group">
229+
<ul class="tsd-legend">
230+
<li class="tsd-kind-constructor tsd-parent-kind-class"><span
231+
class="tsd-kind-icon">Constructor</span></li>
232+
<li class="tsd-kind-property tsd-parent-kind-class"><span
233+
class="tsd-kind-icon">Property</span></li>
234+
<li class="tsd-kind-method tsd-parent-kind-class"><span
235+
class="tsd-kind-icon">Method</span></li>
236+
</ul>
237+
<ul class="tsd-legend">
238+
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span
239+
class="tsd-kind-icon">Inherited constructor</span></li>
240+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span
241+
class="tsd-kind-icon">Inherited property</span></li>
242+
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span
243+
class="tsd-kind-icon">Inherited method</span></li>
244+
</ul>
245+
<ul class="tsd-legend">
246+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span
247+
class="tsd-kind-icon">Static property</span></li>
248+
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span
249+
class="tsd-kind-icon">Static method</span></li>
250+
</ul>
251+
<ul class="tsd-legend">
252+
<li class="tsd-kind-property tsd-parent-kind-interface"><span
253+
class="tsd-kind-icon">Property</span></li>
254+
</ul>
255+
<ul class="tsd-legend">
256+
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span
257+
class="tsd-kind-icon">Protected method</span></li>
258+
</ul>
259+
</div>
260+
</div>
261+
</footer>
262+
<div class="container tsd-generator">
263+
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
264+
</div>
265+
<div class="overlay"></div>
266+
<script src="../assets/js/main.js"></script>
267+
</body>
268+
</html>

0 commit comments

Comments
 (0)