Skip to content

Commit f7bdaa9

Browse files
committed
docs: Generate documentation.
1 parent 0b2319c commit f7bdaa9

4 files changed

Lines changed: 63 additions & 38 deletions

File tree

docs-master/assets/js/search.js

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

docs-master/classes/ArgumentContext.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1111,7 +1111,7 @@ <h3>current<wbr>Argument</h3>
11111111
<div class="tsd-signature tsd-kind-icon">current<wbr>Argument<span class="tsd-signature-symbol">:</span> <a href="CommandArgument.html" class="tsd-signature-type" data-tsd-kind="Class">CommandArgument</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></div>
11121112
<aside class="tsd-sources">
11131113
<ul>
1114-
<li>Defined in <a href="https://github.com/Advanced-Command-Handler/Advanced-Command-Handler/tree/master/src/classes/contexts/ArgumentContext.ts#L15">source/src/classes/contexts/ArgumentContext.ts:15</a></li>
1114+
<li>Defined in <a href="https://github.com/Advanced-Command-Handler/Advanced-Command-Handler/tree/master/src/classes/contexts/ArgumentContext.ts#L21">source/src/classes/contexts/ArgumentContext.ts:21</a></li>
11151115
</ul>
11161116
</aside>
11171117
<div class="tsd-comment tsd-typography">
@@ -1142,7 +1142,7 @@ <h3>index</h3>
11421142
<div class="tsd-signature tsd-kind-icon">index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
11431143
<aside class="tsd-sources">
11441144
<ul>
1145-
<li>Defined in <a href="https://github.com/Advanced-Command-Handler/Advanced-Command-Handler/tree/master/src/classes/contexts/ArgumentContext.ts#L19">source/src/classes/contexts/ArgumentContext.ts:19</a></li>
1145+
<li>Defined in <a href="https://github.com/Advanced-Command-Handler/Advanced-Command-Handler/tree/master/src/classes/contexts/ArgumentContext.ts#L25">source/src/classes/contexts/ArgumentContext.ts:25</a></li>
11461146
</ul>
11471147
</aside>
11481148
<div class="tsd-comment tsd-typography">
@@ -1197,7 +1197,7 @@ <h3>constructor</h3>
11971197
<aside class="tsd-sources">
11981198
<p>Overrides <a href="CommandContext.html">CommandContext</a>.<a href="CommandContext.html#constructor">constructor</a></p>
11991199
<ul>
1200-
<li>Defined in <a href="https://github.com/Advanced-Command-Handler/Advanced-Command-Handler/tree/master/src/classes/contexts/ArgumentContext.ts#L26">source/src/classes/contexts/ArgumentContext.ts:26</a></li>
1200+
<li>Defined in <a href="https://github.com/Advanced-Command-Handler/Advanced-Command-Handler/tree/master/src/classes/contexts/ArgumentContext.ts#L32">source/src/classes/contexts/ArgumentContext.ts:32</a></li>
12011201
</ul>
12021202
</aside>
12031203
<div class="tsd-comment tsd-typography">

docs-master/interfaces/CommandHandler.LaunchCommandHandlerOptions.html

Lines changed: 31 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,8 @@ <h2>Index</h2>
9292
<section class="tsd-index-section ">
9393
<h3>Properties</h3>
9494
<ul class="tsd-index-list">
95+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="CommandHandler.LaunchCommandHandlerOptions.html#addBotAndTeamOwnersToOwners"
96+
class="tsd-kind-icon">add<wbr>Bot<wbr>And<wbr>Team<wbr>Owners<wbr>ToOwners</a></li>
9597
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="CommandHandler.LaunchCommandHandlerOptions.html#clientOptions"
9698
class="tsd-kind-icon">client<wbr>Options</a></li>
9799
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="CommandHandler.LaunchCommandHandlerOptions.html#cycleBetweenPresences"
@@ -111,13 +113,33 @@ <h3>Properties</h3>
111113
</section>
112114
<section class="tsd-panel-group tsd-member-group ">
113115
<h2>Properties</h2>
116+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
117+
<a name="addBotAndTeamOwnersToOwners" class="tsd-anchor"></a>
118+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> add<wbr>Bot<wbr>And<wbr>Team<wbr>Owners<wbr>ToOwners</h3>
119+
<div class="tsd-signature tsd-kind-icon">add<wbr>Bot<wbr>And<wbr>Team<wbr>Owners<wbr>ToOwners<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
120+
<aside class="tsd-sources">
121+
<ul>
122+
<li>Defined in <a href="https://github.com/Advanced-Command-Handler/Advanced-Command-Handler/tree/master/src/CommandHandler.ts#L156">source/src/CommandHandler.ts:156</a></li>
123+
</ul>
124+
</aside>
125+
<div class="tsd-comment tsd-typography">
126+
<div class="lead">
127+
<p>Whether to add the bot owner or the team members (if bot is from a team) to the <a href="../modules/CommandHandler.html#owners">owners</a>.</p>
128+
</div>
129+
<dl class="tsd-comment-tags">
130+
<dt>defaultvalue</dt>
131+
<dd><p>true</p>
132+
</dd>
133+
</dl>
134+
</div>
135+
</section>
114136
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
115137
<a name="clientOptions" class="tsd-anchor"></a>
116138
<h3>client<wbr>Options</h3>
117139
<div class="tsd-signature tsd-kind-icon">client<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ClientOptions</span></div>
118140
<aside class="tsd-sources">
119141
<ul>
120-
<li>Defined in <a href="https://github.com/Advanced-Command-Handler/Advanced-Command-Handler/tree/master/src/CommandHandler.ts#L154">source/src/CommandHandler.ts:154</a></li>
142+
<li>Defined in <a href="https://github.com/Advanced-Command-Handler/Advanced-Command-Handler/tree/master/src/CommandHandler.ts#L160">source/src/CommandHandler.ts:160</a></li>
121143
</ul>
122144
</aside>
123145
<div class="tsd-comment tsd-typography">
@@ -132,7 +154,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> cycle<wbr>Between<wbr
132154
<div class="tsd-signature tsd-kind-icon">cycle<wbr>Between<wbr>Presences<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
133155
<aside class="tsd-sources">
134156
<ul>
135-
<li>Defined in <a href="https://github.com/Advanced-Command-Handler/Advanced-Command-Handler/tree/master/src/CommandHandler.ts#L160">source/src/CommandHandler.ts:160</a></li>
157+
<li>Defined in <a href="https://github.com/Advanced-Command-Handler/Advanced-Command-Handler/tree/master/src/CommandHandler.ts#L166">source/src/CommandHandler.ts:166</a></li>
136158
</ul>
137159
</aside>
138160
<div class="tsd-comment tsd-typography">
@@ -152,7 +174,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> cycle<wbr>Duration</h
152174
<div class="tsd-signature tsd-kind-icon">cycle<wbr>Duration<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
153175
<aside class="tsd-sources">
154176
<ul>
155-
<li>Defined in <a href="https://github.com/Advanced-Command-Handler/Advanced-Command-Handler/tree/master/src/CommandHandler.ts#L166">source/src/CommandHandler.ts:166</a></li>
177+
<li>Defined in <a href="https://github.com/Advanced-Command-Handler/Advanced-Command-Handler/tree/master/src/CommandHandler.ts#L172">source/src/CommandHandler.ts:172</a></li>
156178
</ul>
157179
</aside>
158180
<div class="tsd-comment tsd-typography">
@@ -172,7 +194,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> presence</h3>
172194
<div class="tsd-signature tsd-kind-icon">presence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PresenceData</span></div>
173195
<aside class="tsd-sources">
174196
<ul>
175-
<li>Defined in <a href="https://github.com/Advanced-Command-Handler/Advanced-Command-Handler/tree/master/src/CommandHandler.ts#L173">source/src/CommandHandler.ts:173</a></li>
197+
<li>Defined in <a href="https://github.com/Advanced-Command-Handler/Advanced-Command-Handler/tree/master/src/CommandHandler.ts#L179">source/src/CommandHandler.ts:179</a></li>
176198
</ul>
177199
</aside>
178200
<div class="tsd-comment tsd-typography">
@@ -192,7 +214,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> presences</h3>
192214
<div class="tsd-signature tsd-kind-icon">presences<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PresenceData</span><span class="tsd-signature-symbol">[]</span></div>
193215
<aside class="tsd-sources">
194216
<ul>
195-
<li>Defined in <a href="https://github.com/Advanced-Command-Handler/Advanced-Command-Handler/tree/master/src/CommandHandler.ts#L180">source/src/CommandHandler.ts:180</a></li>
217+
<li>Defined in <a href="https://github.com/Advanced-Command-Handler/Advanced-Command-Handler/tree/master/src/CommandHandler.ts#L186">source/src/CommandHandler.ts:186</a></li>
196218
</ul>
197219
</aside>
198220
<div class="tsd-comment tsd-typography">
@@ -212,7 +234,7 @@ <h3>token</h3>
212234
<div class="tsd-signature tsd-kind-icon">token<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
213235
<aside class="tsd-sources">
214236
<ul>
215-
<li>Defined in <a href="https://github.com/Advanced-Command-Handler/Advanced-Command-Handler/tree/master/src/CommandHandler.ts#L184">source/src/CommandHandler.ts:184</a></li>
237+
<li>Defined in <a href="https://github.com/Advanced-Command-Handler/Advanced-Command-Handler/tree/master/src/CommandHandler.ts#L190">source/src/CommandHandler.ts:190</a></li>
216238
</ul>
217239
</aside>
218240
<div class="tsd-comment tsd-typography">
@@ -259,6 +281,9 @@ <h3>token</h3>
259281
<li class="current tsd-kind-interface tsd-parent-kind-namespace">
260282
<a href="CommandHandler.LaunchCommandHandlerOptions.html" class="tsd-kind-icon">Launch<wbr>Command<wbr>Handler<wbr>Options</a>
261283
<ul>
284+
<li class=" tsd-kind-property tsd-parent-kind-interface">
285+
<a href="CommandHandler.LaunchCommandHandlerOptions.html#addBotAndTeamOwnersToOwners" class="tsd-kind-icon">add<wbr>Bot<wbr>And<wbr>Team<wbr>Owners<wbr>ToOwners</a>
286+
</li>
262287
<li class=" tsd-kind-property tsd-parent-kind-interface">
263288
<a href="CommandHandler.LaunchCommandHandlerOptions.html#clientOptions" class="tsd-kind-icon">client<wbr>Options</a>
264289
</li>

0 commit comments

Comments
 (0)