cath v1.3.2-dev
This commit is contained in:
night0721
parent
1889a14c0b
commit
41ca4a5c19
9 changed files with 24 additions and 16 deletions
|
|
@ -1,8 +1,8 @@
|
||||||
:root {
|
:root {
|
||||||
--light-hl-0: #0000FF;
|
--light-hl-0: #000000;
|
||||||
--dark-hl-0: #569CD6;
|
--dark-hl-0: #D4D4D4;
|
||||||
--light-hl-1: #000000;
|
--light-hl-1: #0000FF;
|
||||||
--dark-hl-1: #D4D4D4;
|
--dark-hl-1: #569CD6;
|
||||||
--light-hl-2: #0070C1;
|
--light-hl-2: #0070C1;
|
||||||
--dark-hl-2: #4FC1FF;
|
--dark-hl-2: #4FC1FF;
|
||||||
--light-hl-3: #795E26;
|
--light-hl-3: #795E26;
|
||||||
|
|
|
||||||
File diff suppressed because one or more lines are too long
|
|
@ -1,7 +1,7 @@
|
||||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>CODMClient | cath</title><meta name="description" content="Documentation for cath"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">cath</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">cath</a></li><li><a href="CODMClient.html">CODMClient</a></li></ul><h1>Class CODMClient</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>name</dt><dd><p>APIClient</p>
|
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>CODMClient | cath</title><meta name="description" content="Documentation for cath"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">cath</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">cath</a></li><li><a href="CODMClient.html">CODMClient</a></li></ul><h1>Class CODMClient</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>name</dt><dd><p>APIClient</p>
|
||||||
</dd><dt>kind</dt><dd><p>constructor</p>
|
</dd><dt>kind</dt><dd><p>constructor</p>
|
||||||
</dd><dt>param key</dt><dd><p>Authorization Key for API (Only for CODM commands)</p>
|
</dd><dt>param key</dt><dd><p>Authorization Key for API (Only for CODM commands)</p>
|
||||||
</dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">CODMClient</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="CODMClient.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="CODMClient.html#key" class="tsd-kind-icon">key</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="CODMClient.html#getperk" class="tsd-kind-icon">getperk</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new CODMClient<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CODMClient.html" class="tsd-signature-type" data-tsd-kind="Class">CODMClient</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in CODMClient/codmclient.ts:9</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>key: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="CODMClient.html" class="tsd-signature-type" data-tsd-kind="Class">CODMClient</a></h4></li></ul></section></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="key" class="tsd-anchor"></a><h3>key</h3><div class="tsd-signature tsd-kind-icon">key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="getperk" class="tsd-anchor"></a><h3>getperk</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">getperk<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><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</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 CODMClient/codmclient.ts:18</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
</dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">CODMClient</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="CODMClient.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="CODMClient.html#key" class="tsd-kind-icon">key</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="CODMClient.html#getperk" class="tsd-kind-icon">getperk</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new CODMClient<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CODMClient.html" class="tsd-signature-type" data-tsd-kind="Class">CODMClient</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in CODMClient/codmclient.ts:10</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>key: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="CODMClient.html" class="tsd-signature-type" data-tsd-kind="Class">CODMClient</a></h4></li></ul></section></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="key" class="tsd-anchor"></a><h3>key</h3><div class="tsd-signature tsd-kind-icon">key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="getperk" class="tsd-anchor"></a><h3>getperk</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">getperk<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><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PerkData.html" class="tsd-signature-type" data-tsd-kind="Interface">PerkData</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in CODMClient/codmclient.ts:19</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||||
<p>Sends a CODM perk object</p>
|
<p>Sends a CODM perk object</p>
|
||||||
</div></div><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"><div class="lead">
|
</div></div><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"><div class="lead">
|
||||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="CODMClient.html" class="tsd-kind-icon">CODMClient</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="CODMClient.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CODMClient.html#key" class="tsd-kind-icon">key</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CODMClient.html#getperk" class="tsd-kind-icon">getperk</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">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><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PerkData.html" class="tsd-signature-type" data-tsd-kind="Interface">PerkData</a><span class="tsd-signature-symbol">></span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="CODMClient.html" class="tsd-kind-icon">CODMClient</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="CODMClient.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CODMClient.html#key" class="tsd-kind-icon">key</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CODMClient.html#getperk" class="tsd-kind-icon">getperk</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">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><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
|
||||||
6
classes/CodeClient.html
Normal file
6
classes/CodeClient.html
Normal file
|
|
@ -0,0 +1,6 @@
|
||||||
|
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>CodeClient | cath</title><meta name="description" content="Documentation for cath"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">cath</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">cath</a></li><li><a href="CodeClient.html">CodeClient</a></li></ul><h1>Class CodeClient</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>name</dt><dd><p>CodeClient</p>
|
||||||
|
</dd><dt>kind</dt><dd><p>constructor</p>
|
||||||
|
</dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">CodeClient</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="CodeClient.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="CodeClient.html#createBin" class="tsd-kind-icon">create<wbr/>Bin</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Code<wbr/>Client<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CodeClient.html" class="tsd-signature-type" data-tsd-kind="Class">CodeClient</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in CodeClient/codeclient.ts:9</li></ul></aside><h4 class="tsd-returns-title">Returns <a href="CodeClient.html" class="tsd-signature-type" data-tsd-kind="Class">CodeClient</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="createBin" class="tsd-anchor"></a><h3>create<wbr/>Bin</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">create<wbr/>Bin<span class="tsd-signature-symbol">(</span>title<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>, code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">String</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/CodeData.html" class="tsd-signature-type" data-tsd-kind="Interface">CodeData</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in CodeClient/codeclient.ts:17</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||||
|
<p>Sends the link of the code</p>
|
||||||
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>title: <span class="tsd-signature-type">String</span></h5></li><li><h5>description: <span class="tsd-signature-type">String</span></h5></li><li><h5>code: <span class="tsd-signature-type">String</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||||
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/CodeData.html" class="tsd-signature-type" data-tsd-kind="Interface">CodeData</a><span class="tsd-signature-symbol">></span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="CodeClient.html" class="tsd-kind-icon">Code<wbr/>Client</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="CodeClient.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CodeClient.html#createBin" class="tsd-kind-icon">create<wbr/>Bin</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">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><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
|
||||||
|
|
@ -14,7 +14,6 @@
|
||||||
<a href="https://npmjs.org/package/cath" target="_blank"><img alt='Node Package' src="https://nodei.co/npm/cath.png"></a>
|
<a href="https://npmjs.org/package/cath" target="_blank"><img alt='Node Package' src="https://nodei.co/npm/cath.png"></a>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
|
||||||
<p><strong>Cath</strong> is a powerful <a href="https://nodejs.org">Node.js</a> module that can easily interact and get data from the Cath API
|
<p><strong>Cath</strong> is a powerful <a href="https://nodejs.org">Node.js</a> module that can easily interact and get data from the Cath API
|
||||||
If you like this package, feel free to <img src = "https://discord.com/assets/141d49436743034a59dec6bd5618675d.svg" width = "16"> <strong>Star</strong> and <strong>fork</strong> this repository.<br><br></p>
|
If you like this package, feel free to <img src = "https://discord.com/assets/141d49436743034a59dec6bd5618675d.svg" width = "16"> <strong>Star</strong> and <strong>fork</strong> this repository.<br><br></p>
|
||||||
|
|
||||||
|
|
@ -22,10 +21,10 @@ If you like this package, feel free to <img src = "https://discord.com/assets/14
|
||||||
<h1>Install the package ✔</h1>
|
<h1>Install the package ✔</h1>
|
||||||
</a>
|
</a>
|
||||||
<p>Download from npm</p>
|
<p>Download from npm</p>
|
||||||
<pre><code class="language-cli">npm install cath
|
<pre><code class="language-powershell"><span class="hl-0">npm install cath</span>
|
||||||
</code></pre>
|
</code></pre>
|
||||||
<p>Download from yarn</p>
|
<p>Download from yarn</p>
|
||||||
<pre><code class="language-cli">yarn add cath
|
<pre><code class="language-powershell"><span class="hl-0">yarn add cath</span>
|
||||||
</code></pre>
|
</code></pre>
|
||||||
|
|
||||||
<a href="#examples" id="examples" style="color: inherit; text-decoration: none;">
|
<a href="#examples" id="examples" style="color: inherit; text-decoration: none;">
|
||||||
|
|
@ -35,7 +34,7 @@ If you like this package, feel free to <img src = "https://discord.com/assets/14
|
||||||
<a href="#launch-of-the-module" id="launch-of-the-module" style="color: inherit; text-decoration: none;">
|
<a href="#launch-of-the-module" id="launch-of-the-module" style="color: inherit; text-decoration: none;">
|
||||||
<h3>Launch of the module</h3>
|
<h3>Launch of the module</h3>
|
||||||
</a>
|
</a>
|
||||||
<pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">cath</span><span class="hl-1"> = </span><span class="hl-3">require</span><span class="hl-1">(</span><span class="hl-4">"cath"</span><span class="hl-1">);</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">reddit_data</span><span class="hl-1"> = </span><span class="hl-5">await</span><span class="hl-1"> </span><span class="hl-6">cath</span><span class="hl-1">.</span><span class="hl-3">getreddit</span><span class="hl-1">(</span><span class="hl-4">"meme"</span><span class="hl-1">);</span><br/><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-6">reddit_data</span><span class="hl-1">); </span><span class="hl-7">// returns an object</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">answer</span><span class="hl-1"> = </span><span class="hl-5">await</span><span class="hl-1"> </span><span class="hl-6">cath</span><span class="hl-1">.</span><span class="hl-3">random8ball</span><span class="hl-1">();</span><br/><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-6">answer</span><span class="hl-1">); </span><span class="hl-7">// a random answer from 8ball</span>
|
<pre><code class="language-js"><span class="hl-1">const</span><span class="hl-0"> </span><span class="hl-2">cath</span><span class="hl-0"> = </span><span class="hl-3">require</span><span class="hl-0">(</span><span class="hl-4">"cath"</span><span class="hl-0">);</span><br/><br/><span class="hl-1">const</span><span class="hl-0"> </span><span class="hl-2">reddit_data</span><span class="hl-0"> = </span><span class="hl-5">await</span><span class="hl-0"> </span><span class="hl-6">cath</span><span class="hl-0">.</span><span class="hl-3">getreddit</span><span class="hl-0">(</span><span class="hl-4">"meme"</span><span class="hl-0">);</span><br/><span class="hl-6">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-6">reddit_data</span><span class="hl-0">); </span><span class="hl-7">// returns an object</span><br/><br/><span class="hl-1">const</span><span class="hl-0"> </span><span class="hl-2">answer</span><span class="hl-0"> = </span><span class="hl-5">await</span><span class="hl-0"> </span><span class="hl-6">cath</span><span class="hl-0">.</span><span class="hl-3">random8ball</span><span class="hl-0">();</span><br/><span class="hl-6">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-6">answer</span><span class="hl-0">); </span><span class="hl-7">// a random answer from 8ball</span>
|
||||||
</code></pre>
|
</code></pre>
|
||||||
|
|
||||||
<a href="#support-feature-request-amp-bug-reports" id="support-feature-request-amp-bug-reports" style="color: inherit; text-decoration: none;">
|
<a href="#support-feature-request-amp-bug-reports" id="support-feature-request-amp-bug-reports" style="color: inherit; text-decoration: none;">
|
||||||
|
|
@ -55,4 +54,4 @@ To Request new features contact us on Discord using the support server.</p>
|
||||||
<p align = "center">
|
<p align = "center">
|
||||||
<a href="https://rebrand.ly/cathSupport" target="_blank"><img src="https://discordapp.com/api/guilds/718762019586572341/widget.png?style=banner1"></a>
|
<a href="https://rebrand.ly/cathSupport" target="_blank"><img src="https://discordapp.com/api/guilds/718762019586572341/widget.png?style=banner1"></a>
|
||||||
</p>
|
</p>
|
||||||
</div></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-class"><a href="classes/CODMClient.html" class="tsd-kind-icon">CODMClient</a></li><li class="tsd-kind-class"><a href="classes/StarboardClient.html" class="tsd-kind-icon">Starboard<wbr/>Client</a></li><li class="tsd-kind-interface"><a href="interfaces/CODMClientOptions.html" class="tsd-kind-icon">CODMClient<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardClientOptions.html" class="tsd-kind-icon">Starboard<wbr/>Client<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardGuild.html" class="tsd-kind-icon">Starboard<wbr/>Guild</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardGuildOptions.html" class="tsd-kind-icon">Starboard<wbr/>Guild<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/starMessageData.html" class="tsd-kind-icon">star<wbr/>Message<wbr/>Data</a></li><li class="tsd-kind-function"><a href="modules.html#getreddit" class="tsd-kind-icon">getreddit</a></li><li class="tsd-kind-function"><a href="modules.html#random8ball" class="tsd-kind-icon">random8ball</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">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><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="assets/main.js"></script></body></html>
|
</div></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-class"><a href="classes/CODMClient.html" class="tsd-kind-icon">CODMClient</a></li><li class="tsd-kind-class"><a href="classes/CodeClient.html" class="tsd-kind-icon">Code<wbr/>Client</a></li><li class="tsd-kind-class"><a href="classes/StarboardClient.html" class="tsd-kind-icon">Starboard<wbr/>Client</a></li><li class="tsd-kind-interface"><a href="interfaces/CODMClientOptions.html" class="tsd-kind-icon">CODMClient<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/CodeData.html" class="tsd-kind-icon">Code<wbr/>Data</a></li><li class="tsd-kind-interface"><a href="interfaces/PerkData.html" class="tsd-kind-icon">Perk<wbr/>Data</a></li><li class="tsd-kind-interface"><a href="interfaces/RedditObject.html" class="tsd-kind-icon">Reddit<wbr/>Object</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardClientOptions.html" class="tsd-kind-icon">Starboard<wbr/>Client<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardGuild.html" class="tsd-kind-icon">Starboard<wbr/>Guild</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardGuildOptions.html" class="tsd-kind-icon">Starboard<wbr/>Guild<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/starMessageData.html" class="tsd-kind-icon">star<wbr/>Message<wbr/>Data</a></li><li class="tsd-kind-function"><a href="modules.html#getreddit" class="tsd-kind-icon">getreddit</a></li><li class="tsd-kind-function"><a href="modules.html#random8ball" class="tsd-kind-icon">random8ball</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">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><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="assets/main.js"></script></body></html>
|
||||||
1
interfaces/CodeData.html
Normal file
1
interfaces/CodeData.html
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>CodeData | cath</title><meta name="description" content="Documentation for cath"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">cath</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">cath</a></li><li><a href="CodeData.html">CodeData</a></li></ul><h1>Interface CodeData</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">CodeData</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CodeData.html#url" class="tsd-kind-icon">url</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="url" class="tsd-anchor"></a><h3>url</h3><div class="tsd-signature tsd-kind-icon">url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in CodeClient/codeclient.interface.ts:2</li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="CodeData.html" class="tsd-kind-icon">Code<wbr/>Data</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CodeData.html#url" class="tsd-kind-icon">url</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">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><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
|
||||||
1
interfaces/PerkData.html
Normal file
1
interfaces/PerkData.html
Normal file
File diff suppressed because one or more lines are too long
1
interfaces/RedditObject.html
Normal file
1
interfaces/RedditObject.html
Normal file
File diff suppressed because one or more lines are too long
|
|
@ -1,5 +1,5 @@
|
||||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>cath</title><meta name="description" content="Documentation for cath"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">cath</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><h1>cath</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Classes</h3><ul class="tsd-index-list"><li class="tsd-kind-class"><a href="classes/CODMClient.html" class="tsd-kind-icon">CODMClient</a></li><li class="tsd-kind-class"><a href="classes/StarboardClient.html" class="tsd-kind-icon">Starboard<wbr/>Client</a></li></ul></section><section class="tsd-index-section "><h3>Interfaces</h3><ul class="tsd-index-list"><li class="tsd-kind-interface"><a href="interfaces/CODMClientOptions.html" class="tsd-kind-icon">CODMClient<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardClientOptions.html" class="tsd-kind-icon">Starboard<wbr/>Client<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardGuild.html" class="tsd-kind-icon">Starboard<wbr/>Guild</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardGuildOptions.html" class="tsd-kind-icon">Starboard<wbr/>Guild<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/starMessageData.html" class="tsd-kind-icon">star<wbr/>Message<wbr/>Data</a></li></ul></section><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function"><a href="modules.html#getreddit" class="tsd-kind-icon">getreddit</a></li><li class="tsd-kind-function"><a href="modules.html#random8ball" class="tsd-kind-icon">random8ball</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Functions</h2><section class="tsd-panel tsd-member tsd-kind-function"><a name="getreddit" class="tsd-anchor"></a><h3>getreddit</h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">getreddit<span class="tsd-signature-symbol">(</span>sub<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</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 functions/reddit.ts:6</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>cath</title><meta name="description" content="Documentation for cath"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">cath</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><h1>cath</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Classes</h3><ul class="tsd-index-list"><li class="tsd-kind-class"><a href="classes/CODMClient.html" class="tsd-kind-icon">CODMClient</a></li><li class="tsd-kind-class"><a href="classes/CodeClient.html" class="tsd-kind-icon">Code<wbr/>Client</a></li><li class="tsd-kind-class"><a href="classes/StarboardClient.html" class="tsd-kind-icon">Starboard<wbr/>Client</a></li></ul></section><section class="tsd-index-section "><h3>Interfaces</h3><ul class="tsd-index-list"><li class="tsd-kind-interface"><a href="interfaces/CODMClientOptions.html" class="tsd-kind-icon">CODMClient<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/CodeData.html" class="tsd-kind-icon">Code<wbr/>Data</a></li><li class="tsd-kind-interface"><a href="interfaces/PerkData.html" class="tsd-kind-icon">Perk<wbr/>Data</a></li><li class="tsd-kind-interface"><a href="interfaces/RedditObject.html" class="tsd-kind-icon">Reddit<wbr/>Object</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardClientOptions.html" class="tsd-kind-icon">Starboard<wbr/>Client<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardGuild.html" class="tsd-kind-icon">Starboard<wbr/>Guild</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardGuildOptions.html" class="tsd-kind-icon">Starboard<wbr/>Guild<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/starMessageData.html" class="tsd-kind-icon">star<wbr/>Message<wbr/>Data</a></li></ul></section><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function"><a href="modules.html#getreddit" class="tsd-kind-icon">getreddit</a></li><li class="tsd-kind-function"><a href="modules.html#random8ball" class="tsd-kind-icon">random8ball</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Functions</h2><section class="tsd-panel tsd-member tsd-kind-function"><a name="getreddit" class="tsd-anchor"></a><h3>getreddit</h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">getreddit<span class="tsd-signature-symbol">(</span>sub<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="interfaces/RedditObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RedditObject</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in functions/reddit.ts:6</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||||
<p>Sends an embed of reddit</p>
|
<p>Sends an embed of reddit</p>
|
||||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>sub: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span></h4><div></div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a name="random8ball" class="tsd-anchor"></a><h3>random8ball</h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">random8ball<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</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 functions/8ball.ts:7</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>sub: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="interfaces/RedditObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RedditObject</a><span class="tsd-signature-symbol">></span></h4><div></div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a name="random8ball" class="tsd-anchor"></a><h3>random8ball</h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">random8ball<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</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 functions/8ball.ts:7</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||||
<p>Sends a 8ball response</p>
|
<p>Sends a 8ball response</p>
|
||||||
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><div></div></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-class"><a href="classes/CODMClient.html" class="tsd-kind-icon">CODMClient</a></li><li class="tsd-kind-class"><a href="classes/StarboardClient.html" class="tsd-kind-icon">Starboard<wbr/>Client</a></li><li class="tsd-kind-interface"><a href="interfaces/CODMClientOptions.html" class="tsd-kind-icon">CODMClient<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardClientOptions.html" class="tsd-kind-icon">Starboard<wbr/>Client<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardGuild.html" class="tsd-kind-icon">Starboard<wbr/>Guild</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardGuildOptions.html" class="tsd-kind-icon">Starboard<wbr/>Guild<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/starMessageData.html" class="tsd-kind-icon">star<wbr/>Message<wbr/>Data</a></li><li class="tsd-kind-function"><a href="modules.html#getreddit" class="tsd-kind-icon">getreddit</a></li><li class="tsd-kind-function"><a href="modules.html#random8ball" class="tsd-kind-icon">random8ball</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">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><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="assets/main.js"></script></body></html>
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><div></div></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-class"><a href="classes/CODMClient.html" class="tsd-kind-icon">CODMClient</a></li><li class="tsd-kind-class"><a href="classes/CodeClient.html" class="tsd-kind-icon">Code<wbr/>Client</a></li><li class="tsd-kind-class"><a href="classes/StarboardClient.html" class="tsd-kind-icon">Starboard<wbr/>Client</a></li><li class="tsd-kind-interface"><a href="interfaces/CODMClientOptions.html" class="tsd-kind-icon">CODMClient<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/CodeData.html" class="tsd-kind-icon">Code<wbr/>Data</a></li><li class="tsd-kind-interface"><a href="interfaces/PerkData.html" class="tsd-kind-icon">Perk<wbr/>Data</a></li><li class="tsd-kind-interface"><a href="interfaces/RedditObject.html" class="tsd-kind-icon">Reddit<wbr/>Object</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardClientOptions.html" class="tsd-kind-icon">Starboard<wbr/>Client<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardGuild.html" class="tsd-kind-icon">Starboard<wbr/>Guild</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardGuildOptions.html" class="tsd-kind-icon">Starboard<wbr/>Guild<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/starMessageData.html" class="tsd-kind-icon">star<wbr/>Message<wbr/>Data</a></li><li class="tsd-kind-function"><a href="modules.html#getreddit" class="tsd-kind-icon">getreddit</a></li><li class="tsd-kind-function"><a href="modules.html#random8ball" class="tsd-kind-icon">random8ball</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">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><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="assets/main.js"></script></body></html>
|
||||||
Loading…
Reference in a new issue