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 7, 2022
1 parent 4f69012 commit 7044bbd
Show file tree
Hide file tree
Showing 18 changed files with 662 additions and 479 deletions.
2 changes: 1 addition & 1 deletion docs/assets/js/search.js
View file

Large diffs are not rendered by default.

49 changes: 29 additions & 20 deletions docs/classes/BooleanField.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ <h1>Class BooleanField</h1>
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">FieldBuilder</span>
<span class="tsd-signature-type">default</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">BooleanField</span>
Expand Down Expand Up @@ -120,29 +120,41 @@ <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>Boolean<wbr>Field<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, description<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, required<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, choices<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">choice</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BooleanField.html" class="tsd-signature-type" data-tsd-kind="Class">BooleanField</a></li>
<li class="tsd-signature tsd-kind-icon">new <wbr>Boolean<wbr>Field<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, description<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, required<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, choices<span class="tsd-signature-symbol">?: </span><a href="../interfaces/choice.html" class="tsd-signature-type" data-tsd-kind="Interface">choice</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BooleanField.html" class="tsd-signature-type" data-tsd-kind="Class">BooleanField</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FieldBuilder.constructor</p>
<ul>
<li>Defined in <a href="https://github.com/ming-suhi/djs-commando/blob/964fd53/src/structures/field-builder.ts#L8">structures/field-builder.ts:8</a></li>
<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>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>name: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The name of the field</p>
</div>
</li>
<li>
<h5>description: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The description of the field</p>
</div>
</li>
<li>
<h5>required: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
<div class="tsd-comment tsd-typography">
<p>If field is required</p>
</div>
</li>
<li>
<h5>choices: <span class="tsd-signature-type">choice</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></h5>
<h5>choices: <a href="../interfaces/choice.html" class="tsd-signature-type" data-tsd-kind="Interface">choice</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></h5>
<div class="tsd-comment tsd-typography">
<p>The choices for the field</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="BooleanField.html" class="tsd-signature-type" data-tsd-kind="Class">BooleanField</a></h4>
Expand All @@ -155,7 +167,7 @@ <h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="choices" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> choices</h3>
<div class="tsd-signature tsd-kind-icon">choices<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">choice</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div>
<div class="tsd-signature tsd-kind-icon">choices<span class="tsd-signature-symbol">:</span> <a href="../interfaces/choice.html" class="tsd-signature-type" data-tsd-kind="Interface">choice</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div>
<aside class="tsd-sources">
<p>Inherited from FieldBuilder.choices</p>
</aside>
Expand Down Expand Up @@ -191,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/964fd53/src/structures/field-consumer.ts#L15">structures/field-consumer.ts:15</a></li>
<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>
</ul>
</aside>
</section>
Expand All @@ -202,24 +214,24 @@ <h2>Accessors</h2>
<a name="rawData" class="tsd-anchor"></a>
<h3>raw<wbr>Data</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> rawData<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>choices<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">choice</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>description<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>required<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></li>
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> rawData<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>choices<span class="tsd-signature-symbol">: </span><a href="../interfaces/choice.html" class="tsd-signature-type" data-tsd-kind="Interface">choice</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>description<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>required<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</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/964fd53/src/structures/field.ts#L49">structures/field.ts:49</a></li>
<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>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The raw object for field data. Used to interact with discord.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>choices<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">choice</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>description<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>required<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></h4>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>choices<span class="tsd-signature-symbol">: </span><a href="../interfaces/choice.html" class="tsd-signature-type" data-tsd-kind="Interface">choice</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>description<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>required<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>choices<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">choice</span><span class="tsd-signature-symbol">[]</span></h5>
<h5>choices<span class="tsd-signature-symbol">: </span><a href="../interfaces/choice.html" class="tsd-signature-type" data-tsd-kind="Interface">choice</a><span class="tsd-signature-symbol">[]</span></h5>
</li>
<li class="tsd-parameter">
<h5>description<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
Expand Down Expand Up @@ -318,20 +330,14 @@ <h5>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-t
<li class=" tsd-kind-class">
<a href="UserField.html" class="tsd-kind-icon">User<wbr>Field</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../modules.html#ApplicationCommandType" class="tsd-kind-icon">Application<wbr>Command<wbr>Type</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../modules.html#CommandOptionType" class="tsd-kind-icon">Command<wbr>Option<wbr>Type</a>
<li class=" tsd-kind-interface">
<a href="../interfaces/choice.html" class="tsd-kind-icon">choice</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../modules.html#FieldType" class="tsd-kind-icon">Field<wbr>Type</a>
</li>
<li class=" tsd-kind-variable">
<a href="../modules.html#applicationCommandStructures" class="tsd-kind-icon">application<wbr>Command<wbr>Structures</a>
</li>
<li class=" tsd-kind-variable">
<a href="../modules.html#commandOptionStructures" class="tsd-kind-icon">command<wbr>Option<wbr>Structures</a>
<li class=" tsd-kind-function">
<a href="../modules.html#mapCommands" class="tsd-kind-icon">map<wbr>Commands</a>
</li>
</ul>
</nav>
Expand All @@ -352,6 +358,9 @@ <h2>Legend</h2>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
</div>
</div>
</footer>
Expand Down
Loading

0 comments on commit 7044bbd

Please sign in to comment.