Skip to content

Commit

Permalink
update docs for v0.1.5
Browse files Browse the repository at this point in the history
  • Loading branch information
@zackradisic
zackradisic committed Aug 24, 2020
1 parent 44a7c3f commit 7e302aa
Show file tree
Hide file tree
Showing 17 changed files with 548 additions and 123 deletions.
2 changes: 1 addition & 1 deletion docs/assets/js/search.json
View file

Large diffs are not rendered by default.

156 changes: 131 additions & 25 deletions docs/classes/_index_.scdl.html
View file

Large diffs are not rendered by default.

9 changes: 7 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/e8bba77/src/formats.ts#L5">formats.ts:5</a></li>
<li>Defined in <a href="https://github.com/zackradisic/node-soundcloud-downloader/blob/eda0a89/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/e8bba77/src/formats.ts#L6">formats.ts:6</a></li>
<li>Defined in <a href="https://github.com/zackradisic/node-soundcloud-downloader/blob/eda0a89/src/formats.ts#L6">formats.ts:6</a></li>
</ul>
</aside>
</section>
Expand All @@ -135,6 +135,9 @@ <h3>OPUS</h3>
<li class=" tsd-kind-module">
<a href="../modules/_protocols_.html">&quot;protocols&quot;</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_search_.html">&quot;search&quot;</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
Expand Down Expand Up @@ -166,6 +169,8 @@ <h2>Legend</h2>
<ul class="tsd-legend">
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
Expand Down
9 changes: 7 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/e8bba77/src/protocols.ts#L5">protocols.ts:5</a></li>
<li>Defined in <a href="https://github.com/zackradisic/node-soundcloud-downloader/blob/eda0a89/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/e8bba77/src/protocols.ts#L6">protocols.ts:6</a></li>
<li>Defined in <a href="https://github.com/zackradisic/node-soundcloud-downloader/blob/eda0a89/src/protocols.ts#L6">protocols.ts:6</a></li>
</ul>
</aside>
</section>
Expand All @@ -135,6 +135,9 @@ <h3>PROGRESSIVE</h3>
<li class="current tsd-kind-module">
<a href="../modules/_protocols_.html">&quot;protocols&quot;</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_search_.html">&quot;search&quot;</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
Expand Down Expand Up @@ -166,6 +169,8 @@ <h2>Legend</h2>
<ul class="tsd-legend">
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
Expand Down
6 changes: 6 additions & 0 deletions docs/globals.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ <h3>Modules</h3>
<li class="tsd-kind-module"><a href="modules/_index_.html" class="tsd-kind-icon">&quot;index&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_info_.html" class="tsd-kind-icon">&quot;info&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_protocols_.html" class="tsd-kind-icon">&quot;protocols&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_search_.html" class="tsd-kind-icon">&quot;search&quot;</a></li>
</ul>
</section>
</div>
Expand Down Expand Up @@ -102,6 +103,9 @@ <h3>Modules</h3>
<li class=" tsd-kind-module">
<a href="modules/_protocols_.html">&quot;protocols&quot;</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_search_.html">&quot;search&quot;</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
Expand All @@ -118,6 +122,8 @@ <h2>Legend</h2>
<ul class="tsd-legend">
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
Expand Down
5 changes: 5 additions & 0 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,9 @@ <h2>To-do</h2>
<li class=" tsd-kind-module">
<a href="modules/_protocols_.html">&quot;protocols&quot;</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_search_.html">&quot;search&quot;</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
Expand All @@ -175,6 +178,8 @@ <h2>Legend</h2>
<ul class="tsd-legend">
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
Expand Down
9 changes: 7 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/e8bba77/src/filter-media.ts#L7">filter-media.ts:7</a></li>
<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>
</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/e8bba77/src/filter-media.ts#L6">filter-media.ts:6</a></li>
<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>
</ul>
</aside>
</section>
Expand All @@ -136,6 +136,9 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> protocol</h3>
<li class=" tsd-kind-module">
<a href="../modules/_protocols_.html">&quot;protocols&quot;</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_search_.html">&quot;search&quot;</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
Expand Down Expand Up @@ -167,6 +170,8 @@ <h2>Legend</h2>
<ul class="tsd-legend">
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
Expand Down
Loading

0 comments on commit 7e302aa

Please sign in to comment.