mirror of
https://github.com/CommunitySolidServer/CommunitySolidServer.git
synced 2024-10-03 14:55:10 +00:00
7 lines
40 KiB
HTML
7 lines
40 KiB
HTML
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>AsyncTransformOptions | Community Solid Server - v2.0.0</title><meta name="description" content="Documentation for Community Solid Server - v2.0.0"/><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><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">Community Solid Server - v2.0.0</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">Community Solid Server - v2.0.0</a></li><li><a href="AsyncTransformOptions.html">AsyncTransformOptions</a></li></ul><h1>Interface AsyncTransformOptions<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-type">any</span></h4></li></ul></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">DuplexOptions</span><ul class="tsd-hierarchy"><li><span class="target">AsyncTransformOptions</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-inherited 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="AsyncTransformOptions.html#allowHalfOpen" class="tsd-kind-icon">allow<wbr/>Half<wbr/>Open</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AsyncTransformOptions.html#autoDestroy" class="tsd-kind-icon">auto<wbr/>Destroy</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AsyncTransformOptions.html#decodeStrings" class="tsd-kind-icon">decode<wbr/>Strings</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AsyncTransformOptions.html#defaultEncoding" class="tsd-kind-icon">default<wbr/>Encoding</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AsyncTransformOptions.html#emitClose" class="tsd-kind-icon">emit<wbr/>Close</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AsyncTransformOptions.html#encoding" class="tsd-kind-icon">encoding</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AsyncTransformOptions.html#highWaterMark" class="tsd-kind-icon">high<wbr/>Water<wbr/>Mark</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AsyncTransformOptions.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="AsyncTransformOptions.html#readableHighWaterMark" class="tsd-kind-icon">readable<wbr/>High<wbr/>Water<wbr/>Mark</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AsyncTransformOptions.html#readableObjectMode" class="tsd-kind-icon">readable<wbr/>Object<wbr/>Mode</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AsyncTransformOptions.html#signal" class="tsd-kind-icon">signal</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AsyncTransformOptions.html#writableCorked" class="tsd-kind-icon">writable<wbr/>Corked</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AsyncTransformOptions.html#writableHighWaterMark" class="tsd-kind-icon">writable<wbr/>High<wbr/>Water<wbr/>Mark</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AsyncTransformOptions.html#writableObjectMode" class="tsd-kind-icon">writable<wbr/>Object<wbr/>Mode</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AsyncTransformOptions.html#construct" class="tsd-kind-icon">construct</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AsyncTransformOptions.html#destroy" class="tsd-kind-icon">destroy</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AsyncTransformOptions.html#final" class="tsd-kind-icon">final</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="AsyncTransformOptions.html#flush" class="tsd-kind-icon">flush</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AsyncTransformOptions.html#read" class="tsd-kind-icon">read</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="AsyncTransformOptions.html#transform" class="tsd-kind-icon">transform</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AsyncTransformOptions.html#write" class="tsd-kind-icon">write</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AsyncTransformOptions.html#writev" class="tsd-kind-icon">writev</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited 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 name="allowHalfOpen" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> allow<wbr/>Half<wbr/>Open</h3><div class="tsd-signature tsd-kind-icon">allow<wbr/>Half<wbr/>Open<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from DuplexOptions.allowHalfOpen</p><ul><li>Defined in node_modules/@types/node/stream.d.ts:235</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a name="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"><p>Inherited from DuplexOptions.autoDestroy</p><ul><li>Defined in node_modules/@types/node/stream.d.ts:20</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a name="decodeStrings" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> decode<wbr/>Strings</h3><div class="tsd-signature tsd-kind-icon">decode<wbr/>Strings<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from DuplexOptions.decodeStrings</p><ul><li>Defined in node_modules/@types/node/stream.d.ts:135</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a name="defaultEncoding" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> default<wbr/>Encoding</h3><div class="tsd-signature tsd-kind-icon">default<wbr/>Encoding<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">BufferEncoding</span></div><aside class="tsd-sources"><p>Inherited from DuplexOptions.defaultEncoding</p><ul><li>Defined in node_modules/@types/node/stream.d.ts:136</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a name="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"><p>Inherited from DuplexOptions.emitClose</p><ul><li>Defined in node_modules/@types/node/stream.d.ts:15</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a name="encoding" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> encoding</h3><div class="tsd-signature tsd-kind-icon">encoding<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">BufferEncoding</span></div><aside class="tsd-sources"><p>Inherited from DuplexOptions.encoding</p><ul><li>Defined in node_modules/@types/node/stream.d.ts:24</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a name="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"><p>Inherited from DuplexOptions.highWaterMark</p><ul><li>Defined in node_modules/@types/node/stream.d.ts:16</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a name="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"><p>Inherited from DuplexOptions.objectMode</p><ul><li>Defined in node_modules/@types/node/stream.d.ts:17</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a name="readableHighWaterMark" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> readable<wbr/>High<wbr/>Water<wbr/>Mark</h3><div class="tsd-signature tsd-kind-icon">readable<wbr/>High<wbr/>Water<wbr/>Mark<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from DuplexOptions.readableHighWaterMark</p><ul><li>Defined in node_modules/@types/node/stream.d.ts:238</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a name="readableObjectMode" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> readable<wbr/>Object<wbr/>Mode</h3><div class="tsd-signature tsd-kind-icon">readable<wbr/>Object<wbr/>Mode<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from DuplexOptions.readableObjectMode</p><ul><li>Defined in node_modules/@types/node/stream.d.ts:236</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a name="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> <span class="tsd-signature-type">AbortSignal</span></div><aside class="tsd-sources"><p>Inherited from DuplexOptions.signal</p><ul><li>Defined in node_modules/@types/node/events.d.ts:65</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 class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a name="writableCorked" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> writable<wbr/>Corked</h3><div class="tsd-signature tsd-kind-icon">writable<wbr/>Corked<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from DuplexOptions.writableCorked</p><ul><li>Defined in node_modules/@types/node/stream.d.ts:240</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a name="writableHighWaterMark" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> writable<wbr/>High<wbr/>Water<wbr/>Mark</h3><div class="tsd-signature tsd-kind-icon">writable<wbr/>High<wbr/>Water<wbr/>Mark<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from DuplexOptions.writableHighWaterMark</p><ul><li>Defined in node_modules/@types/node/stream.d.ts:239</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a name="writableObjectMode" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> writable<wbr/>Object<wbr/>Mode</h3><div class="tsd-signature tsd-kind-icon">writable<wbr/>Object<wbr/>Mode<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from DuplexOptions.writableObjectMode</p><ul><li>Defined in node_modules/@types/node/stream.d.ts:237</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a name="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-inherited 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><span class="tsd-signature-type">Error</span><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"><p>Inherited from DuplexOptions.construct</p><ul><li>Defined in node_modules/@types/node/stream.d.ts:241</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><span class="tsd-signature-type">Error</span><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><span class="tsd-signature-type">Error</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"><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><span class="tsd-signature-type">Error</span></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-inherited tsd-is-external"><a name="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-inherited 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><span class="tsd-signature-type">Error</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><span class="tsd-signature-type">Error</span><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"><p>Inherited from DuplexOptions.destroy</p><ul><li>Defined in node_modules/@types/node/stream.d.ts:246</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><span class="tsd-signature-type">Error</span></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><span class="tsd-signature-type">Error</span><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><span class="tsd-signature-type">Error</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"><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><span class="tsd-signature-type">Error</span></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-inherited tsd-is-external"><a name="final" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> final</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">final<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><span class="tsd-signature-type">Error</span><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"><p>Inherited from DuplexOptions.final</p><ul><li>Defined in node_modules/@types/node/stream.d.ts:245</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><span class="tsd-signature-type">Error</span><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><span class="tsd-signature-type">Error</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"><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><span class="tsd-signature-type">Error</span></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"><a name="flush" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> flush</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">flush<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 <a href="https://github.com/solid/community-server/blob/216788e/src/util/StreamUtil.ts#L127">src/util/StreamUtil.ts:127</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Performs any final actions after the source has ended</p>
|
|
</div></div><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-inherited tsd-is-external"><a name="read" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> read</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">read<span class="tsd-signature-symbol">(</span>size<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><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from DuplexOptions.read</p><ul><li>Defined in node_modules/@types/node/stream.d.ts:242</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>size: <span class="tsd-signature-type">number</span></h5></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"><a name="transform" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> transform</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">transform<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span>, encoding<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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 <a href="https://github.com/solid/community-server/blob/216788e/src/util/StreamUtil.ts#L122">src/util/StreamUtil.ts:122</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Transforms data from the source by calling the <code>push</code> method</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>data: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5></li><li><h5>encoding: <span class="tsd-signature-type">string</span></h5></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-inherited tsd-is-external"><a name="write" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> write</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">write<span class="tsd-signature-symbol">(</span>chunk<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, encoding<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BufferEncoding</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><span class="tsd-signature-type">Error</span><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"><p>Inherited from DuplexOptions.write</p><ul><li>Defined in node_modules/@types/node/stream.d.ts:243</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>chunk: <span class="tsd-signature-type">any</span></h5></li><li><h5>encoding: <span class="tsd-signature-type">BufferEncoding</span></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><span class="tsd-signature-type">Error</span><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><span class="tsd-signature-type">Error</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"><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><span class="tsd-signature-type">Error</span></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-inherited tsd-is-external"><a name="writev" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> writev</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">writev<span class="tsd-signature-symbol">(</span>chunks<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>chunk<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>encoding<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BufferEncoding</span><span class="tsd-signature-symbol"> }</span><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><span class="tsd-signature-type">Error</span><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"><p>Inherited from DuplexOptions.writev</p><ul><li>Defined in node_modules/@types/node/stream.d.ts:244</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>chunks: <span class="tsd-signature-symbol">{ </span>chunk<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>encoding<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BufferEncoding</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></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><span class="tsd-signature-type">Error</span><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><span class="tsd-signature-type">Error</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"><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><span class="tsd-signature-type">Error</span></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></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface tsd-has-type-parameter"><a href="AsyncTransformOptions.html" class="tsd-kind-icon">Async<wbr/>Transform<wbr/>Options</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AsyncTransformOptions.html#allowHalfOpen" class="tsd-kind-icon">allow<wbr/>Half<wbr/>Open</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AsyncTransformOptions.html#autoDestroy" class="tsd-kind-icon">auto<wbr/>Destroy</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AsyncTransformOptions.html#decodeStrings" class="tsd-kind-icon">decode<wbr/>Strings</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AsyncTransformOptions.html#defaultEncoding" class="tsd-kind-icon">default<wbr/>Encoding</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AsyncTransformOptions.html#emitClose" class="tsd-kind-icon">emit<wbr/>Close</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AsyncTransformOptions.html#encoding" class="tsd-kind-icon">encoding</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AsyncTransformOptions.html#highWaterMark" class="tsd-kind-icon">high<wbr/>Water<wbr/>Mark</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AsyncTransformOptions.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="AsyncTransformOptions.html#readableHighWaterMark" class="tsd-kind-icon">readable<wbr/>High<wbr/>Water<wbr/>Mark</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AsyncTransformOptions.html#readableObjectMode" class="tsd-kind-icon">readable<wbr/>Object<wbr/>Mode</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AsyncTransformOptions.html#signal" class="tsd-kind-icon">signal</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AsyncTransformOptions.html#writableCorked" class="tsd-kind-icon">writable<wbr/>Corked</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AsyncTransformOptions.html#writableHighWaterMark" class="tsd-kind-icon">writable<wbr/>High<wbr/>Water<wbr/>Mark</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AsyncTransformOptions.html#writableObjectMode" class="tsd-kind-icon">writable<wbr/>Object<wbr/>Mode</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AsyncTransformOptions.html#construct" class="tsd-kind-icon">construct</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AsyncTransformOptions.html#destroy" class="tsd-kind-icon">destroy</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AsyncTransformOptions.html#final" class="tsd-kind-icon">final</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="AsyncTransformOptions.html#flush" class="tsd-kind-icon">flush</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AsyncTransformOptions.html#read" class="tsd-kind-icon">read</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="AsyncTransformOptions.html#transform" class="tsd-kind-icon">transform</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AsyncTransformOptions.html#write" class="tsd-kind-icon">write</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AsyncTransformOptions.html#writev" class="tsd-kind-icon">writev</a></li></ul></li></ul></nav></div></div></div><footer class=""><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li><li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="overlay"></div><script src="../assets/main.js"></script></body></html> |