Skip to content
This repository has been archived by the owner on Jun 25, 2023. It is now read-only.

Commit

Permalink
Generate Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
GitHub Documentation Bot committed May 12, 2022
1 parent 0294720 commit 8316237
Show file tree
Hide file tree
Showing 19 changed files with 498 additions and 70 deletions.
2 changes: 1 addition & 1 deletion docs/assets/js/search.js
View file

Large diffs are not rendered by default.

376 changes: 376 additions & 0 deletions docs/classes/AttachmentField.html
View file

Large diffs are not rendered by default.

9 changes: 6 additions & 3 deletions docs/classes/BooleanField.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ <h3>constructor</h3>
<aside class="tsd-sources">
<p>Inherited from FieldBuilder.constructor</p>
<ul>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/4f69012/src/structures/field.ts#L29">structures/field.ts:29</a></li>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/0294720/src/structures/field.ts#L29">structures/field.ts:29</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -203,7 +203,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3>
<aside class="tsd-sources">
<p>Overrides FieldBuilder.type</p>
<ul>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/4f69012/src/structures/field.ts#L62">structures/field.ts:62</a></li>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/0294720/src/structures/field.ts#L62">structures/field.ts:62</a></li>
</ul>
</aside>
</section>
Expand All @@ -220,7 +220,7 @@ <h3>raw<wbr>Data</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/4f69012/src/structures/field.ts#L39">structures/field.ts:39</a></li>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/0294720/src/structures/field.ts#L39">structures/field.ts:39</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -261,6 +261,9 @@ <h5>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-t
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class">
<a href="AttachmentField.html" class="tsd-kind-icon">Attachment<wbr>Field</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-class">
Expand Down
9 changes: 6 additions & 3 deletions docs/classes/ChannelField.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ <h3>constructor</h3>
<aside class="tsd-sources">
<p>Inherited from FieldBuilder.constructor</p>
<ul>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/4f69012/src/structures/field.ts#L29">structures/field.ts:29</a></li>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/0294720/src/structures/field.ts#L29">structures/field.ts:29</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -203,7 +203,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3>
<aside class="tsd-sources">
<p>Overrides FieldBuilder.type</p>
<ul>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/4f69012/src/structures/field.ts#L72">structures/field.ts:72</a></li>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/0294720/src/structures/field.ts#L72">structures/field.ts:72</a></li>
</ul>
</aside>
</section>
Expand All @@ -220,7 +220,7 @@ <h3>raw<wbr>Data</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/4f69012/src/structures/field.ts#L39">structures/field.ts:39</a></li>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/0294720/src/structures/field.ts#L39">structures/field.ts:39</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -261,6 +261,9 @@ <h5>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-t
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class">
<a href="AttachmentField.html" class="tsd-kind-icon">Attachment<wbr>Field</a>
</li>
<li class=" tsd-kind-class">
<a href="BooleanField.html" class="tsd-kind-icon">Boolean<wbr>Field</a>
</li>
Expand Down
25 changes: 14 additions & 11 deletions docs/classes/Command.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -126,20 +126,20 @@ <h2>Constructors</h2>
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">new <wbr>Command<span class="tsd-signature-symbol">(</span>_options<span class="tsd-signature-symbol">?: </span><a href="../modules.html#FieldType" class="tsd-signature-type" data-tsd-kind="Type alias">FieldType</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><a href="Subcommand.html" class="tsd-signature-type" data-tsd-kind="Class">Subcommand</a><span class="tsd-signature-symbol"> | </span><a href="SubcommandGroup.html" class="tsd-signature-type" data-tsd-kind="Class">SubcommandGroup</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a></li>
<li class="tsd-signature tsd-kind-icon">new <wbr>Command<span class="tsd-signature-symbol">(</span>_options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><a href="SubcommandGroup.html" class="tsd-signature-type" data-tsd-kind="Class">SubcommandGroup</a><span class="tsd-signature-symbol"> | </span><a href="Subcommand.html" class="tsd-signature-type" data-tsd-kind="Class">Subcommand</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#FieldType" class="tsd-signature-type" data-tsd-kind="Type alias">FieldType</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from SlashCommandBuilder&lt;(SubcommandGroup | Subcommand)[] | FieldType[]&gt;.constructor</p>
<ul>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/4f69012/src/structures/slash-command.ts#L39">structures/slash-command.ts:39</a></li>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/0294720/src/structures/slash-command.ts#L39">structures/slash-command.ts:39</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>_options: <a href="../modules.html#FieldType" class="tsd-signature-type" data-tsd-kind="Type alias">FieldType</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><a href="Subcommand.html" class="tsd-signature-type" data-tsd-kind="Class">Subcommand</a><span class="tsd-signature-symbol"> | </span><a href="SubcommandGroup.html" class="tsd-signature-type" data-tsd-kind="Class">SubcommandGroup</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></h5>
<h5>_options: <span class="tsd-signature-symbol">(</span><a href="SubcommandGroup.html" class="tsd-signature-type" data-tsd-kind="Class">SubcommandGroup</a><span class="tsd-signature-symbol"> | </span><a href="Subcommand.html" class="tsd-signature-type" data-tsd-kind="Class">Subcommand</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#FieldType" class="tsd-signature-type" data-tsd-kind="Type alias">FieldType</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol"> = []</span></h5>
<div class="tsd-comment tsd-typography">
<p>The options for the command.</p>
</div>
Expand All @@ -155,7 +155,7 @@ <h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="_options" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> _options</h3>
<div class="tsd-signature tsd-kind-icon">_options<span class="tsd-signature-symbol">:</span> <a href="../modules.html#FieldType" class="tsd-signature-type" data-tsd-kind="Type alias">FieldType</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><a href="Subcommand.html" class="tsd-signature-type" data-tsd-kind="Class">Subcommand</a><span class="tsd-signature-symbol"> | </span><a href="SubcommandGroup.html" class="tsd-signature-type" data-tsd-kind="Class">SubcommandGroup</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div>
<div class="tsd-signature tsd-kind-icon">_options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><a href="SubcommandGroup.html" class="tsd-signature-type" data-tsd-kind="Class">SubcommandGroup</a><span class="tsd-signature-symbol"> | </span><a href="Subcommand.html" class="tsd-signature-type" data-tsd-kind="Class">Subcommand</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#FieldType" class="tsd-signature-type" data-tsd-kind="Type alias">FieldType</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol"> = []</span></div>
<aside class="tsd-sources">
<p>Inherited from SlashCommandBuilder._options</p>
</aside>
Expand All @@ -167,7 +167,7 @@ <h3>description</h3>
<aside class="tsd-sources">
<p>Inherited from SlashCommandBuilder.description</p>
<ul>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/4f69012/src/structures/slash-command.ts#L15">structures/slash-command.ts:15</a></li>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/0294720/src/structures/slash-command.ts#L15">structures/slash-command.ts:15</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -183,7 +183,7 @@ <h3>name</h3>
<aside class="tsd-sources">
<p>Inherited from SlashCommandBuilder.name</p>
<ul>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/4f69012/src/structures/slash-command.ts#L11">structures/slash-command.ts:11</a></li>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/0294720/src/structures/slash-command.ts#L11">structures/slash-command.ts:11</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -195,11 +195,11 @@ <h3>name</h3>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="options" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> options</h3>
<div class="tsd-signature tsd-kind-icon">options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="Subcommand.html" class="tsd-signature-type" data-tsd-kind="Class">Subcommand</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#FieldType" class="tsd-signature-type" data-tsd-kind="Type alias">FieldType</a><span class="tsd-signature-symbol"> | </span><a href="SubcommandGroup.html" class="tsd-signature-type" data-tsd-kind="Class">SubcommandGroup</a><span class="tsd-signature-symbol">&gt;</span></div>
<div class="tsd-signature tsd-kind-icon">options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="SubcommandGroup.html" class="tsd-signature-type" data-tsd-kind="Class">SubcommandGroup</a><span class="tsd-signature-symbol"> | </span><a href="Subcommand.html" class="tsd-signature-type" data-tsd-kind="Class">Subcommand</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#FieldType" class="tsd-signature-type" data-tsd-kind="Type alias">FieldType</a><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<p>Inherited from SlashCommandBuilder.options</p>
<ul>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/4f69012/src/structures/slash-command.ts#L35">structures/slash-command.ts:35</a></li>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/0294720/src/structures/slash-command.ts#L35">structures/slash-command.ts:35</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -216,7 +216,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3>
<aside class="tsd-sources">
<p>Overrides SlashCommandBuilder.type</p>
<ul>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/4f69012/src/structures/slash-command.ts#L67">structures/slash-command.ts:67</a></li>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/0294720/src/structures/slash-command.ts#L67">structures/slash-command.ts:67</a></li>
</ul>
</aside>
</section>
Expand All @@ -233,7 +233,7 @@ <h3>raw<wbr>Data</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/4f69012/src/structures/slash-command.ts#L45">structures/slash-command.ts:45</a></li>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/0294720/src/structures/slash-command.ts#L45">structures/slash-command.ts:45</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -273,7 +273,7 @@ <h3>execute</h3>
<aside class="tsd-sources">
<p>Inherited from SlashCommandBuilder.execute</p>
<ul>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/4f69012/src/structures/slash-command.ts#L20">structures/slash-command.ts:20</a></li>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/0294720/src/structures/slash-command.ts#L20">structures/slash-command.ts:20</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -306,6 +306,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class">
<a href="AttachmentField.html" class="tsd-kind-icon">Attachment<wbr>Field</a>
</li>
<li class=" tsd-kind-class">
<a href="BooleanField.html" class="tsd-kind-icon">Boolean<wbr>Field</a>
</li>
Expand Down
9 changes: 6 additions & 3 deletions docs/classes/IntegerField.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ <h3>constructor</h3>
<aside class="tsd-sources">
<p>Inherited from FieldBuilder.constructor</p>
<ul>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/4f69012/src/structures/field.ts#L29">structures/field.ts:29</a></li>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/0294720/src/structures/field.ts#L29">structures/field.ts:29</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -203,7 +203,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3>
<aside class="tsd-sources">
<p>Overrides FieldBuilder.type</p>
<ul>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/4f69012/src/structures/field.ts#L57">structures/field.ts:57</a></li>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/0294720/src/structures/field.ts#L57">structures/field.ts:57</a></li>
</ul>
</aside>
</section>
Expand All @@ -220,7 +220,7 @@ <h3>raw<wbr>Data</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/4f69012/src/structures/field.ts#L39">structures/field.ts:39</a></li>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/0294720/src/structures/field.ts#L39">structures/field.ts:39</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -261,6 +261,9 @@ <h5>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-t
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class">
<a href="AttachmentField.html" class="tsd-kind-icon">Attachment<wbr>Field</a>
</li>
<li class=" tsd-kind-class">
<a href="BooleanField.html" class="tsd-kind-icon">Boolean<wbr>Field</a>
</li>
Expand Down
9 changes: 6 additions & 3 deletions docs/classes/InteractionsHandler.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> commands</h3>
<div class="tsd-signature tsd-kind-icon">commands<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">default</span><span class="tsd-signature-symbol"> = ...</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/4f69012/src/structures/interactions-handler.ts#L14">structures/interactions-handler.ts:14</a></li>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/0294720/src/structures/interactions-handler.ts#L16">structures/interactions-handler.ts:16</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -153,7 +153,7 @@ <h3>handle<wbr>Interaction</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/4f69012/src/structures/interactions-handler.ts#L19">structures/interactions-handler.ts:19</a></li>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/0294720/src/structures/interactions-handler.ts#L21">structures/interactions-handler.ts:21</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -184,7 +184,7 @@ <h3>load<wbr>Commands</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/4f69012/src/structures/interactions-handler.ts#L31">structures/interactions-handler.ts:31</a></li>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/0294720/src/structures/interactions-handler.ts#L33">structures/interactions-handler.ts:33</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -215,6 +215,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class">
<a href="AttachmentField.html" class="tsd-kind-icon">Attachment<wbr>Field</a>
</li>
<li class=" tsd-kind-class">
<a href="BooleanField.html" class="tsd-kind-icon">Boolean<wbr>Field</a>
</li>
Expand Down
Loading

0 comments on commit 8316237

Please sign in to comment.