5 lines
11 KiB
HTML
5 lines
11 KiB
HTML
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>TcpSocketConnectOpts | 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_.TcpSocketConnectOpts.html">TcpSocketConnectOpts</a></li></ul><h1>Interface TcpSocketConnectOpts</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">TcpSocketConnectOpts</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-external"><a href="_internal_.TcpSocketConnectOpts.html#family" class="tsd-kind-icon">family</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.TcpSocketConnectOpts.html#hints" class="tsd-kind-icon">hints</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.TcpSocketConnectOpts.html#host" class="tsd-kind-icon">host</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.TcpSocketConnectOpts.html#localAddress" class="tsd-kind-icon">local<wbr/>Address</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.TcpSocketConnectOpts.html#localPort" class="tsd-kind-icon">local<wbr/>Port</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.TcpSocketConnectOpts.html#lookup" class="tsd-kind-icon">lookup</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_internal_.TcpSocketConnectOpts.html#onread" class="tsd-kind-icon">onread</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.TcpSocketConnectOpts.html#port" class="tsd-kind-icon">port</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="family" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> family</h3><div class="tsd-signature tsd-kind-icon">family<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/net.d.ts:54</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a id="hints" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> hints</h3><div class="tsd-signature tsd-kind-icon">hints<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/net.d.ts:53</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a id="host" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> host</h3><div class="tsd-signature tsd-kind-icon">host<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:50</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a id="localAddress" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> local<wbr/>Address</h3><div class="tsd-signature tsd-kind-icon">local<wbr/>Address<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:51</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a id="localPort" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> local<wbr/>Port</h3><div class="tsd-signature tsd-kind-icon">local<wbr/>Port<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/net.d.ts:52</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a id="lookup" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> lookup</h3><div class="tsd-signature tsd-kind-icon">lookup<span class="tsd-signature-symbol">?:</span> <a href="../modules/_internal_.html#LookupFunction" class="tsd-signature-type" data-tsd-kind="Type alias">LookupFunction</a></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/net.d.ts:55</li></ul></aside></section><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="port" class="tsd-anchor"></a><h3>port</h3><div class="tsd-signature tsd-kind-icon">port<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/net.d.ts:49</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_.TcpSocketConnectOpts.html" class="tsd-kind-icon">Tcp<wbr/>Socket<wbr/>Connect<wbr/>Opts</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.TcpSocketConnectOpts.html#family" class="tsd-kind-icon">family</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.TcpSocketConnectOpts.html#hints" class="tsd-kind-icon">hints</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.TcpSocketConnectOpts.html#host" class="tsd-kind-icon">host</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.TcpSocketConnectOpts.html#localAddress" class="tsd-kind-icon">local<wbr/>Address</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.TcpSocketConnectOpts.html#localPort" class="tsd-kind-icon">local<wbr/>Port</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.TcpSocketConnectOpts.html#lookup" class="tsd-kind-icon">lookup</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_internal_.TcpSocketConnectOpts.html#onread" class="tsd-kind-icon">onread</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.TcpSocketConnectOpts.html#port" class="tsd-kind-icon">port</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> |