Histmy/play-dl-fix
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
play-dl-fix/docs/classes/_internal_.YouTubePlayList.html
killer069 241884d69c Some changes
2021-11-18 15:48:33 +05:30

74 lines
39 KiB
HTML
Raw Blame History

<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>YouTubePlayList | play-dl</title><meta name="description" content="Documentation for play-dl"/><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><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><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">play-dl</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">play-dl</a></li><li><a href="../modules/_internal_.html">&lt;internal&gt;</a></li><li><a href="_internal_.YouTubePlayList.html">YouTubePlayList</a></li></ul><h1>Class YouTubePlayList</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"><div class="lead">
<p>YouTube Playlist Class containing vital informations about playlist.</p>
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">YouTubePlayList</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="_internal_.YouTubePlayList.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 tsd-is-private"><a href="_internal_.YouTubePlayList.html#__count" class="tsd-kind-icon">__count</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_internal_.YouTubePlayList.html#_continuation" class="tsd-kind-icon">_continuation</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubePlayList.html#channel" class="tsd-kind-icon">channel</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_internal_.YouTubePlayList.html#fetched_videos" class="tsd-kind-icon">fetched_<wbr/>videos</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubePlayList.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubePlayList.html#lastUpdate" class="tsd-kind-icon">last<wbr/>Update</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubePlayList.html#link" class="tsd-kind-icon">link</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubePlayList.html#thumbnail" class="tsd-kind-icon">thumbnail</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubePlayList.html#title" class="tsd-kind-icon">title</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubePlayList.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubePlayList.html#url" class="tsd-kind-icon">url</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubePlayList.html#videoCount" class="tsd-kind-icon">video<wbr/>Count</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_internal_.YouTubePlayList.html#videos" class="tsd-kind-icon">videos</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubePlayList.html#views" class="tsd-kind-icon">views</a></li></ul></section><section class="tsd-index-section "><h3>Accessors</h3><ul class="tsd-index-list"><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_internal_.YouTubePlayList.html#total_pages" class="tsd-kind-icon">total_<wbr/>pages</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_internal_.YouTubePlayList.html#total_videos" class="tsd-kind-icon">total_<wbr/>videos</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 tsd-is-private"><a href="_internal_.YouTubePlayList.html#__patch" class="tsd-kind-icon">__patch</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_internal_.YouTubePlayList.html#__patchSearch" class="tsd-kind-icon">__patch<wbr/>Search</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="_internal_.YouTubePlayList.html#fetch" class="tsd-kind-icon">fetch</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="_internal_.YouTubePlayList.html#next" class="tsd-kind-icon">next</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="_internal_.YouTubePlayList.html#page" class="tsd-kind-icon">page</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="_internal_.YouTubePlayList.html#toJSON" class="tsd-kind-icon">toJSON</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 id="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/>You<wbr/>Tube<wbr/>Play<wbr/>List<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, searchResult<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.YouTubePlayList.html" class="tsd-signature-type" data-tsd-kind="Class">YouTubePlayList</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Playlist.ts#L76">play-dl/YouTube/classes/Playlist.ts:76</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Constructor for YouTube Playlist Class</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>data: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Json Parsed YouTube Playlist data</p>
</div></div></li><li><h5>searchResult: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>If the data is from search or not</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.YouTubePlayList.html" class="tsd-signature-type" data-tsd-kind="Class">YouTubePlayList</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 tsd-is-private"><a id="__count" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> __count</h3><div class="tsd-signature tsd-kind-icon">__count<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Playlist.ts#L70">play-dl/YouTube/classes/Playlist.ts:70</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Total no of pages count.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="_continuation" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> _continuation</h3><div class="tsd-signature tsd-kind-icon">_continuation<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>api<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>clientVersion<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>token<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></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Playlist.ts#L62">play-dl/YouTube/classes/Playlist.ts:62</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Token containing API key, Token, ClientVersion.</p>
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> api<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> client<wbr/>Version<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> token<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="channel" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> channel</h3><div class="tsd-signature tsd-kind-icon">channel<span class="tsd-signature-symbol">?:</span> <a href="_internal_.YouTubeChannel.html" class="tsd-signature-type" data-tsd-kind="Class">YouTubeChannel</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Playlist.ts#L46">play-dl/YouTube/classes/Playlist.ts:46</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube Playlist channel data</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="fetched_videos" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> fetched_<wbr/>videos</h3><div class="tsd-signature tsd-kind-icon">fetched_<wbr/>videos<span class="tsd-signature-symbol">:</span> <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace">&lt;internal&gt;</a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Map-1" class="tsd-signature-type" data-tsd-kind="Variable">Map</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="_internal_.YouTubeVideo.html" class="tsd-signature-type" data-tsd-kind="Class">YouTubeVideo</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Playlist.ts#L58">play-dl/YouTube/classes/Playlist.ts:58</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Map contaning data of all fetched videos</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="id" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3><div class="tsd-signature tsd-kind-icon">id<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/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Playlist.ts#L14">play-dl/YouTube/classes/Playlist.ts:14</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube Playlist ID</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="lastUpdate" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> last<wbr/>Update</h3><div class="tsd-signature tsd-kind-icon">last<wbr/>Update<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/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Playlist.ts#L30">play-dl/YouTube/classes/Playlist.ts:30</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Time when playlist was last updated</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="link" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> link</h3><div class="tsd-signature tsd-kind-icon">link<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/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Playlist.ts#L42">play-dl/YouTube/classes/Playlist.ts:42</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube Playlist url with starting video url.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="thumbnail" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> thumbnail</h3><div class="tsd-signature tsd-kind-icon">thumbnail<span class="tsd-signature-symbol">?:</span> <a href="_internal_.YouTubeThumbnail.html" class="tsd-signature-type" data-tsd-kind="Class">YouTubeThumbnail</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Playlist.ts#L50">play-dl/YouTube/classes/Playlist.ts:50</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube Playlist thumbnail Data</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="title" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> title</h3><div class="tsd-signature tsd-kind-icon">title<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/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Playlist.ts#L18">play-dl/YouTube/classes/Playlist.ts:18</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube Playlist Name</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="type" class="tsd-anchor"></a><h3>type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;playlist&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;channel&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;video&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Playlist.ts#L22">play-dl/YouTube/classes/Playlist.ts:22</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube Class type. == &quot;playlist&quot;</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="url" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> 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 <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Playlist.ts#L38">play-dl/YouTube/classes/Playlist.ts:38</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube Playlist url</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="videoCount" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> video<wbr/>Count</h3><div class="tsd-signature tsd-kind-icon">video<wbr/>Count<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Playlist.ts#L26">play-dl/YouTube/classes/Playlist.ts:26</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Total no of videos in that playlist</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="videos" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagOptional">Optional</span> videos</h3><div class="tsd-signature tsd-kind-icon">videos<span class="tsd-signature-symbol">?:</span> <a href="_internal_.YouTubeVideo.html" class="tsd-signature-type" data-tsd-kind="Class">YouTubeVideo</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Playlist.ts#L54">play-dl/YouTube/classes/Playlist.ts:54</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Videos array containing data of first 100 videos</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="views" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> views</h3><div class="tsd-signature tsd-kind-icon">views<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Playlist.ts#L34">play-dl/YouTube/classes/Playlist.ts:34</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Total views of that playlist</p>
</div></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Accessors</h2><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a id="total_pages" class="tsd-anchor"></a><h3>total_<wbr/>pages</h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> total_pages<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Playlist.ts#L217">play-dl/YouTube/classes/Playlist.ts:217</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Gets total no of pages in that playlist class.</p>
</div><div><p>For getting all songs in a playlist</p>
<pre><code class="language-ts"><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-6">playlist</span><span class="hl-0"> = </span><span class="hl-3">play</span><span class="hl-0">.</span><span class="hl-7">playlist_info</span><span class="hl-0">(</span><span class="hl-4">&#39;playlist url&#39;</span><span class="hl-0">);</span><br/><br/><span class="hl-1">await</span><span class="hl-0"> </span><span class="hl-3">playlist</span><span class="hl-0">.</span><span class="hl-7">fetch</span><span class="hl-0">();</span><br/><br/><span class="hl-2">let</span><span class="hl-0"> </span><span class="hl-3">result</span><span class="hl-0"> = [];</span><br/><br/><span class="hl-1">for</span><span class="hl-0"> (</span><span class="hl-2">let</span><span class="hl-0"> </span><span class="hl-3">i</span><span class="hl-0"> = </span><span class="hl-8">0</span><span class="hl-0">; </span><span class="hl-3">i</span><span class="hl-0"> &lt;= </span><span class="hl-3">playlist</span><span class="hl-0">.</span><span class="hl-3">total_pages</span><span class="hl-0">;</span><span class="hl-3">i</span><span class="hl-0">++) {</span><br/><span class="hl-0"> </span><span class="hl-3">result</span><span class="hl-0">.</span><span class="hl-7">push</span><span class="hl-0">(</span><span class="hl-3">playlist</span><span class="hl-0">.</span><span class="hl-7">page</span><span class="hl-0">(</span><span class="hl-3">i</span><span class="hl-0">));</span><br/><span class="hl-0">}</span>
</code></pre>
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a id="total_videos" class="tsd-anchor"></a><h3>total_<wbr/>videos</h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> total_videos<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Playlist.ts#L225">play-dl/YouTube/classes/Playlist.ts:225</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>This tells total no of videos that have been fetched so far.</p>
</div><div><p>This can be equal to videosCount if all videos in playlist have been fetched and they are not hidden.</p>
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></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 tsd-is-private"><a id="__patch" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> __patch</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">__patch<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Playlist.ts#L88">play-dl/YouTube/classes/Playlist.ts:88</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Updates variable according to a normal data.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>data: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Json Parsed YouTube Playlist data</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="__patchSearch" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> __patch<wbr/>Search</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">__patch<wbr/>Search<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Playlist.ts#L109">play-dl/YouTube/classes/Playlist.ts:109</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Updates variable according to a searched data.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>data: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Json Parsed YouTube Playlist data</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="fetch" class="tsd-anchor"></a><h3>fetch</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">fetch<span class="tsd-signature-symbol">(</span>max<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace">&lt;internal&gt;</a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Promise-1" class="tsd-signature-type" data-tsd-kind="Variable">Promise</a><span class="tsd-signature-symbol">&lt;</span><a href="_internal_.YouTubePlayList.html" class="tsd-signature-type" data-tsd-kind="Class">YouTubePlayList</a><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/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Playlist.ts#L165">play-dl/YouTube/classes/Playlist.ts:165</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Fetches remaining data from playlist</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>max: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = Infinity</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Max no of videos to fetch</p>
<p>Default = Infinity</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace">&lt;internal&gt;</a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Promise-1" class="tsd-signature-type" data-tsd-kind="Variable">Promise</a><span class="tsd-signature-symbol">&lt;</span><a href="_internal_.YouTubePlayList.html" class="tsd-signature-type" data-tsd-kind="Class">YouTubePlayList</a><span class="tsd-signature-symbol">&gt;</span></h4><div></div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="next" class="tsd-anchor"></a><h3>next</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">next<span class="tsd-signature-symbol">(</span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace">&lt;internal&gt;</a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Promise-1" class="tsd-signature-type" data-tsd-kind="Variable">Promise</a><span class="tsd-signature-symbol">&lt;</span><a href="_internal_.YouTubeVideo.html" class="tsd-signature-type" data-tsd-kind="Class">YouTubeVideo</a><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/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Playlist.ts#L128">play-dl/YouTube/classes/Playlist.ts:128</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Parses next segment of videos from playlist and returns parsed data.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>limit: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = Infinity</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Total no of videos to parse.</p>
<p>Default = Infinity</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace">&lt;internal&gt;</a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Promise-1" class="tsd-signature-type" data-tsd-kind="Variable">Promise</a><span class="tsd-signature-symbol">&lt;</span><a href="_internal_.YouTubeVideo.html" class="tsd-signature-type" data-tsd-kind="Class">YouTubeVideo</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4><div><p>Array of YouTube Video Class</p>
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="page" class="tsd-anchor"></a><h3>page</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">page<span class="tsd-signature-symbol">(</span>number<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.YouTubeVideo.html" class="tsd-signature-type" data-tsd-kind="Class">YouTubeVideo</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 <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Playlist.ts#L195">play-dl/YouTube/classes/Playlist.ts:195</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube Playlist is divided into pages.</p>
</div><div><p>For example, if you want to get 101 - 200 songs</p>
<pre><code class="language-ts"><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-6">playlist</span><span class="hl-0"> = </span><span class="hl-3">play</span><span class="hl-0">.</span><span class="hl-7">playlist_info</span><span class="hl-0">(</span><span class="hl-4">&#39;playlist url&#39;</span><span class="hl-0">)</span><br/><br/><span class="hl-1">await</span><span class="hl-0"> </span><span class="hl-3">playlist</span><span class="hl-0">.</span><span class="hl-7">fetch</span><span class="hl-0">()</span><br/><br/><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-6">result</span><span class="hl-0"> = </span><span class="hl-3">playlist</span><span class="hl-0">.</span><span class="hl-7">page</span><span class="hl-0">(</span><span class="hl-8">2</span><span class="hl-0">)</span>
</code></pre>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>number: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Page number</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.YouTubeVideo.html" class="tsd-signature-type" data-tsd-kind="Class">YouTubeVideo</a><span class="tsd-signature-symbol">[]</span></h4><div><p>Array of YouTube Video Class</p>
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="toJSON" class="tsd-anchor"></a><h3>toJSON</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">toJSON<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_internal_.PlaylistJSON.html" class="tsd-signature-type" data-tsd-kind="Interface">PlaylistJSON</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Playlist.ts#L233">play-dl/YouTube/classes/Playlist.ts:233</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Converts Playlist Class to a json parsed data.</p>
</div></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/_internal_.PlaylistJSON.html" class="tsd-signature-type" data-tsd-kind="Interface">PlaylistJSON</a></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=""><a href="../modules.html">Exports</a></li><li class="current tsd-kind-namespace"><a href="../modules/_internal_.html">&lt;internal&gt;</a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_._node_stream_consumers_.html">&quot;node:stream/consumers&quot;</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_._node_stream_promises_.html">&quot;node:stream/promises&quot;</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_.EventEmitter.html">Event<wbr/>Emitter</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_.internal.html">internal</a></li></ul></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class tsd-parent-kind-namespace"><a href="_internal_.YouTubePlayList.html" class="tsd-kind-icon">You<wbr/>Tube<wbr/>Play<wbr/>List</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_internal_.YouTubePlayList.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_internal_.YouTubePlayList.html#__count" class="tsd-kind-icon">__count</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_internal_.YouTubePlayList.html#_continuation" class="tsd-kind-icon">_continuation</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubePlayList.html#channel" class="tsd-kind-icon">channel</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_internal_.YouTubePlayList.html#fetched_videos" class="tsd-kind-icon">fetched_<wbr/>videos</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubePlayList.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubePlayList.html#lastUpdate" class="tsd-kind-icon">last<wbr/>Update</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubePlayList.html#link" class="tsd-kind-icon">link</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubePlayList.html#thumbnail" class="tsd-kind-icon">thumbnail</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubePlayList.html#title" class="tsd-kind-icon">title</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubePlayList.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubePlayList.html#url" class="tsd-kind-icon">url</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubePlayList.html#videoCount" class="tsd-kind-icon">video<wbr/>Count</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_internal_.YouTubePlayList.html#videos" class="tsd-kind-icon">videos</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubePlayList.html#views" class="tsd-kind-icon">views</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_internal_.YouTubePlayList.html#total_pages" class="tsd-kind-icon">total_<wbr/>pages</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_internal_.YouTubePlayList.html#total_videos" class="tsd-kind-icon">total_<wbr/>videos</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_internal_.YouTubePlayList.html#__patch" class="tsd-kind-icon">__patch</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_internal_.YouTubePlayList.html#__patchSearch" class="tsd-kind-icon">__patch<wbr/>Search</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="_internal_.YouTubePlayList.html#fetch" class="tsd-kind-icon">fetch</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="_internal_.YouTubePlayList.html#next" class="tsd-kind-icon">next</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="_internal_.YouTubePlayList.html#page" class="tsd-kind-icon">page</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="_internal_.YouTubePlayList.html#toJSON" class="tsd-kind-icon">toJSON</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-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><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>
Reference in New Issue View Git Blame Copy Permalink