<!DOCTYPE html><htmlclass="default"><head><metacharSet="utf-8"/><metahttp-equiv="x-ua-compatible"content="IE=edge"/><title>IpcSocketConnectOpts | play-dl</title><metaname="description"content="Documentation for play-dl"/><metaname="viewport"content="width=device-width, initial-scale=1"/><linkrel="stylesheet"href="../assets/style.css"/><linkrel="stylesheet"href="../assets/highlight.css"/><scriptasyncsrc="../assets/search.js"id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme")||"os")</script><header><divclass="tsd-page-toolbar"><divclass="container"><divclass="table-wrap"><divclass="table-cell"id="tsd-search"data-base=".."><divclass="field"><labelfor="tsd-search-field"class="tsd-widget search no-caption">Search</label><inputtype="text"id="tsd-search-field"/></div><ulclass="results"><liclass="state loading">Preparing search index...</li><liclass="state failure">The search index is not available</li></ul><ahref="../index.html"class="title">play-dl</a></div><divclass="table-cell"id="tsd-widgets"><divid="tsd-filter"><ahref="#"class="tsd-widget options no-caption"data-toggle="options">Options</a><divclass="tsd-filter-group"><divclass="tsd-select"id="tsd-filter-visibility"><spanclass="tsd-select-label">All</span><ulclass="tsd-select-list"><lidata-value="public">Public</li><lidata-value="protected">Public/Protected</li><lidata-value="private"class="selected">All</li></ul></div><inputtype="checkbox"id="tsd-filter-inherited"checked/><labelclass="tsd-widget"for="tsd-filter-inherited">Inherited</label><inputtype="checkbox"id="tsd-filter-externals"checked/><labelclass="tsd-widget"for="tsd-filter-externals">Externals</label></div></div><ahref="#"class="tsd-widget menu no-caption"data-toggle="menu">Menu</a></div></div></div></div><divclass="tsd-page-title"><divclass="container"><ulclass="tsd-breadcrumb"><li><ahref="../modules.html">play-dl</a></li><li><ahref="../modules/_internal_.html"><internal></a></li><li><ahref="_internal_.IpcSocketConnectOpts.html">IpcSocketConnectOpts</a></li></ul><h1>Interface IpcSocketConnectOpts</h1></div></div></header><divclass="container container-main"><divclass="row"><divclass="col-8 col-content"><sectionclass="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ulclass="tsd-hierarchy"><li><ahref="_internal_.ConnectOpts.html"class="tsd-signature-type"data-tsd-kind="Interface">ConnectOpts</a><ulclass="tsd-hierarchy"><li><spanclass="target">IpcSocketConnectOpts</span></li></ul></li></ul></section><sectionclass="tsd-panel-group tsd-index-group"><h2>Index</h2><sectionclass="tsd-panel tsd-index-panel"><divclass="tsd-index-content"><sectionclass="tsd-index-section tsd-is-external"><h3>Properties</h3><ulclass="tsd-index-list"><liclass="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><ahref="_internal_.IpcSocketConnectOpts.html#onread"class="tsd-kind-icon">onread</a></li><liclass="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><ahref="_internal_.IpcSocketConnectOpts.html#path"class="tsd-kind-icon">path</a></li></ul></section></div></section></section><sectionclass="tsd-panel-group tsd-member-group tsd-is-external"><h2>Properties</h2><sectionclass="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><aid="onread"class="tsd-anchor"></a><h3><spanclass="tsd-flag ts-flagOptional">Optional</span> onread</h3><divclass="tsd-signature tsd-kind-icon">onread<spanclass="tsd-signature-symbol">?:</span><ahref="_internal_.OnReadOpts.html"class="tsd-signature-type"data-tsd-kind="Interface">OnReadOpts</a></div><asideclass="tsd-sources"><p>Inherited from <ahref="_internal_.ConnectOpts.html">ConnectOpts</a>.<ahref="_internal_.ConnectOpts.html#onread">onread</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:46</li></ul></aside><divclass="tsd-comment tsd-typography"><divclass="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>
