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 Sep 24, 2021
1 parent a13d51e commit 08c96f9
Show file tree
Hide file tree
Showing 27 changed files with 367 additions and 151 deletions.
2 changes: 1 addition & 1 deletion docs/assets/js/search.js
View file

Large diffs are not rendered by default.

14 changes: 7 additions & 7 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 <a href="Field.html">Field</a>.<a href="Field.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/5392074/src/structures/field.ts#L44">structures/field.ts:44</a></li>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/a13d51e/src/structures/field.ts#L44">structures/field.ts:44</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -171,7 +171,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> choices</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="Field.html">Field</a>.<a href="Field.html#choices">choices</a></p>
<ul>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/5392074/src/structures/field.ts#L16">structures/field.ts:16</a></li>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/a13d51e/src/structures/field.ts#L16">structures/field.ts:16</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -187,7 +187,7 @@ <h3>description</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="Field.html">Field</a>.<a href="Field.html#description">description</a></p>
<ul>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/5392074/src/structures/field.ts#L12">structures/field.ts:12</a></li>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/a13d51e/src/structures/field.ts#L12">structures/field.ts:12</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -203,7 +203,7 @@ <h3>name</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="Field.html">Field</a>.<a href="Field.html#name">name</a></p>
<ul>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/5392074/src/structures/field.ts#L10">structures/field.ts:10</a></li>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/a13d51e/src/structures/field.ts#L10">structures/field.ts:10</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -219,7 +219,7 @@ <h3>required</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="Field.html">Field</a>.<a href="Field.html#required">required</a></p>
<ul>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/5392074/src/structures/field.ts#L14">structures/field.ts:14</a></li>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/a13d51e/src/structures/field.ts#L14">structures/field.ts:14</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -235,7 +235,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> <span class="tsd-fl
<aside class="tsd-sources">
<p>Overrides <a href="Field.html">Field</a>.<a href="Field.html#type">type</a></p>
<ul>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/5392074/src/structures/field.ts#L77">structures/field.ts:77</a></li>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/a13d51e/src/structures/field.ts#L77">structures/field.ts:77</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -257,7 +257,7 @@ <h3>data</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/5392074/src/structures/field.ts#L55">structures/field.ts:55</a></li>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/a13d51e/src/structures/field.ts#L55">structures/field.ts:55</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
14 changes: 7 additions & 7 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 <a href="Field.html">Field</a>.<a href="Field.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/5392074/src/structures/field.ts#L44">structures/field.ts:44</a></li>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/a13d51e/src/structures/field.ts#L44">structures/field.ts:44</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -171,7 +171,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> choices</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="Field.html">Field</a>.<a href="Field.html#choices">choices</a></p>
<ul>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/5392074/src/structures/field.ts#L16">structures/field.ts:16</a></li>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/a13d51e/src/structures/field.ts#L16">structures/field.ts:16</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -187,7 +187,7 @@ <h3>description</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="Field.html">Field</a>.<a href="Field.html#description">description</a></p>
<ul>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/5392074/src/structures/field.ts#L12">structures/field.ts:12</a></li>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/a13d51e/src/structures/field.ts#L12">structures/field.ts:12</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -203,7 +203,7 @@ <h3>name</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="Field.html">Field</a>.<a href="Field.html#name">name</a></p>
<ul>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/5392074/src/structures/field.ts#L10">structures/field.ts:10</a></li>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/a13d51e/src/structures/field.ts#L10">structures/field.ts:10</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -219,7 +219,7 @@ <h3>required</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="Field.html">Field</a>.<a href="Field.html#required">required</a></p>
<ul>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/5392074/src/structures/field.ts#L14">structures/field.ts:14</a></li>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/a13d51e/src/structures/field.ts#L14">structures/field.ts:14</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -235,7 +235,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> <span class="tsd-fl
<aside class="tsd-sources">
<p>Overrides <a href="Field.html">Field</a>.<a href="Field.html#type">type</a></p>
<ul>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/5392074/src/structures/field.ts#L87">structures/field.ts:87</a></li>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/a13d51e/src/structures/field.ts#L87">structures/field.ts:87</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -257,7 +257,7 @@ <h3>data</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/5392074/src/structures/field.ts#L55">structures/field.ts:55</a></li>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/a13d51e/src/structures/field.ts#L55">structures/field.ts:55</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
14 changes: 7 additions & 7 deletions docs/classes/Command.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ <h3>constructor</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="SlashCommand.html">SlashCommand</a>.<a href="SlashCommand.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/5392074/src/structures/command.ts#L51">structures/command.ts:51</a></li>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/a13d51e/src/structures/command.ts#L51">structures/command.ts:51</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -158,7 +158,7 @@ <h3>description</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="SlashCommand.html">SlashCommand</a>.<a href="SlashCommand.html#description">description</a></p>
<ul>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/5392074/src/structures/command.ts#L24">structures/command.ts:24</a></li>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/a13d51e/src/structures/command.ts#L24">structures/command.ts:24</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -174,7 +174,7 @@ <h3>name</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="SlashCommand.html">SlashCommand</a>.<a href="SlashCommand.html#name">name</a></p>
<ul>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/5392074/src/structures/command.ts#L22">structures/command.ts:22</a></li>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/a13d51e/src/structures/command.ts#L22">structures/command.ts:22</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -190,7 +190,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> options</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="SlashCommand.html">SlashCommand</a>.<a href="SlashCommand.html#options">options</a></p>
<ul>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/5392074/src/structures/command.ts#L46">structures/command.ts:46</a></li>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/a13d51e/src/structures/command.ts#L46">structures/command.ts:46</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -206,7 +206,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> <span class="tsd-fl
<aside class="tsd-sources">
<p>Overrides <a href="SlashCommand.html">SlashCommand</a>.<a href="SlashCommand.html#type">type</a></p>
<ul>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/5392074/src/structures/command.ts#L69">structures/command.ts:69</a></li>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/a13d51e/src/structures/command.ts#L69">structures/command.ts:69</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -228,7 +228,7 @@ <h3>data</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/5392074/src/structures/command.ts#L58">structures/command.ts:58</a></li>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/a13d51e/src/structures/command.ts#L58">structures/command.ts:58</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -254,7 +254,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> execute</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="SlashCommand.html">SlashCommand</a>.<a href="SlashCommand.html#execute">execute</a></p>
<ul>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/5392074/src/structures/command.ts#L26">structures/command.ts:26</a></li>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/a13d51e/src/structures/command.ts#L26">structures/command.ts:26</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
59 changes: 55 additions & 4 deletions docs/classes/ContextMenuCommand.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,7 @@ <h3>Constructors</h3>
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class"><a href="ContextMenuCommand.html#aliases" class="tsd-kind-icon">aliases</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="ContextMenuCommand.html#name" class="tsd-kind-icon">name</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="ContextMenuCommand.html#type" class="tsd-kind-icon">type</a></li>
</ul>
Expand All @@ -115,6 +116,7 @@ <h3>Accessors</h3>
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="ContextMenuCommand.html#execute" class="tsd-kind-icon">execute</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="ContextMenuCommand.html#onReply" class="tsd-kind-icon">on<wbr>Reply</a></li>
</ul>
</section>
</div>
Expand All @@ -139,13 +141,28 @@ <h4 class="tsd-returns-title">Returns <a href="ContextMenuCommand.html" class="t
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="aliases" class="tsd-anchor"></a>
<h3>aliases</h3>
<div class="tsd-signature tsd-kind-icon">aliases<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</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/a13d51e/src/structures/command.ts#L87">structures/command.ts:87</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The aliases of the command</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="name" class="tsd-anchor"></a>
<h3>name</h3>
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/5392074/src/structures/command.ts#L85">structures/command.ts:85</a></li>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/a13d51e/src/structures/command.ts#L85">structures/command.ts:85</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -160,7 +177,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> <span class="tsd-fl
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/5392074/src/structures/command.ts#L93">structures/command.ts:93</a></li>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/a13d51e/src/structures/command.ts#L97">structures/command.ts:97</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -182,7 +199,7 @@ <h3>data</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/5392074/src/structures/command.ts#L98">structures/command.ts:98</a></li>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/a13d51e/src/structures/command.ts#L102">structures/command.ts:102</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -215,7 +232,7 @@ <h3>execute</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/5392074/src/structures/command.ts#L87">structures/command.ts:87</a></li>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/a13d51e/src/structures/command.ts#L91">structures/command.ts:91</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -233,6 +250,34 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="onReply" class="tsd-anchor"></a>
<h3>on<wbr>Reply</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">on<wbr>Reply<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/a13d51e/src/structures/command.ts#L89">structures/command.ts:89</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Executed when message is sent</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>message: <span class="tsd-signature-type">Message</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
Expand Down Expand Up @@ -262,6 +307,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="ContextMenuCommand.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="ContextMenuCommand.html#aliases" class="tsd-kind-icon">aliases</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="ContextMenuCommand.html#name" class="tsd-kind-icon">name</a>
</li>
Expand All @@ -274,6 +322,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="ContextMenuCommand.html#execute" class="tsd-kind-icon">execute</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="ContextMenuCommand.html#onReply" class="tsd-kind-icon">on<wbr>Reply</a>
</li>
</ul>
</li>
</ul>
Expand Down
Loading

0 comments on commit 08c96f9

Please sign in to comment.