Skip to content

Commit

Permalink
chore(build-docs): generated docs for v2.3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@Allvaa
Allvaa committed Jun 16, 2021
1 parent b6a360a commit bceaf62
Show file tree
Hide file tree
Showing 15 changed files with 639 additions and 169 deletions.
2 changes: 1 addition & 1 deletion docs/assets/js/search.js
View file

Large diffs are not rendered by default.

98 changes: 82 additions & 16 deletions docs/classes/lavasfyclient.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>LavasfyClient | lavasfy - v2.2.1</title>
<meta name="description" content="Documentation for lavasfy - v2.2.1">
<title>LavasfyClient | lavasfy - v2.3.0</title>
<meta name="description" content="Documentation for lavasfy - v2.3.0">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
Expand All @@ -23,7 +23,7 @@
<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">lavasfy - v2.2.1</a>
<a href="../index.html" class="title">lavasfy - v2.3.0</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
Expand Down Expand Up @@ -52,7 +52,7 @@
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">lavasfy - v2.2.1</a>
<a href="../modules.html">lavasfy - v2.3.0</a>
</li>
<li>
<a href="lavasfyclient.html">LavasfyClient</a>
Expand Down Expand Up @@ -98,7 +98,9 @@ <h3>Properties</h3>
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="lavasfyclient.html#addnode" class="tsd-kind-icon">add<wbr>Node</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="lavasfyclient.html#getnode" class="tsd-kind-icon">get<wbr>Node</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="lavasfyclient.html#isvalidurl" class="tsd-kind-icon">is<wbr>ValidURL</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="lavasfyclient.html#removenode" class="tsd-kind-icon">remove<wbr>Node</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="lavasfyclient.html#requesttoken" class="tsd-kind-icon">request<wbr>Token</a></li>
</ul>
</section>
Expand All @@ -117,7 +119,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Allvaa/lava-spotify/blob/7a427de/src/Client.ts#L19">Client.ts:19</a></li>
<li>Defined in <a href="https://github.com/Allvaa/lava-spotify/blob/b6a360a/src/Client.ts#L19">Client.ts:19</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -142,7 +144,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> baseURL</h3>
<div class="tsd-signature tsd-kind-icon">baseURL<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/Allvaa/lava-spotify/blob/7a427de/src/Client.ts#L13">Client.ts:13</a></li>
<li>Defined in <a href="https://github.com/Allvaa/lava-spotify/blob/b6a360a/src/Client.ts#L13">Client.ts:13</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -157,7 +159,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag t
<div class="tsd-signature tsd-kind-icon">next<wbr>Request<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Timeout</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Allvaa/lava-spotify/blob/7a427de/src/Client.ts#L19">Client.ts:19</a></li>
<li>Defined in <a href="https://github.com/Allvaa/lava-spotify/blob/b6a360a/src/Client.ts#L19">Client.ts:19</a></li>
</ul>
</aside>
</section>
Expand All @@ -167,7 +169,7 @@ <h3>nodes</h3>
<div class="tsd-signature tsd-kind-icon">nodes<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="node.html" class="tsd-signature-type" data-tsd-kind="Class">Node</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Allvaa/lava-spotify/blob/7a427de/src/Client.ts#L11">Client.ts:11</a></li>
<li>Defined in <a href="https://github.com/Allvaa/lava-spotify/blob/b6a360a/src/Client.ts#L11">Client.ts:11</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -182,7 +184,7 @@ <h3>options</h3>
<div class="tsd-signature tsd-kind-icon">options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/clientoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ClientOptions</a><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Allvaa/lava-spotify/blob/7a427de/src/Client.ts#L9">Client.ts:9</a></li>
<li>Defined in <a href="https://github.com/Allvaa/lava-spotify/blob/b6a360a/src/Client.ts#L9">Client.ts:9</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -197,7 +199,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> spotify<wbr>Pattern</
<div class="tsd-signature tsd-kind-icon">spotify<wbr>Pattern<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RegExp</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Allvaa/lava-spotify/blob/7a427de/src/Client.ts#L15">Client.ts:15</a></li>
<li>Defined in <a href="https://github.com/Allvaa/lava-spotify/blob/b6a360a/src/Client.ts#L15">Client.ts:15</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -212,7 +214,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> token</h3>
<div class="tsd-signature tsd-kind-icon">token<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><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/Allvaa/lava-spotify/blob/7a427de/src/Client.ts#L17">Client.ts:17</a></li>
<li>Defined in <a href="https://github.com/Allvaa/lava-spotify/blob/b6a360a/src/Client.ts#L17">Client.ts:17</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -234,7 +236,7 @@ <h3>add<wbr>Node</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Allvaa/lava-spotify/blob/7a427de/src/Client.ts#L38">Client.ts:38</a></li>
<li>Defined in <a href="https://github.com/Allvaa/lava-spotify/blob/b6a360a/src/Client.ts#L38">Client.ts:38</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -247,6 +249,38 @@ <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="getnode" class="tsd-anchor"></a>
<h3>get<wbr>Node</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Node<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="node.html" class="tsd-signature-type" data-tsd-kind="Class">Node</a></li>
<li class="tsd-signature tsd-kind-icon">get<wbr>Node<span class="tsd-signature-symbol">(</span>id<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">undefined</span><span class="tsd-signature-symbol"> | </span><a href="node.html" class="tsd-signature-type" data-tsd-kind="Class">Node</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Allvaa/lava-spotify/blob/b6a360a/src/Client.ts#L52">Client.ts:52</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="node.html" class="tsd-signature-type" data-tsd-kind="Class">Node</a></h4>
</li>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Allvaa/lava-spotify/blob/b6a360a/src/Client.ts#L53">Client.ts:53</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>id: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="node.html" class="tsd-signature-type" data-tsd-kind="Class">Node</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="isvalidurl" class="tsd-anchor"></a>
<h3>is<wbr>ValidURL</h3>
Expand All @@ -257,7 +291,7 @@ <h3>is<wbr>ValidURL</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Allvaa/lava-spotify/blob/7a427de/src/Client.ts#L43">Client.ts:43</a></li>
<li>Defined in <a href="https://github.com/Allvaa/lava-spotify/blob/b6a360a/src/Client.ts#L63">Client.ts:63</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -275,6 +309,29 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="removenode" class="tsd-anchor"></a>
<h3>remove<wbr>Node</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">remove<wbr>Node<span class="tsd-signature-symbol">(</span>id<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">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Allvaa/lava-spotify/blob/b6a360a/src/Client.ts#L42">Client.ts:42</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>id: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="requesttoken" class="tsd-anchor"></a>
<h3>request<wbr>Token</h3>
Expand All @@ -285,12 +342,12 @@ <h3>request<wbr>Token</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Allvaa/lava-spotify/blob/7a427de/src/Client.ts#L48">Client.ts:48</a></li>
<li>Defined in <a href="https://github.com/Allvaa/lava-spotify/blob/b6a360a/src/Client.ts#L68">Client.ts:68</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A method to retrieve the Spotify API token. (this method must be invoked)</p>
<p>A method to retrieve the Spotify API token. (this method only needs to be invoked once after the <a href="lavasfyclient.html">LavasfyClient</a> instantiated)</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
Expand Down Expand Up @@ -338,9 +395,15 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="lavasfyclient.html#addnode" class="tsd-kind-icon">add<wbr>Node</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="lavasfyclient.html#getnode" class="tsd-kind-icon">get<wbr>Node</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="lavasfyclient.html#isvalidurl" class="tsd-kind-icon">is<wbr>ValidURL</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="lavasfyclient.html#removenode" class="tsd-kind-icon">remove<wbr>Node</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="lavasfyclient.html#requesttoken" class="tsd-kind-icon">request<wbr>Token</a>
</li>
Expand All @@ -360,7 +423,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<li class=" tsd-kind-interface">
<a href="../interfaces/lavalinktrack.html" class="tsd-kind-icon">Lavalink<wbr>Track</a>
</li>
<li class=" tsd-kind-interface">
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="../interfaces/lavalinktrackresponse.html" class="tsd-kind-icon">Lavalink<wbr>Track<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
Expand All @@ -378,6 +441,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<li class=" tsd-kind-interface">
<a href="../interfaces/spotifytrack.html" class="tsd-kind-icon">Spotify<wbr>Track</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/unresolvedtrack.html" class="tsd-kind-icon">Unresolved<wbr>Track</a>
</li>
</ul>
</nav>
</div>
Expand Down
Loading

0 comments on commit bceaf62

Please sign in to comment.