Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@zackradisic
zackradisic committed Sep 3, 2020
1 parent c7a7652 commit 0f680d9
Show file tree
Hide file tree
Showing 11 changed files with 115 additions and 121 deletions.
38 changes: 16 additions & 22 deletions docs/classes/_index_.scdl.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ <h3>FORMATS</h3>
<div class="tsd-signature tsd-kind-icon">FORMATS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/zackradisic/node-soundcloud-downloader/blob/eda0a89/src/index.ts#L30">index.ts:30</a></li>
<li>Defined in <a href="https://github.com/zackradisic/node-soundcloud-downloader/blob/3b1a1fd/src/index.ts#L30">index.ts:30</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
Expand All @@ -132,7 +132,7 @@ <h3>STREAMING_<wbr>PROTOCOLS</h3>
<div class="tsd-signature tsd-kind-icon">STREAMING_<wbr>PROTOCOLS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/zackradisic/node-soundcloud-downloader/blob/eda0a89/src/index.ts#L29">index.ts:29</a></li>
<li>Defined in <a href="https://github.com/zackradisic/node-soundcloud-downloader/blob/3b1a1fd/src/index.ts#L29">index.ts:29</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
Expand All @@ -150,7 +150,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag t
<div class="tsd-signature tsd-kind-icon">_clientID<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/zackradisic/node-soundcloud-downloader/blob/eda0a89/src/index.ts#L32">index.ts:32</a></li>
<li>Defined in <a href="https://github.com/zackradisic/node-soundcloud-downloader/blob/3b1a1fd/src/index.ts#L32">index.ts:32</a></li>
</ul>
</aside>
</section>
Expand All @@ -167,7 +167,7 @@ <h3>download</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/zackradisic/node-soundcloud-downloader/blob/eda0a89/src/index.ts#L51">index.ts:51</a></li>
<li>Defined in <a href="https://github.com/zackradisic/node-soundcloud-downloader/blob/3b1a1fd/src/index.ts#L51">index.ts:51</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -205,7 +205,7 @@ <h3>download<wbr>Format</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/zackradisic/node-soundcloud-downloader/blob/eda0a89/src/index.ts#L61">index.ts:61</a></li>
<li>Defined in <a href="https://github.com/zackradisic/node-soundcloud-downloader/blob/3b1a1fd/src/index.ts#L61">index.ts:61</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -248,7 +248,7 @@ <h3>filter<wbr>Media</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/zackradisic/node-soundcloud-downloader/blob/eda0a89/src/index.ts#L40">index.ts:40</a></li>
<li>Defined in <a href="https://github.com/zackradisic/node-soundcloud-downloader/blob/3b1a1fd/src/index.ts#L40">index.ts:40</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -286,7 +286,7 @@ <h3>get<wbr>Info</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/zackradisic/node-soundcloud-downloader/blob/eda0a89/src/index.ts#L71">index.ts:71</a></li>
<li>Defined in <a href="https://github.com/zackradisic/node-soundcloud-downloader/blob/3b1a1fd/src/index.ts#L71">index.ts:71</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -324,7 +324,7 @@ <h3>get<wbr>Set<wbr>Info</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/zackradisic/node-soundcloud-downloader/blob/eda0a89/src/index.ts#L92">index.ts:92</a></li>
<li>Defined in <a href="https://github.com/zackradisic/node-soundcloud-downloader/blob/3b1a1fd/src/index.ts#L91">index.ts:91</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -362,7 +362,7 @@ <h3>get<wbr>Track<wbr>Info<wbr>ByID</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/zackradisic/node-soundcloud-downloader/blob/eda0a89/src/index.ts#L81">index.ts:81</a></li>
<li>Defined in <a href="https://github.com/zackradisic/node-soundcloud-downloader/blob/3b1a1fd/src/index.ts#L81">index.ts:81</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -400,7 +400,7 @@ <h3>is<wbr>Valid<wbr>Url</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/zackradisic/node-soundcloud-downloader/blob/eda0a89/src/index.ts#L123">index.ts:123</a></li>
<li>Defined in <a href="https://github.com/zackradisic/node-soundcloud-downloader/blob/3b1a1fd/src/index.ts#L121">index.ts:121</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -425,32 +425,26 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</s
<a name="related" class="tsd-anchor"></a>
<h3>related</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">related<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><a href="../modules/_search_.html#soundcloudresource" class="tsd-signature-type">SoundcloudResource</a>, id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, limit<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, offset<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, clientID<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">&lt;</span><span class="tsd-signature-symbol">{ </span>collection<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>next_href<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>query_urn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>variant<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-signature tsd-kind-icon">related<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, limit<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, offset<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, clientID<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">&lt;</span><span class="tsd-signature-symbol">{ </span>collection<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>next_href<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>query_urn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>variant<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/zackradisic/node-soundcloud-downloader/blob/eda0a89/src/index.ts#L115">index.ts:115</a></li>
<li>Defined in <a href="https://github.com/zackradisic/node-soundcloud-downloader/blob/3b1a1fd/src/index.ts#L113">index.ts:113</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Finds related tracks/playlists/albums to the given track/playlist/album specified by ID</p>
<p>Finds related tracks to the given track specified by ID</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>type: <a href="../modules/_search_.html#soundcloudresource" class="tsd-signature-type">SoundcloudResource</a></h5>
<div class="tsd-comment tsd-typography">
<p>&#39;tracks&#39;, &#39;people&#39;, &#39;albums&#39;, &#39;playlists&#39;</p>
</div>
</li>
<li>
<h5>id: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The ID of the resource</p>
<p>The ID of the track</p>
</div>
</li>
<li>
Expand Down Expand Up @@ -486,7 +480,7 @@ <h3>search</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/zackradisic/node-soundcloud-downloader/blob/eda0a89/src/index.ts#L103">index.ts:103</a></li>
<li>Defined in <a href="https://github.com/zackradisic/node-soundcloud-downloader/blob/3b1a1fd/src/index.ts#L102">index.ts:102</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -499,7 +493,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
<li>
<h5>type: <a href="../modules/_search_.html#soundcloudresource" class="tsd-signature-type">SoundcloudResource</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"all"</span></h5>
<div class="tsd-comment tsd-typography">
<p>The type of resource, one of: &#39;tracks&#39;, &#39;people&#39;, &#39;albums&#39;, &#39;playlists&#39;, &#39;all&#39;</p>
<p>The type of resource, one of: &#39;tracks&#39;, &#39;users&#39;, &#39;albums&#39;, &#39;playlists&#39;, &#39;all&#39;</p>
</div>
</li>
<li>
Expand Down
4 changes: 2 additions & 2 deletions docs/enums/_formats_.formats.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ <h3>MP3</h3>
<div class="tsd-signature tsd-kind-icon">MP3<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;audio/mpeg&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/zackradisic/node-soundcloud-downloader/blob/eda0a89/src/formats.ts#L5">formats.ts:5</a></li>
<li>Defined in <a href="https://github.com/zackradisic/node-soundcloud-downloader/blob/3b1a1fd/src/formats.ts#L5">formats.ts:5</a></li>
</ul>
</aside>
</section>
Expand All @@ -108,7 +108,7 @@ <h3>OPUS</h3>
<div class="tsd-signature tsd-kind-icon">OPUS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;audio/ogg; codecs&#x3D;&quot;opus&quot;&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/zackradisic/node-soundcloud-downloader/blob/eda0a89/src/formats.ts#L6">formats.ts:6</a></li>
<li>Defined in <a href="https://github.com/zackradisic/node-soundcloud-downloader/blob/3b1a1fd/src/formats.ts#L6">formats.ts:6</a></li>
</ul>
</aside>
</section>
Expand Down
4 changes: 2 additions & 2 deletions docs/enums/_protocols_.streaming_protocols.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ <h3>HLS</h3>
<div class="tsd-signature tsd-kind-icon">HLS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;hls&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/zackradisic/node-soundcloud-downloader/blob/eda0a89/src/protocols.ts#L5">protocols.ts:5</a></li>
<li>Defined in <a href="https://github.com/zackradisic/node-soundcloud-downloader/blob/3b1a1fd/src/protocols.ts#L5">protocols.ts:5</a></li>
</ul>
</aside>
</section>
Expand All @@ -108,7 +108,7 @@ <h3>PROGRESSIVE</h3>
<div class="tsd-signature tsd-kind-icon">PROGRESSIVE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;progressive&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/zackradisic/node-soundcloud-downloader/blob/eda0a89/src/protocols.ts#L6">protocols.ts:6</a></li>
<li>Defined in <a href="https://github.com/zackradisic/node-soundcloud-downloader/blob/3b1a1fd/src/protocols.ts#L6">protocols.ts:6</a></li>
</ul>
</aside>
</section>
Expand Down
4 changes: 2 additions & 2 deletions docs/interfaces/_filter_media_.filterpredicateobject.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> format</h3>
<div class="tsd-signature tsd-kind-icon">format<span class="tsd-signature-symbol">:</span> <a href="../enums/_formats_.formats.html" class="tsd-signature-type">FORMATS</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/zackradisic/node-soundcloud-downloader/blob/eda0a89/src/filter-media.ts#L7">filter-media.ts:7</a></li>
<li>Defined in <a href="https://github.com/zackradisic/node-soundcloud-downloader/blob/3b1a1fd/src/filter-media.ts#L7">filter-media.ts:7</a></li>
</ul>
</aside>
</section>
Expand All @@ -109,7 +109,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> protocol</h3>
<div class="tsd-signature tsd-kind-icon">protocol<span class="tsd-signature-symbol">:</span> <a href="../enums/_protocols_.streaming_protocols.html" class="tsd-signature-type">STREAMING_PROTOCOLS</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/zackradisic/node-soundcloud-downloader/blob/eda0a89/src/filter-media.ts#L6">filter-media.ts:6</a></li>
<li>Defined in <a href="https://github.com/zackradisic/node-soundcloud-downloader/blob/3b1a1fd/src/filter-media.ts#L6">filter-media.ts:6</a></li>
</ul>
</aside>
</section>
Expand Down
Loading

0 comments on commit 0f680d9

Please sign in to comment.