3 lines
18 KiB
HTML
3 lines
18 KiB
HTML
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>StreamOptions | 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_.StreamOptions-1.html">StreamOptions</a></li></ul><h1>Interface StreamOptions<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<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="../classes/_internal_.Stream-2.html" class="tsd-signature-type" data-tsd-kind="Class">Stream</a></h4></li></ul></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="_internal_.EventEmitter.Abortable.html" class="tsd-signature-type" data-tsd-kind="Interface">Abortable</a><ul class="tsd-hierarchy"><li><span class="target">StreamOptions</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_.StreamOptions-1.html#autoDestroy" class="tsd-kind-icon">auto<wbr/>Destroy</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.StreamOptions-1.html#emitClose" class="tsd-kind-icon">emit<wbr/>Close</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.StreamOptions-1.html#highWaterMark" class="tsd-kind-icon">high<wbr/>Water<wbr/>Mark</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.StreamOptions-1.html#objectMode" class="tsd-kind-icon">object<wbr/>Mode</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_internal_.StreamOptions-1.html#signal" class="tsd-kind-icon">signal</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_.StreamOptions-1.html#construct" class="tsd-kind-icon">construct</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_internal_.StreamOptions-1.html#destroy" class="tsd-kind-icon">destroy</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="autoDestroy" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> auto<wbr/>Destroy</h3><div class="tsd-signature tsd-kind-icon">auto<wbr/>Destroy<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/stream.d.ts:41</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a id="emitClose" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> emit<wbr/>Close</h3><div class="tsd-signature tsd-kind-icon">emit<wbr/>Close<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/stream.d.ts:36</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a id="highWaterMark" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> high<wbr/>Water<wbr/>Mark</h3><div class="tsd-signature tsd-kind-icon">high<wbr/>Water<wbr/>Mark<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/stream.d.ts:37</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a id="objectMode" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> object<wbr/>Mode</h3><div class="tsd-signature tsd-kind-icon">object<wbr/>Mode<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/stream.d.ts:38</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="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"><p>Inherited from <a href="_internal_.EventEmitter.Abortable.html">Abortable</a>.<a href="_internal_.EventEmitter.Abortable.html#signal">signal</a></p><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><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="construct" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> construct</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external"><li class="tsd-signature tsd-kind-icon">construct<span class="tsd-signature-symbol">(</span>callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</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#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/stream.d.ts:39</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>callback: <span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</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#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</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#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> error: <span class="tsd-signature-type">null</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#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a id="destroy" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> destroy</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external"><li class="tsd-signature tsd-kind-icon">destroy<span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</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#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</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#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/stream.d.ts:40</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>error: <span class="tsd-signature-type">null</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#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a></h5></li><li><h5>callback: <span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</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#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</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#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>error: <span class="tsd-signature-type">null</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#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</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-has-type-parameter tsd-is-external"><a href="_internal_.StreamOptions-1.html" class="tsd-kind-icon">Stream<wbr/>Options</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.StreamOptions-1.html#autoDestroy" class="tsd-kind-icon">auto<wbr/>Destroy</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.StreamOptions-1.html#emitClose" class="tsd-kind-icon">emit<wbr/>Close</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.StreamOptions-1.html#highWaterMark" class="tsd-kind-icon">high<wbr/>Water<wbr/>Mark</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_internal_.StreamOptions-1.html#objectMode" class="tsd-kind-icon">object<wbr/>Mode</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_internal_.StreamOptions-1.html#signal" class="tsd-kind-icon">signal</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_internal_.StreamOptions-1.html#construct" class="tsd-kind-icon">construct</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_internal_.StreamOptions-1.html#destroy" class="tsd-kind-icon">destroy</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> |