docs update
This commit is contained in:
parent
91b899bf1c
commit
8ba5726f12
1
gh-pages/.nojekyll
Normal file
1
gh-pages/.nojekyll
Normal file
@ -0,0 +1 @@
|
||||
TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.
|
||||
120
gh-pages/assets/highlight.css
Normal file
120
gh-pages/assets/highlight.css
Normal file
@ -0,0 +1,120 @@
|
||||
:root {
|
||||
--light-hl-0: #000000;
|
||||
--dark-hl-0: #D4D4D4;
|
||||
--light-hl-1: #AF00DB;
|
||||
--dark-hl-1: #C586C0;
|
||||
--light-hl-2: #0000FF;
|
||||
--dark-hl-2: #569CD6;
|
||||
--light-hl-3: #001080;
|
||||
--dark-hl-3: #9CDCFE;
|
||||
--light-hl-4: #A31515;
|
||||
--dark-hl-4: #CE9178;
|
||||
--light-hl-5: #008000;
|
||||
--dark-hl-5: #6A9955;
|
||||
--light-hl-6: #0070C1;
|
||||
--dark-hl-6: #4FC1FF;
|
||||
--light-hl-7: #795E26;
|
||||
--dark-hl-7: #DCDCAA;
|
||||
--light-hl-8: #098658;
|
||||
--dark-hl-8: #B5CEA8;
|
||||
--light-hl-9: #267F99;
|
||||
--dark-hl-9: #4EC9B0;
|
||||
--light-hl-10: #000000FF;
|
||||
--dark-hl-10: #D4D4D4;
|
||||
--light-hl-11: #811F3F;
|
||||
--dark-hl-11: #D16969;
|
||||
--light-hl-12: #EE0000;
|
||||
--dark-hl-12: #D7BA7D;
|
||||
--light-hl-13: #000000;
|
||||
--dark-hl-13: #C8C8C8;
|
||||
--light-code-background: #FFFFFF;
|
||||
--dark-code-background: #1E1E1E;
|
||||
}
|
||||
|
||||
@media (prefers-color-scheme: light) { :root {
|
||||
--hl-0: var(--light-hl-0);
|
||||
--hl-1: var(--light-hl-1);
|
||||
--hl-2: var(--light-hl-2);
|
||||
--hl-3: var(--light-hl-3);
|
||||
--hl-4: var(--light-hl-4);
|
||||
--hl-5: var(--light-hl-5);
|
||||
--hl-6: var(--light-hl-6);
|
||||
--hl-7: var(--light-hl-7);
|
||||
--hl-8: var(--light-hl-8);
|
||||
--hl-9: var(--light-hl-9);
|
||||
--hl-10: var(--light-hl-10);
|
||||
--hl-11: var(--light-hl-11);
|
||||
--hl-12: var(--light-hl-12);
|
||||
--hl-13: var(--light-hl-13);
|
||||
--code-background: var(--light-code-background);
|
||||
} }
|
||||
|
||||
@media (prefers-color-scheme: dark) { :root {
|
||||
--hl-0: var(--dark-hl-0);
|
||||
--hl-1: var(--dark-hl-1);
|
||||
--hl-2: var(--dark-hl-2);
|
||||
--hl-3: var(--dark-hl-3);
|
||||
--hl-4: var(--dark-hl-4);
|
||||
--hl-5: var(--dark-hl-5);
|
||||
--hl-6: var(--dark-hl-6);
|
||||
--hl-7: var(--dark-hl-7);
|
||||
--hl-8: var(--dark-hl-8);
|
||||
--hl-9: var(--dark-hl-9);
|
||||
--hl-10: var(--dark-hl-10);
|
||||
--hl-11: var(--dark-hl-11);
|
||||
--hl-12: var(--dark-hl-12);
|
||||
--hl-13: var(--dark-hl-13);
|
||||
--code-background: var(--dark-code-background);
|
||||
} }
|
||||
|
||||
body.light {
|
||||
--hl-0: var(--light-hl-0);
|
||||
--hl-1: var(--light-hl-1);
|
||||
--hl-2: var(--light-hl-2);
|
||||
--hl-3: var(--light-hl-3);
|
||||
--hl-4: var(--light-hl-4);
|
||||
--hl-5: var(--light-hl-5);
|
||||
--hl-6: var(--light-hl-6);
|
||||
--hl-7: var(--light-hl-7);
|
||||
--hl-8: var(--light-hl-8);
|
||||
--hl-9: var(--light-hl-9);
|
||||
--hl-10: var(--light-hl-10);
|
||||
--hl-11: var(--light-hl-11);
|
||||
--hl-12: var(--light-hl-12);
|
||||
--hl-13: var(--light-hl-13);
|
||||
--code-background: var(--light-code-background);
|
||||
}
|
||||
|
||||
body.dark {
|
||||
--hl-0: var(--dark-hl-0);
|
||||
--hl-1: var(--dark-hl-1);
|
||||
--hl-2: var(--dark-hl-2);
|
||||
--hl-3: var(--dark-hl-3);
|
||||
--hl-4: var(--dark-hl-4);
|
||||
--hl-5: var(--dark-hl-5);
|
||||
--hl-6: var(--dark-hl-6);
|
||||
--hl-7: var(--dark-hl-7);
|
||||
--hl-8: var(--dark-hl-8);
|
||||
--hl-9: var(--dark-hl-9);
|
||||
--hl-10: var(--dark-hl-10);
|
||||
--hl-11: var(--dark-hl-11);
|
||||
--hl-12: var(--dark-hl-12);
|
||||
--hl-13: var(--dark-hl-13);
|
||||
--code-background: var(--dark-code-background);
|
||||
}
|
||||
|
||||
.hl-0 { color: var(--hl-0); }
|
||||
.hl-1 { color: var(--hl-1); }
|
||||
.hl-2 { color: var(--hl-2); }
|
||||
.hl-3 { color: var(--hl-3); }
|
||||
.hl-4 { color: var(--hl-4); }
|
||||
.hl-5 { color: var(--hl-5); }
|
||||
.hl-6 { color: var(--hl-6); }
|
||||
.hl-7 { color: var(--hl-7); }
|
||||
.hl-8 { color: var(--hl-8); }
|
||||
.hl-9 { color: var(--hl-9); }
|
||||
.hl-10 { color: var(--hl-10); }
|
||||
.hl-11 { color: var(--hl-11); }
|
||||
.hl-12 { color: var(--hl-12); }
|
||||
.hl-13 { color: var(--hl-13); }
|
||||
pre, code { background: var(--code-background); }
|
||||
1043
gh-pages/assets/icons.css
Normal file
1043
gh-pages/assets/icons.css
Normal file
File diff suppressed because it is too large
Load Diff
BIN
gh-pages/assets/icons.png
Normal file
BIN
gh-pages/assets/icons.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 9.4 KiB |
BIN
gh-pages/assets/icons@2x.png
Normal file
BIN
gh-pages/assets/icons@2x.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 28 KiB |
52
gh-pages/assets/main.js
Normal file
52
gh-pages/assets/main.js
Normal file
File diff suppressed because one or more lines are too long
1
gh-pages/assets/search.js
Normal file
1
gh-pages/assets/search.js
Normal file
File diff suppressed because one or more lines are too long
1388
gh-pages/assets/style.css
Normal file
1388
gh-pages/assets/style.css
Normal file
File diff suppressed because it is too large
Load Diff
BIN
gh-pages/assets/widgets.png
Normal file
BIN
gh-pages/assets/widgets.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 480 B |
BIN
gh-pages/assets/widgets@2x.png
Normal file
BIN
gh-pages/assets/widgets@2x.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 855 B |
7
gh-pages/classes/_internal_.DeezerAlbum.html
Normal file
7
gh-pages/classes/_internal_.DeezerAlbum.html
Normal file
File diff suppressed because one or more lines are too long
1
gh-pages/classes/_internal_.DeezerArtist.html
Normal file
1
gh-pages/classes/_internal_.DeezerArtist.html
Normal file
File diff suppressed because one or more lines are too long
6
gh-pages/classes/_internal_.DeezerPlaylist.html
Normal file
6
gh-pages/classes/_internal_.DeezerPlaylist.html
Normal file
File diff suppressed because one or more lines are too long
7
gh-pages/classes/_internal_.DeezerTrack.html
Normal file
7
gh-pages/classes/_internal_.DeezerTrack.html
Normal file
File diff suppressed because one or more lines are too long
1
gh-pages/classes/_internal_.DeezerTrackAlbum.html
Normal file
1
gh-pages/classes/_internal_.DeezerTrackAlbum.html
Normal file
File diff suppressed because one or more lines are too long
403
gh-pages/classes/_internal_.Duplex.html
Normal file
403
gh-pages/classes/_internal_.Duplex.html
Normal file
File diff suppressed because one or more lines are too long
213
gh-pages/classes/_internal_.EventEmitter-1.html
Normal file
213
gh-pages/classes/_internal_.EventEmitter-1.html
Normal file
File diff suppressed because one or more lines are too long
477
gh-pages/classes/_internal_.IncomingMessage.html
Normal file
477
gh-pages/classes/_internal_.IncomingMessage.html
Normal file
File diff suppressed because one or more lines are too long
1
gh-pages/classes/_internal_.LiveStreaming.html
Normal file
1
gh-pages/classes/_internal_.LiveStreaming.html
Normal file
File diff suppressed because one or more lines are too long
370
gh-pages/classes/_internal_.Readable.html
Normal file
370
gh-pages/classes/_internal_.Readable.html
Normal file
File diff suppressed because one or more lines are too long
511
gh-pages/classes/_internal_.Socket.html
Normal file
511
gh-pages/classes/_internal_.Socket.html
Normal file
File diff suppressed because one or more lines are too long
3
gh-pages/classes/_internal_.SoundCloudPlaylist.html
Normal file
3
gh-pages/classes/_internal_.SoundCloudPlaylist.html
Normal file
File diff suppressed because one or more lines are too long
3
gh-pages/classes/_internal_.SoundCloudTrack.html
Normal file
3
gh-pages/classes/_internal_.SoundCloudTrack.html
Normal file
File diff suppressed because one or more lines are too long
3
gh-pages/classes/_internal_.SpotifyAlbum.html
Normal file
3
gh-pages/classes/_internal_.SpotifyAlbum.html
Normal file
File diff suppressed because one or more lines are too long
3
gh-pages/classes/_internal_.SpotifyPlaylist.html
Normal file
3
gh-pages/classes/_internal_.SpotifyPlaylist.html
Normal file
File diff suppressed because one or more lines are too long
3
gh-pages/classes/_internal_.SpotifyTrack.html
Normal file
3
gh-pages/classes/_internal_.SpotifyTrack.html
Normal file
File diff suppressed because one or more lines are too long
3
gh-pages/classes/_internal_.Stream-1.html
Normal file
3
gh-pages/classes/_internal_.Stream-1.html
Normal file
File diff suppressed because one or more lines are too long
205
gh-pages/classes/_internal_.Stream-2.html
Normal file
205
gh-pages/classes/_internal_.Stream-2.html
Normal file
File diff suppressed because one or more lines are too long
3
gh-pages/classes/_internal_.Stream.html
Normal file
3
gh-pages/classes/_internal_.Stream.html
Normal file
File diff suppressed because one or more lines are too long
1
gh-pages/classes/_internal_.Timer.html
Normal file
1
gh-pages/classes/_internal_.Timer.html
Normal file
File diff suppressed because one or more lines are too long
7
gh-pages/classes/_internal_.YouTubeChannel.html
Normal file
7
gh-pages/classes/_internal_.YouTubeChannel.html
Normal file
File diff suppressed because one or more lines are too long
3
gh-pages/classes/_internal_.YouTubePlayList.html
Normal file
3
gh-pages/classes/_internal_.YouTubePlayList.html
Normal file
File diff suppressed because one or more lines are too long
3
gh-pages/classes/_internal_.YouTubeVideo.html
Normal file
3
gh-pages/classes/_internal_.YouTubeVideo.html
Normal file
File diff suppressed because one or more lines are too long
205
gh-pages/classes/_internal_.internal-1.html
Normal file
205
gh-pages/classes/_internal_.internal-1.html
Normal file
File diff suppressed because one or more lines are too long
403
gh-pages/classes/_internal_.internal.Duplex.html
Normal file
403
gh-pages/classes/_internal_.internal.Duplex.html
Normal file
File diff suppressed because one or more lines are too long
397
gh-pages/classes/_internal_.internal.PassThrough.html
Normal file
397
gh-pages/classes/_internal_.internal.PassThrough.html
Normal file
File diff suppressed because one or more lines are too long
370
gh-pages/classes/_internal_.internal.Readable.html
Normal file
370
gh-pages/classes/_internal_.internal.Readable.html
Normal file
File diff suppressed because one or more lines are too long
205
gh-pages/classes/_internal_.internal.Stream.html
Normal file
205
gh-pages/classes/_internal_.internal.Stream.html
Normal file
File diff suppressed because one or more lines are too long
404
gh-pages/classes/_internal_.internal.Transform.html
Normal file
404
gh-pages/classes/_internal_.internal.Transform.html
Normal file
File diff suppressed because one or more lines are too long
312
gh-pages/classes/_internal_.internal.Writable.html
Normal file
312
gh-pages/classes/_internal_.internal.Writable.html
Normal file
File diff suppressed because one or more lines are too long
1
gh-pages/enums/_internal_.StreamType.html
Normal file
1
gh-pages/enums/_internal_.StreamType.html
Normal file
File diff suppressed because one or more lines are too long
62
gh-pages/index.html
Normal file
62
gh-pages/index.html
Normal file
@ -0,0 +1,62 @@
|
||||
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>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"><h1>play-dl</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><div class="tsd-panel tsd-typography">
|
||||
<a href="#why-play-dl-" id="why-play-dl-" style="color: inherit; text-decoration: none;">
|
||||
<h1>Why play-dl ?</h1>
|
||||
</a>
|
||||
<p><a href="https://github.com/fent/node-ytdl-core">ytdl-core</a> has some issues with miniget and also stream abort issues. On the other hand, <a href="https://github.com/ytdl-org/youtube-dl">youtube-dl</a> is a very perfect alternative but it takes time to launch. Hence, play-dl is created to avoid these issues along with providing comparatively faster performance than others.</p>
|
||||
<p><a href="https://discord.gg/8H3xWcv3D7"><img src="https://img.shields.io/discord/888998674716315679?color=00ff00&label=%20Discord&logo=Discord" alt="Discord"></a></p>
|
||||
|
||||
<a href="#support" id="support" style="color: inherit; text-decoration: none;">
|
||||
<h2>Support</h2>
|
||||
</a>
|
||||
<p>You can contact us for support on our <a href="https://discord.gg/8H3xWcv3D7">chat server</a></p>
|
||||
|
||||
<a href="#stream-videosplaylists-or-search-for-videos" id="stream-videosplaylists-or-search-for-videos" style="color: inherit; text-decoration: none;">
|
||||
<h2>Stream videos/playlists or search for videos</h2>
|
||||
</a>
|
||||
<p>This is a <strong>light-weight</strong> youtube downloader and searcher.</p>
|
||||
<ul>
|
||||
<li>searches by video, playlist, channel</li>
|
||||
<li>obtains audio playback url</li>
|
||||
</ul>
|
||||
|
||||
<a href="#installation" id="installation" style="color: inherit; text-decoration: none;">
|
||||
<h3>Installation</h3>
|
||||
</a>
|
||||
<pre><code class="language-bash"><span class="hl-0">npm install play-dl@latest</span>
|
||||
</code></pre>
|
||||
|
||||
<a href="#importing" id="importing" style="color: inherit; text-decoration: none;">
|
||||
<h3>Importing</h3>
|
||||
</a>
|
||||
<pre><code class="language-ts"><span class="hl-1">import</span><span class="hl-0"> </span><span class="hl-2">*</span><span class="hl-0"> </span><span class="hl-1">as</span><span class="hl-0"> </span><span class="hl-3">play</span><span class="hl-0"> </span><span class="hl-1">from</span><span class="hl-0"> </span><span class="hl-4">'play-dl'</span><span class="hl-0"> </span><span class="hl-5">// ES-6 import or TS import</span><br/><br/><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-6">play</span><span class="hl-0"> = </span><span class="hl-7">require</span><span class="hl-0">(</span><span class="hl-4">'play-dl'</span><span class="hl-0">) </span><span class="hl-5">//JS importing</span>
|
||||
</code></pre>
|
||||
|
||||
<a href="#instructions" id="instructions" style="color: inherit; text-decoration: none;">
|
||||
<h2>Instructions</h2>
|
||||
</a>
|
||||
<ul>
|
||||
<li>1.0 release change brings some code changes, make sure to read docs once again.</li>
|
||||
<li><a href="https://github.com/play-dl/play-dl/discussions/64">Spotify</a></li>
|
||||
<li><a href="https://github.com/play-dl/play-dl/discussions/92">SoundCloud</a></li>
|
||||
</ul>
|
||||
|
||||
<a href="#examples" id="examples" style="color: inherit; text-decoration: none;">
|
||||
<h3>Examples</h3>
|
||||
</a>
|
||||
<ul>
|
||||
<li><a href="https://github.com/play-dl/play-dl/tree/main/examples/YouTube">YouTube</a></li>
|
||||
<li><a href="https://github.com/play-dl/play-dl/tree/main/examples/Spotify">Spotify</a></li>
|
||||
<li><a href="https://github.com/play-dl/play-dl/tree/main/examples/SoundCloud">SoundCloud</a></li>
|
||||
</ul>
|
||||
|
||||
<a href="#docs" id="docs" style="color: inherit; text-decoration: none;">
|
||||
<h3>Docs</h3>
|
||||
</a>
|
||||
<ul>
|
||||
<li><a href="https://github.com/play-dl/play-dl/tree/main/docs#play-dl-commands">Main</a></li>
|
||||
<li><a href="https://github.com/play-dl/play-dl/tree/main/docs/YouTube#youtube">YouTube</a></li>
|
||||
<li><a href="https://github.com/play-dl/play-dl/tree/main/docs/Spotify#spotify">Spotify</a></li>
|
||||
<li><a href="https://github.com/play-dl/play-dl/tree/main/docs/SoundCloud">SoundCloud</a></li>
|
||||
<li><a href="https://github.com/play-dl/play-dl/tree/main/docs/Deezer">Deezer</a></li>
|
||||
</ul>
|
||||
</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><li class=" tsd-kind-namespace"><a href="modules/_internal_.html"><internal></a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-type-alias"><a href="modules.html#Deezer" class="tsd-kind-icon">Deezer</a></li><li class="tsd-kind-type-alias"><a href="modules.html#SoundCloud" class="tsd-kind-icon">Sound<wbr/>Cloud</a></li><li class="tsd-kind-type-alias"><a href="modules.html#SoundCloudStream" class="tsd-kind-icon">Sound<wbr/>Cloud<wbr/>Stream</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Spotify" class="tsd-kind-icon">Spotify</a></li><li class="tsd-kind-type-alias"><a href="modules.html#YouTube" class="tsd-kind-icon">You<wbr/>Tube</a></li><li class="tsd-kind-type-alias"><a href="modules.html#YouTubeStream" class="tsd-kind-icon">You<wbr/>Tube<wbr/>Stream</a></li><li class="tsd-kind-function"><a href="modules.html#attachListeners" class="tsd-kind-icon">attach<wbr/>Listeners</a></li><li class="tsd-kind-function"><a href="modules.html#authorization" class="tsd-kind-icon">authorization</a></li><li class="tsd-kind-function"><a href="modules.html#cookieHeaders" class="tsd-kind-icon">cookie<wbr/>Headers</a></li><li class="tsd-kind-function"><a href="modules.html#decipher_info" class="tsd-kind-icon">decipher_<wbr/>info</a></li><li class="tsd-kind-function"><a href="modules.html#deezer" class="tsd-kind-icon">deezer</a></li><li class="tsd-kind-function"><a href="modules.html#dz_advanced_track_search" class="tsd-kind-icon">dz_<wbr/>advanced_<wbr/>track_<wbr/>search</a></li><li class="tsd-kind-function"><a href="modules.html#dz_search" class="tsd-kind-icon">dz_<wbr/>search</a></li><li class="tsd-kind-function"><a href="modules.html#dz_validate" class="tsd-kind-icon">dz_<wbr/>validate</a></li><li class="tsd-kind-function"><a href="modules.html#extractID" class="tsd-kind-icon">extractID</a></li><li class="tsd-kind-function"><a href="modules.html#getFreeClientID" class="tsd-kind-icon">get<wbr/>Free<wbr/>ClientID</a></li><li class="tsd-kind-function"><a href="modules.html#is_expired" class="tsd-kind-icon">is_<wbr/>expired</a></li><li class="tsd-kind-function"><a href="modules.html#playlist_info" class="tsd-kind-icon">playlist_<wbr/>info</a></li><li class="tsd-kind-function"><a href="modules.html#refreshToken" class="tsd-kind-icon">refresh<wbr/>Token</a></li><li class="tsd-kind-function"><a href="modules.html#search" class="tsd-kind-icon">search</a></li><li class="tsd-kind-function"><a href="modules.html#setToken" class="tsd-kind-icon">set<wbr/>Token</a></li><li class="tsd-kind-function"><a href="modules.html#so_validate" class="tsd-kind-icon">so_<wbr/>validate</a></li><li class="tsd-kind-function"><a href="modules.html#soundcloud" class="tsd-kind-icon">soundcloud</a></li><li class="tsd-kind-function"><a href="modules.html#sp_validate" class="tsd-kind-icon">sp_<wbr/>validate</a></li><li class="tsd-kind-function"><a href="modules.html#spotify" class="tsd-kind-icon">spotify</a></li><li class="tsd-kind-function"><a href="modules.html#stream" class="tsd-kind-icon">stream</a></li><li class="tsd-kind-function"><a href="modules.html#stream_from_info" class="tsd-kind-icon">stream_<wbr/>from_<wbr/>info</a></li><li class="tsd-kind-function"><a href="modules.html#validate" class="tsd-kind-icon">validate</a></li><li class="tsd-kind-function"><a href="modules.html#video_basic_info" class="tsd-kind-icon">video_<wbr/>basic_<wbr/>info</a></li><li class="tsd-kind-function"><a href="modules.html#video_info" class="tsd-kind-icon">video_<wbr/>info</a></li><li class="tsd-kind-function"><a href="modules.html#yt_validate" class="tsd-kind-icon">yt_<wbr/>validate</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><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>
|
||||
5
gh-pages/interfaces/_internal_.AbortSignal.html
Normal file
5
gh-pages/interfaces/_internal_.AbortSignal.html
Normal file
@ -0,0 +1,5 @@
|
||||
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AbortSignal | 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"><internal></a></li><li><a href="_internal_.AbortSignal.html">AbortSignal</a></li></ul><h1>Interface AbortSignal</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>A signal object that allows you to communicate with a DOM request (such as a Fetch) and abort it if required via an AbortController object.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">AbortSignal</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 tsd-is-external"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.AbortSignal.html#aborted" class="tsd-kind-icon">aborted</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group tsd-is-external"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a id="aborted" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> aborted</h3><div class="tsd-signature tsd-kind-icon">aborted<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/globals.d.ts:64</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Returns true if this AbortSignal's AbortController has signaled to abort, and false otherwise.</p>
|
||||
</div></div></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"><internal></a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_._node_stream_consumers_.html">"node:stream/consumers"</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_._node_stream_promises_.html">"node:stream/promises"</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-interface tsd-parent-kind-namespace tsd-is-external"><a href="_internal_.AbortSignal.html" class="tsd-kind-icon">Abort<wbr/>Signal</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.AbortSignal.html#aborted" class="tsd-kind-icon">aborted</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><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
gh-pages/interfaces/_internal_.AddressInfo.html
Normal file
1
gh-pages/interfaces/_internal_.AddressInfo.html
Normal file
File diff suppressed because one or more lines are too long
10
gh-pages/interfaces/_internal_.ArrayBuffer.html
Normal file
10
gh-pages/interfaces/_internal_.ArrayBuffer.html
Normal file
@ -0,0 +1,10 @@
|
||||
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ArrayBuffer | 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"><internal></a></li><li><a href="_internal_.ArrayBuffer.html">ArrayBuffer</a></li></ul><h1>Interface ArrayBuffer</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>Represents a raw buffer of binary data, which is used to store data for the
|
||||
different typed arrays. ArrayBuffers cannot be read from or written to directly,
|
||||
but can be passed to a typed array or DataView Object to interpret the raw
|
||||
buffer as needed.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">ArrayBuffer</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 tsd-is-external"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.ArrayBuffer.html#_toStringTag_" class="tsd-kind-icon">[to<wbr/>String<wbr/>Tag]</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.ArrayBuffer.html#byteLength" class="tsd-kind-icon">byte<wbr/>Length</a></li></ul></section><section class="tsd-index-section tsd-is-external"><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_internal_.ArrayBuffer.html#slice" class="tsd-kind-icon">slice</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group tsd-is-external"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a id="_toStringTag_" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> [to<wbr/>String<wbr/>Tag]</h3><div class="tsd-signature tsd-kind-icon">[to<wbr/>String<wbr/>Tag]<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:270</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a id="byteLength" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> byte<wbr/>Length</h3><div class="tsd-signature tsd-kind-icon">byte<wbr/>Length<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1578</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Read-only. The length of the ArrayBuffer (in bytes).</p>
|
||||
</div></div></section></section><section class="tsd-panel-group tsd-member-group tsd-is-external"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a id="slice" class="tsd-anchor"></a><h3>slice</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external"><li class="tsd-signature tsd-kind-icon">slice<span class="tsd-signature-symbol">(</span>begin<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, end<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"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#ArrayBuffer-1" class="tsd-signature-type" data-tsd-kind="Variable">ArrayBuffer</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1583</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Returns a section of an ArrayBuffer.</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>begin: <span class="tsd-signature-type">number</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> end: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#ArrayBuffer-1" class="tsd-signature-type" data-tsd-kind="Variable">ArrayBuffer</a></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><li class="current tsd-kind-namespace"><a href="../modules/_internal_.html"><internal></a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_._node_stream_consumers_.html">"node:stream/consumers"</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_._node_stream_promises_.html">"node:stream/promises"</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-interface tsd-parent-kind-namespace tsd-is-external"><a href="_internal_.ArrayBuffer.html" class="tsd-kind-icon">Array<wbr/>Buffer</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.ArrayBuffer.html#_toStringTag_" class="tsd-kind-icon">[to<wbr/>String<wbr/>Tag]</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.ArrayBuffer.html#byteLength" class="tsd-kind-icon">byte<wbr/>Length</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_internal_.ArrayBuffer.html#slice" class="tsd-kind-icon">slice</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><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>
|
||||
File diff suppressed because one or more lines are too long
3
gh-pages/interfaces/_internal_.ArrayBufferTypes.html
Normal file
3
gh-pages/interfaces/_internal_.ArrayBufferTypes.html
Normal file
@ -0,0 +1,3 @@
|
||||
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ArrayBufferTypes | 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"><internal></a></li><li><a href="_internal_.ArrayBufferTypes.html">ArrayBufferTypes</a></li></ul><h1>Interface ArrayBufferTypes</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>Allowed ArrayBuffer types for the buffer of an ArrayBufferView and related Typed Arrays.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">ArrayBufferTypes</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 tsd-is-external"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.ArrayBufferTypes.html#ArrayBuffer" class="tsd-kind-icon">Array<wbr/>Buffer</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.ArrayBufferTypes.html#SharedArrayBuffer" class="tsd-kind-icon">Shared<wbr/>Array<wbr/>Buffer</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group tsd-is-external"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a id="ArrayBuffer" class="tsd-anchor"></a><h3>Array<wbr/>Buffer</h3><div class="tsd-signature tsd-kind-icon">Array<wbr/>Buffer<span class="tsd-signature-symbol">:</span> <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#ArrayBuffer-1" class="tsd-signature-type" data-tsd-kind="Variable">ArrayBuffer</a></div><aside class="tsd-sources"><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1590</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a id="SharedArrayBuffer" class="tsd-anchor"></a><h3>Shared<wbr/>Array<wbr/>Buffer</h3><div class="tsd-signature tsd-kind-icon">Shared<wbr/>Array<wbr/>Buffer<span class="tsd-signature-symbol">:</span> <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#SharedArrayBuffer-1" class="tsd-signature-type" data-tsd-kind="Variable">SharedArrayBuffer</a></div><aside class="tsd-sources"><ul><li>Defined in node_modules/typescript/lib/lib.es2017.sharedmemory.d.ts:45</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><li class="current tsd-kind-namespace"><a href="../modules/_internal_.html"><internal></a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_._node_stream_consumers_.html">"node:stream/consumers"</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_._node_stream_promises_.html">"node:stream/promises"</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-interface tsd-parent-kind-namespace tsd-is-external"><a href="_internal_.ArrayBufferTypes.html" class="tsd-kind-icon">Array<wbr/>Buffer<wbr/>Types</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.ArrayBufferTypes.html#ArrayBuffer" class="tsd-kind-icon">Array<wbr/>Buffer</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.ArrayBufferTypes.html#SharedArrayBuffer" class="tsd-kind-icon">Shared<wbr/>Array<wbr/>Buffer</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><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>
|
||||
7
gh-pages/interfaces/_internal_.ArrayBufferView.html
Normal file
7
gh-pages/interfaces/_internal_.ArrayBufferView.html
Normal file
@ -0,0 +1,7 @@
|
||||
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ArrayBufferView | 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"><internal></a></li><li><a href="_internal_.ArrayBufferView.html">ArrayBufferView</a></li></ul><h1>Interface ArrayBufferView</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">ArrayBufferView</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 tsd-is-external"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.ArrayBufferView.html#buffer" class="tsd-kind-icon">buffer</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.ArrayBufferView.html#byteLength" class="tsd-kind-icon">byte<wbr/>Length</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.ArrayBufferView.html#byteOffset" class="tsd-kind-icon">byte<wbr/>Offset</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group tsd-is-external"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a id="buffer" class="tsd-anchor"></a><h3>buffer</h3><div class="tsd-signature tsd-kind-icon">buffer<span class="tsd-signature-symbol">:</span> <a href="../modules/_internal_.html#ArrayBufferLike" class="tsd-signature-type" data-tsd-kind="Type alias">ArrayBufferLike</a></div><aside class="tsd-sources"><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1605</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>The ArrayBuffer instance referenced by the array.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a id="byteLength" class="tsd-anchor"></a><h3>byte<wbr/>Length</h3><div class="tsd-signature tsd-kind-icon">byte<wbr/>Length<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1610</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>The length in bytes of the array.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a id="byteOffset" class="tsd-anchor"></a><h3>byte<wbr/>Offset</h3><div class="tsd-signature tsd-kind-icon">byte<wbr/>Offset<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1615</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>The offset in bytes of the array.</p>
|
||||
</div></div></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"><internal></a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_._node_stream_consumers_.html">"node:stream/consumers"</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_._node_stream_promises_.html">"node:stream/promises"</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-interface tsd-parent-kind-namespace tsd-is-external"><a href="_internal_.ArrayBufferView.html" class="tsd-kind-icon">Array<wbr/>Buffer<wbr/>View</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.ArrayBufferView.html#buffer" class="tsd-kind-icon">buffer</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.ArrayBufferView.html#byteLength" class="tsd-kind-icon">byte<wbr/>Length</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.ArrayBufferView.html#byteOffset" class="tsd-kind-icon">byte<wbr/>Offset</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><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
gh-pages/interfaces/_internal_.ArrayLike.html
Normal file
1
gh-pages/interfaces/_internal_.ArrayLike.html
Normal file
File diff suppressed because one or more lines are too long
1
gh-pages/interfaces/_internal_.AsyncGenerator.html
Normal file
1
gh-pages/interfaces/_internal_.AsyncGenerator.html
Normal file
File diff suppressed because one or more lines are too long
15
gh-pages/interfaces/_internal_.AsyncGeneratorFunction.html
Normal file
15
gh-pages/interfaces/_internal_.AsyncGeneratorFunction.html
Normal file
@ -0,0 +1,15 @@
|
||||
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AsyncGeneratorFunction | 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"><internal></a></li><li><a href="_internal_.AsyncGeneratorFunction.html">AsyncGeneratorFunction</a></li></ul><h1>Interface AsyncGeneratorFunction</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">AsyncGeneratorFunction</span></li></ul></section><section class="tsd-panel"><h3 class="tsd-before-signature">Callable</h3><ul class="tsd-signatures tsd-kind-interface tsd-parent-kind-namespace tsd-is-external"><li class="tsd-signature tsd-kind-icon">Async<wbr/>Generator<wbr/>Function<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<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-symbol">: </span><a href="_internal_.AsyncGenerator.html" class="tsd-signature-type" data-tsd-kind="Interface">AsyncGenerator</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</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 node_modules/typescript/lib/lib.es2018.asyncgenerator.d.ts:41</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Creates a new AsyncGenerator object.</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>A list of arguments the function accepts.</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.AsyncGenerator.html" class="tsd-signature-type" data-tsd-kind="Interface">AsyncGenerator</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h4></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 tsd-is-external"><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-interface tsd-is-external"><a href="_internal_.AsyncGeneratorFunction.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section tsd-is-external"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.AsyncGeneratorFunction.html#length" class="tsd-kind-icon">length</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.AsyncGeneratorFunction.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.AsyncGeneratorFunction.html#prototype" class="tsd-kind-icon">prototype</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group tsd-is-external"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-interface tsd-is-external"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-interface tsd-is-external"><li class="tsd-signature tsd-kind-icon">new <wbr/>Async<wbr/>Generator<wbr/>Function<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<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-symbol">: </span><a href="_internal_.AsyncGenerator.html" class="tsd-signature-type" data-tsd-kind="Interface">AsyncGenerator</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</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 node_modules/typescript/lib/lib.es2018.asyncgenerator.d.ts:36</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Creates a new AsyncGenerator object.</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>A list of arguments the function accepts.</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.AsyncGenerator.html" class="tsd-signature-type" data-tsd-kind="Interface">AsyncGenerator</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group tsd-is-external"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a id="length" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> length</h3><div class="tsd-signature tsd-kind-icon">length<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/typescript/lib/lib.es2018.asyncgenerator.d.ts:45</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>The length of the arguments.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a id="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/typescript/lib/lib.es2018.asyncgenerator.d.ts:49</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Returns the name of the function.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a id="prototype" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> prototype</h3><div class="tsd-signature tsd-kind-icon">prototype<span class="tsd-signature-symbol">:</span> <a href="_internal_.AsyncGenerator.html" class="tsd-signature-type" data-tsd-kind="Interface">AsyncGenerator</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/typescript/lib/lib.es2018.asyncgenerator.d.ts:53</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>A reference to the prototype.</p>
|
||||
</div></div></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"><internal></a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_._node_stream_consumers_.html">"node:stream/consumers"</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_._node_stream_promises_.html">"node:stream/promises"</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-interface tsd-parent-kind-namespace tsd-is-external"><a href="_internal_.AsyncGeneratorFunction.html" class="tsd-kind-icon">Async<wbr/>Generator<wbr/>Function</a><ul><li class="tsd-kind-constructor tsd-parent-kind-interface tsd-is-external"><a href="_internal_.AsyncGeneratorFunction.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.AsyncGeneratorFunction.html#length" class="tsd-kind-icon">length</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.AsyncGeneratorFunction.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.AsyncGeneratorFunction.html#prototype" class="tsd-kind-icon">prototype</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><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
gh-pages/interfaces/_internal_.AsyncIterable.html
Normal file
1
gh-pages/interfaces/_internal_.AsyncIterable.html
Normal file
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
1
gh-pages/interfaces/_internal_.AsyncIterator.html
Normal file
1
gh-pages/interfaces/_internal_.AsyncIterator.html
Normal file
File diff suppressed because one or more lines are too long
200
gh-pages/interfaces/_internal_.BigInt64Array.html
Normal file
200
gh-pages/interfaces/_internal_.BigInt64Array.html
Normal file
File diff suppressed because one or more lines are too long
11
gh-pages/interfaces/_internal_.BigInt64ArrayConstructor.html
Normal file
11
gh-pages/interfaces/_internal_.BigInt64ArrayConstructor.html
Normal file
File diff suppressed because one or more lines are too long
200
gh-pages/interfaces/_internal_.BigUint64Array.html
Normal file
200
gh-pages/interfaces/_internal_.BigUint64Array.html
Normal file
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
1
gh-pages/interfaces/_internal_.Blob.html
Normal file
1
gh-pages/interfaces/_internal_.Blob.html
Normal file
File diff suppressed because one or more lines are too long
718
gh-pages/interfaces/_internal_.Buffer.html
Normal file
718
gh-pages/interfaces/_internal_.Buffer.html
Normal file
File diff suppressed because one or more lines are too long
175
gh-pages/interfaces/_internal_.BufferConstructor.html
Normal file
175
gh-pages/interfaces/_internal_.BufferConstructor.html
Normal file
File diff suppressed because one or more lines are too long
34
gh-pages/interfaces/_internal_.CallSite.html
Normal file
34
gh-pages/interfaces/_internal_.CallSite.html
Normal file
File diff suppressed because one or more lines are too long
1
gh-pages/interfaces/_internal_.ChannelIconInterface.html
Normal file
1
gh-pages/interfaces/_internal_.ChannelIconInterface.html
Normal file
File diff suppressed because one or more lines are too long
5
gh-pages/interfaces/_internal_.ConnectOpts.html
Normal file
5
gh-pages/interfaces/_internal_.ConnectOpts.html
Normal file
@ -0,0 +1,5 @@
|
||||
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ConnectOpts | 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"><internal></a></li><li><a href="_internal_.ConnectOpts.html">ConnectOpts</a></li></ul><h1>Interface ConnectOpts</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">ConnectOpts</span><ul class="tsd-hierarchy"><li><a href="_internal_.TcpSocketConnectOpts.html" class="tsd-signature-type" data-tsd-kind="Interface">TcpSocketConnectOpts</a></li><li><a href="_internal_.IpcSocketConnectOpts.html" class="tsd-signature-type" data-tsd-kind="Interface">IpcSocketConnectOpts</a></li></ul></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 tsd-is-external"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.ConnectOpts.html#onread" class="tsd-kind-icon">onread</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group tsd-is-external"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a id="onread" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> onread</h3><div class="tsd-signature tsd-kind-icon">onread<span class="tsd-signature-symbol">?:</span> <a href="_internal_.OnReadOpts.html" class="tsd-signature-type" data-tsd-kind="Interface">OnReadOpts</a></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/net.d.ts:46</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>If specified, incoming data is stored in a single buffer and passed to the supplied callback when data arrives on the socket.
|
||||
Note: this will cause the streaming functionality to not provide any data, however events like 'error', 'end', and 'close' will
|
||||
still be emitted as normal and methods like pause() and resume() will also behave as expected.</p>
|
||||
</div></div></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"><internal></a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_._node_stream_consumers_.html">"node:stream/consumers"</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_._node_stream_promises_.html">"node:stream/promises"</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-interface tsd-parent-kind-namespace tsd-is-external"><a href="_internal_.ConnectOpts.html" class="tsd-kind-icon">Connect<wbr/>Opts</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.ConnectOpts.html#onread" class="tsd-kind-icon">onread</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><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
gh-pages/interfaces/_internal_.DOMEventTarget.html
Normal file
1
gh-pages/interfaces/_internal_.DOMEventTarget.html
Normal file
File diff suppressed because one or more lines are too long
135
gh-pages/interfaces/_internal_.DataView.html
Normal file
135
gh-pages/interfaces/_internal_.DataView.html
Normal file
File diff suppressed because one or more lines are too long
1
gh-pages/interfaces/_internal_.DataViewConstructor.html
Normal file
1
gh-pages/interfaces/_internal_.DataViewConstructor.html
Normal file
File diff suppressed because one or more lines are too long
185
gh-pages/interfaces/_internal_.Date.html
Normal file
185
gh-pages/interfaces/_internal_.Date.html
Normal file
File diff suppressed because one or more lines are too long
21
gh-pages/interfaces/_internal_.DateConstructor.html
Normal file
21
gh-pages/interfaces/_internal_.DateConstructor.html
Normal file
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
1
gh-pages/interfaces/_internal_.DeezerGenre.html
Normal file
1
gh-pages/interfaces/_internal_.DeezerGenre.html
Normal file
File diff suppressed because one or more lines are too long
1
gh-pages/interfaces/_internal_.DeezerImage.html
Normal file
1
gh-pages/interfaces/_internal_.DeezerImage.html
Normal file
File diff suppressed because one or more lines are too long
1
gh-pages/interfaces/_internal_.DeezerSearchOptions.html
Normal file
1
gh-pages/interfaces/_internal_.DeezerSearchOptions.html
Normal file
File diff suppressed because one or more lines are too long
1
gh-pages/interfaces/_internal_.DeezerUser.html
Normal file
1
gh-pages/interfaces/_internal_.DeezerUser.html
Normal file
File diff suppressed because one or more lines are too long
1
gh-pages/interfaces/_internal_.Dict.html
Normal file
1
gh-pages/interfaces/_internal_.Dict.html
Normal file
@ -0,0 +1 @@
|
||||
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Dict | 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"><internal></a></li><li><a href="_internal_.Dict.html">Dict</a></li></ul><h1>Interface Dict<T></h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-type-parameters"><h3>Type parameters</h3><ul class="tsd-type-parameters"><li><h4>T</h4></li></ul></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">Dict</span><ul class="tsd-hierarchy"><li><a href="_internal_.IncomingHttpHeaders.html" class="tsd-signature-type" data-tsd-kind="Interface">IncomingHttpHeaders</a></li></ul></li></ul></section><section class="tsd-panel tsd-kind-interface tsd-parent-kind-namespace tsd-has-type-parameter tsd-is-external"><h3 class="tsd-before-signature">Indexable</h3><div class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></div></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"><internal></a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_._node_stream_consumers_.html">"node:stream/consumers"</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_._node_stream_promises_.html">"node:stream/promises"</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-interface tsd-parent-kind-namespace tsd-has-type-parameter tsd-is-external"><a href="_internal_.Dict.html" class="tsd-kind-icon">Dict</a><ul></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><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
gh-pages/interfaces/_internal_.ErrnoException.html
Normal file
1
gh-pages/interfaces/_internal_.ErrnoException.html
Normal file
File diff suppressed because one or more lines are too long
1
gh-pages/interfaces/_internal_.Error.html
Normal file
1
gh-pages/interfaces/_internal_.Error.html
Normal file
File diff suppressed because one or more lines are too long
6
gh-pages/interfaces/_internal_.ErrorConstructor.html
Normal file
6
gh-pages/interfaces/_internal_.ErrorConstructor.html
Normal file
File diff suppressed because one or more lines are too long
135
gh-pages/interfaces/_internal_.EventEmitter-2.html
Normal file
135
gh-pages/interfaces/_internal_.EventEmitter-2.html
Normal file
File diff suppressed because one or more lines are too long
@ -0,0 +1,3 @@
|
||||
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Abortable | 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"><internal></a></li><li><a href="../modules/_internal_.EventEmitter.html">EventEmitter</a></li><li><a href="_internal_.EventEmitter.Abortable.html">Abortable</a></li></ul><h1>Interface Abortable</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">Abortable</span><ul class="tsd-hierarchy"><li><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.internal.html" class="tsd-signature-type" data-tsd-kind="Namespace">internal</a><span class="tsd-signature-symbol">.</span><a href="_internal_.internal.StreamOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">StreamOptions</a></li><li><a href="_internal_.internal.FinishedOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">FinishedOptions</a></li><li><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="_internal_.StreamOptions-1.html" class="tsd-signature-type" data-tsd-kind="Interface">StreamOptions</a></li></ul></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 tsd-is-external"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.EventEmitter.Abortable.html#signal" class="tsd-kind-icon">signal</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group tsd-is-external"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a id="signal" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> signal</h3><div class="tsd-signature tsd-kind-icon">signal<span class="tsd-signature-symbol">?:</span> <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#AbortSignal-1" class="tsd-signature-type" data-tsd-kind="Variable">AbortSignal</a></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/events.d.ts:289</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>When provided the corresponding <code>AbortController</code> can be used to cancel an asynchronous action.</p>
|
||||
</div></div></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"><internal></a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_._node_stream_consumers_.html">"node:stream/consumers"</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_._node_stream_promises_.html">"node:stream/promises"</a></li><li class="current 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-interface tsd-parent-kind-namespace tsd-is-external"><a href="_internal_.EventEmitter.Abortable.html" class="tsd-kind-icon">Abortable</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.EventEmitter.Abortable.html#signal" class="tsd-kind-icon">signal</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><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>
|
||||
3
gh-pages/interfaces/_internal_.EventEmitterOptions.html
Normal file
3
gh-pages/interfaces/_internal_.EventEmitterOptions.html
Normal file
@ -0,0 +1,3 @@
|
||||
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>EventEmitterOptions | 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"><internal></a></li><li><a href="_internal_.EventEmitterOptions.html">EventEmitterOptions</a></li></ul><h1>Interface EventEmitterOptions</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">EventEmitterOptions</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 tsd-is-external"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.EventEmitterOptions.html#captureRejections" class="tsd-kind-icon">capture<wbr/>Rejections</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group tsd-is-external"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a id="captureRejections" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> capture<wbr/>Rejections</h3><div class="tsd-signature tsd-kind-icon">capture<wbr/>Rejections<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/events.d.ts:42</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Enables automatic capturing of promise rejection.</p>
|
||||
</div></div></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"><internal></a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_._node_stream_consumers_.html">"node:stream/consumers"</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_._node_stream_promises_.html">"node:stream/promises"</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-interface tsd-parent-kind-namespace tsd-is-external"><a href="_internal_.EventEmitterOptions.html" class="tsd-kind-icon">Event<wbr/>Emitter<wbr/>Options</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.EventEmitterOptions.html#captureRejections" class="tsd-kind-icon">capture<wbr/>Rejections</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><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>
|
||||
204
gh-pages/interfaces/_internal_.Float32Array.html
Normal file
204
gh-pages/interfaces/_internal_.Float32Array.html
Normal file
File diff suppressed because one or more lines are too long
27
gh-pages/interfaces/_internal_.Float32ArrayConstructor.html
Normal file
27
gh-pages/interfaces/_internal_.Float32ArrayConstructor.html
Normal file
File diff suppressed because one or more lines are too long
199
gh-pages/interfaces/_internal_.Float64Array.html
Normal file
199
gh-pages/interfaces/_internal_.Float64Array.html
Normal file
File diff suppressed because one or more lines are too long
27
gh-pages/interfaces/_internal_.Float64ArrayConstructor.html
Normal file
27
gh-pages/interfaces/_internal_.Float64ArrayConstructor.html
Normal file
File diff suppressed because one or more lines are too long
31
gh-pages/interfaces/_internal_.Function.html
Normal file
31
gh-pages/interfaces/_internal_.Function.html
Normal file
@ -0,0 +1,31 @@
|
||||
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Function | 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"><internal></a></li><li><a href="_internal_.Function.html">Function</a></li></ul><h1>Interface Function</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>Creates a new function.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">Function</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 tsd-is-external"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.Function.html#arguments" class="tsd-kind-icon">arguments</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.Function.html#caller" class="tsd-kind-icon">caller</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.Function.html#length" class="tsd-kind-icon">length</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.Function.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.Function.html#prototype" class="tsd-kind-icon">prototype</a></li></ul></section><section class="tsd-index-section tsd-is-external"><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_internal_.Function.html#_hasInstance_" class="tsd-kind-icon">[has<wbr/>Instance]</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_internal_.Function.html#apply" class="tsd-kind-icon">apply</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_internal_.Function.html#bind" class="tsd-kind-icon">bind</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_internal_.Function.html#call" class="tsd-kind-icon">call</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_internal_.Function.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group tsd-is-external"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a id="arguments" class="tsd-anchor"></a><h3>arguments</h3><div class="tsd-signature tsd-kind-icon">arguments<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:302</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a id="caller" class="tsd-anchor"></a><h3>caller</h3><div class="tsd-signature tsd-kind-icon">caller<span class="tsd-signature-symbol">:</span> <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Function-1" class="tsd-signature-type" data-tsd-kind="Variable">Function</a></div><aside class="tsd-sources"><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:303</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a id="length" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> length</h3><div class="tsd-signature tsd-kind-icon">length<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:299</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a id="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/typescript/lib/lib.es2015.core.d.ts:97</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Returns the name of the function. Function names are read-only and can not be changed.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a id="prototype" class="tsd-anchor"></a><h3>prototype</h3><div class="tsd-signature tsd-kind-icon">prototype<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:298</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group tsd-is-external"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a id="_hasInstance_" class="tsd-anchor"></a><h3>[has<wbr/>Instance]</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external"><li class="tsd-signature tsd-kind-icon">[has<wbr/>Instance]<span class="tsd-signature-symbol">(</span>value<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">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:162</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Determines whether the given value inherits from this function if this function was used
|
||||
as a constructor function.</p>
|
||||
</div><div><p>A constructor function can control which objects are recognized as its instances by
|
||||
'instanceof' by overriding this method.</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>value: <span class="tsd-signature-type">any</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-interface tsd-is-external"><a id="apply" class="tsd-anchor"></a><h3>apply</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external"><li class="tsd-signature tsd-kind-icon">apply<span class="tsd-signature-symbol">(</span>thisArg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, argArray<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">any</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:278</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Calls the function, substituting the specified object for the this value of the function, and the specified array for the arguments of the function.</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>thisArg: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>The object to be used as the this object.</p>
|
||||
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> argArray: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>A set of arguments to be passed to the function.</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a id="bind" class="tsd-anchor"></a><h3>bind</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external"><li class="tsd-signature tsd-kind-icon">bind<span class="tsd-signature-symbol">(</span>thisArg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, <span class="tsd-signature-symbol">...</span>argArray<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-symbol">: </span><span class="tsd-signature-type">any</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:293</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>For a given function, creates a bound function that has the same body as the original function.
|
||||
The this object of the bound function is associated with the specified object, and has the specified initial parameters.</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>thisArg: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>An object to which the this keyword can refer inside the new function.</p>
|
||||
</div></div></li><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>argArray: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>A list of arguments to be passed to the new function.</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a id="call" class="tsd-anchor"></a><h3>call</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external"><li class="tsd-signature tsd-kind-icon">call<span class="tsd-signature-symbol">(</span>thisArg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, <span class="tsd-signature-symbol">...</span>argArray<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-symbol">: </span><span class="tsd-signature-type">any</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:285</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Calls a method of an object, substituting another object for the current object.</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>thisArg: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>The object to be used as the current object.</p>
|
||||
</div></div></li><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>argArray: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>A list of arguments to be passed to the method.</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a id="toString" class="tsd-anchor"></a><h3>to<wbr/>String</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external"><li class="tsd-signature tsd-kind-icon">to<wbr/>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:296</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Returns a string representation of a function.</p>
|
||||
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</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><li class="current tsd-kind-namespace"><a href="../modules/_internal_.html"><internal></a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_._node_stream_consumers_.html">"node:stream/consumers"</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_._node_stream_promises_.html">"node:stream/promises"</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-interface tsd-parent-kind-namespace tsd-is-external"><a href="_internal_.Function.html" class="tsd-kind-icon">Function</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.Function.html#arguments" class="tsd-kind-icon">arguments</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.Function.html#caller" class="tsd-kind-icon">caller</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.Function.html#length" class="tsd-kind-icon">length</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.Function.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.Function.html#prototype" class="tsd-kind-icon">prototype</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_internal_.Function.html#_hasInstance_" class="tsd-kind-icon">[has<wbr/>Instance]</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_internal_.Function.html#apply" class="tsd-kind-icon">apply</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_internal_.Function.html#bind" class="tsd-kind-icon">bind</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_internal_.Function.html#call" class="tsd-kind-icon">call</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_internal_.Function.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><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>
|
||||
5
gh-pages/interfaces/_internal_.FunctionConstructor.html
Normal file
5
gh-pages/interfaces/_internal_.FunctionConstructor.html
Normal file
File diff suppressed because one or more lines are too long
1
gh-pages/interfaces/_internal_.IncomingHttpHeaders.html
Normal file
1
gh-pages/interfaces/_internal_.IncomingHttpHeaders.html
Normal file
File diff suppressed because one or more lines are too long
1
gh-pages/interfaces/_internal_.InfoData.html
Normal file
1
gh-pages/interfaces/_internal_.InfoData.html
Normal file
File diff suppressed because one or more lines are too long
1
gh-pages/interfaces/_internal_.InfoOptions.html
Normal file
1
gh-pages/interfaces/_internal_.InfoOptions.html
Normal file
File diff suppressed because one or more lines are too long
204
gh-pages/interfaces/_internal_.Int16Array.html
Normal file
204
gh-pages/interfaces/_internal_.Int16Array.html
Normal file
File diff suppressed because one or more lines are too long
27
gh-pages/interfaces/_internal_.Int16ArrayConstructor.html
Normal file
27
gh-pages/interfaces/_internal_.Int16ArrayConstructor.html
Normal file
File diff suppressed because one or more lines are too long
204
gh-pages/interfaces/_internal_.Int32Array.html
Normal file
204
gh-pages/interfaces/_internal_.Int32Array.html
Normal file
File diff suppressed because one or more lines are too long
27
gh-pages/interfaces/_internal_.Int32ArrayConstructor.html
Normal file
27
gh-pages/interfaces/_internal_.Int32ArrayConstructor.html
Normal file
File diff suppressed because one or more lines are too long
204
gh-pages/interfaces/_internal_.Int8Array.html
Normal file
204
gh-pages/interfaces/_internal_.Int8Array.html
Normal file
File diff suppressed because one or more lines are too long
27
gh-pages/interfaces/_internal_.Int8ArrayConstructor.html
Normal file
27
gh-pages/interfaces/_internal_.Int8ArrayConstructor.html
Normal file
File diff suppressed because one or more lines are too long
5
gh-pages/interfaces/_internal_.IpcSocketConnectOpts.html
Normal file
5
gh-pages/interfaces/_internal_.IpcSocketConnectOpts.html
Normal file
@ -0,0 +1,5 @@
|
||||
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IpcSocketConnectOpts | 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"><internal></a></li><li><a href="_internal_.IpcSocketConnectOpts.html">IpcSocketConnectOpts</a></li></ul><h1>Interface IpcSocketConnectOpts</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><a href="_internal_.ConnectOpts.html" class="tsd-signature-type" data-tsd-kind="Interface">ConnectOpts</a><ul class="tsd-hierarchy"><li><span class="target">IpcSocketConnectOpts</span></li></ul></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 tsd-is-external"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_internal_.IpcSocketConnectOpts.html#onread" class="tsd-kind-icon">onread</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.IpcSocketConnectOpts.html#path" class="tsd-kind-icon">path</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group tsd-is-external"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="onread" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> onread</h3><div class="tsd-signature tsd-kind-icon">onread<span class="tsd-signature-symbol">?:</span> <a href="_internal_.OnReadOpts.html" class="tsd-signature-type" data-tsd-kind="Interface">OnReadOpts</a></div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.ConnectOpts.html">ConnectOpts</a>.<a href="_internal_.ConnectOpts.html#onread">onread</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:46</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>If specified, incoming data is stored in a single buffer and passed to the supplied callback when data arrives on the socket.
|
||||
Note: this will cause the streaming functionality to not provide any data, however events like 'error', 'end', and 'close' will
|
||||
still be emitted as normal and methods like pause() and resume() will also behave as expected.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a id="path" class="tsd-anchor"></a><h3>path</h3><div class="tsd-signature tsd-kind-icon">path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/net.d.ts:58</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><li class="current tsd-kind-namespace"><a href="../modules/_internal_.html"><internal></a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_._node_stream_consumers_.html">"node:stream/consumers"</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_._node_stream_promises_.html">"node:stream/promises"</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-interface tsd-parent-kind-namespace tsd-is-external"><a href="_internal_.IpcSocketConnectOpts.html" class="tsd-kind-icon">Ipc<wbr/>Socket<wbr/>Connect<wbr/>Opts</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_internal_.IpcSocketConnectOpts.html#onread" class="tsd-kind-icon">onread</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.IpcSocketConnectOpts.html#path" class="tsd-kind-icon">path</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><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
gh-pages/interfaces/_internal_.Iterable.html
Normal file
1
gh-pages/interfaces/_internal_.Iterable.html
Normal file
File diff suppressed because one or more lines are too long
1
gh-pages/interfaces/_internal_.IterableIterator.html
Normal file
1
gh-pages/interfaces/_internal_.IterableIterator.html
Normal file
File diff suppressed because one or more lines are too long
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user