This commit is contained in:
RubenVerborgh
2021-07-23 22:06:41 +00:00
parent 8591fda008
commit 9ba53b9d07
531 changed files with 10005 additions and 9931 deletions

View File

@@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>AsyncTransformOptions | Community Solid Server - v1.0.0-beta.0</title>
<meta name="description" content="Documentation for Community Solid Server - v1.0.0-beta.0">
<title>AsyncTransformOptions | Community Solid Server - v1.0.0-beta.1</title>
<meta name="description" content="Documentation for Community Solid Server - v1.0.0-beta.1">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
@@ -23,7 +23,7 @@
<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 - v1.0.0-beta.0</a>
<a href="../index.html" class="title">Community Solid Server - v1.0.0-beta.1</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@@ -52,7 +52,7 @@
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">Community Solid Server - v1.0.0-beta.0</a>
<a href="../modules.html">Community Solid Server - v1.0.0-beta.1</a>
</li>
<li>
<a href="../modules/util_streamutil.html">util/StreamUtil</a>
@@ -107,6 +107,7 @@
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="util_streamutil.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="util_streamutil.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="util_streamutil.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="util_streamutil.asynctransformoptions.html#signal" class="tsd-kind-icon">signal</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="util_streamutil.asynctransformoptions.html#transform" class="tsd-kind-icon">transform</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="util_streamutil.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="util_streamutil.asynctransformoptions.html#writablehighwatermark" class="tsd-kind-icon">writable<wbr>High<wbr>Water<wbr>Mark</a></li>
@@ -116,6 +117,7 @@
<section class="tsd-index-section tsd-is-inherited tsd-is-external">
<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="util_streamutil.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="util_streamutil.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="util_streamutil.asynctransformoptions.html#final" class="tsd-kind-icon">final</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="util_streamutil.asynctransformoptions.html#read" class="tsd-kind-icon">read</a></li>
@@ -135,7 +137,7 @@
<aside class="tsd-sources">
<p>Inherited from DuplexOptions.allowHalfOpen</p>
<ul>
<li>Defined in node_modules/@types/node/stream.d.ts:232</li>
<li>Defined in node_modules/@types/node/stream.d.ts:235</li>
</ul>
</aside>
</section>
@@ -146,7 +148,7 @@
<aside class="tsd-sources">
<p>Inherited from DuplexOptions.autoDestroy</p>
<ul>
<li>Defined in node_modules/@types/node/stream.d.ts:19</li>
<li>Defined in node_modules/@types/node/stream.d.ts:20</li>
</ul>
</aside>
</section>
@@ -157,18 +159,18 @@
<aside class="tsd-sources">
<p>Inherited from DuplexOptions.decodeStrings</p>
<ul>
<li>Defined in node_modules/@types/node/stream.d.ts:129</li>
<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">&quot;ascii&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;utf8&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;utf-8&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;utf16le&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;ucs2&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;ucs-2&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;base64&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;latin1&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;binary&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;hex&quot;</span></div>
<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:130</li>
<li>Defined in node_modules/@types/node/stream.d.ts:136</li>
</ul>
</aside>
</section>
@@ -179,18 +181,18 @@
<aside class="tsd-sources">
<p>Inherited from DuplexOptions.emitClose</p>
<ul>
<li>Defined in node_modules/@types/node/stream.d.ts:132</li>
<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">&quot;ascii&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;utf8&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;utf-8&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;utf16le&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;ucs2&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;ucs-2&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;base64&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;latin1&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;binary&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;hex&quot;</span></div>
<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:15</li>
<li>Defined in node_modules/@types/node/stream.d.ts:24</li>
</ul>
</aside>
</section>
@@ -200,7 +202,7 @@
<div 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-symbol"> =&gt; </span><span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/util/StreamUtil.ts#L72">src/util/StreamUtil.ts:72</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0be8222/src/util/StreamUtil.ts#L76">src/util/StreamUtil.ts:76</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
@@ -231,7 +233,7 @@
<aside class="tsd-sources">
<p>Inherited from DuplexOptions.highWaterMark</p>
<ul>
<li>Defined in node_modules/@types/node/stream.d.ts:14</li>
<li>Defined in node_modules/@types/node/stream.d.ts:16</li>
</ul>
</aside>
</section>
@@ -242,7 +244,7 @@
<aside class="tsd-sources">
<p>Inherited from DuplexOptions.objectMode</p>
<ul>
<li>Defined in node_modules/@types/node/stream.d.ts:16</li>
<li>Defined in node_modules/@types/node/stream.d.ts:17</li>
</ul>
</aside>
</section>
@@ -253,7 +255,7 @@
<aside class="tsd-sources">
<p>Inherited from DuplexOptions.readableHighWaterMark</p>
<ul>
<li>Defined in node_modules/@types/node/stream.d.ts:235</li>
<li>Defined in node_modules/@types/node/stream.d.ts:238</li>
</ul>
</aside>
</section>
@@ -264,17 +266,33 @@
<aside class="tsd-sources">
<p>Inherited from DuplexOptions.readableObjectMode</p>
<ul>
<li>Defined in node_modules/@types/node/stream.d.ts:233</li>
<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">
<a name="transform" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> transform</h3>
<div class="tsd-signature tsd-kind-icon">transform<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">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"> =&gt; </span><span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/util/StreamUtil.ts#L67">src/util/StreamUtil.ts:67</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0be8222/src/util/StreamUtil.ts#L71">src/util/StreamUtil.ts:71</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
@@ -314,7 +332,7 @@
<aside class="tsd-sources">
<p>Inherited from DuplexOptions.writableCorked</p>
<ul>
<li>Defined in node_modules/@types/node/stream.d.ts:237</li>
<li>Defined in node_modules/@types/node/stream.d.ts:240</li>
</ul>
</aside>
</section>
@@ -325,7 +343,7 @@
<aside class="tsd-sources">
<p>Inherited from DuplexOptions.writableHighWaterMark</p>
<ul>
<li>Defined in node_modules/@types/node/stream.d.ts:236</li>
<li>Defined in node_modules/@types/node/stream.d.ts:239</li>
</ul>
</aside>
</section>
@@ -336,13 +354,55 @@
<aside class="tsd-sources">
<p>Inherited from DuplexOptions.writableObjectMode</p>
<ul>
<li>Defined in node_modules/@types/node/stream.d.ts:234</li>
<li>Defined in node_modules/@types/node/stream.d.ts:237</li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited tsd-is-external">
<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"> =&gt; </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"> =&gt; </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>
@@ -354,7 +414,7 @@
<aside class="tsd-sources">
<p>Inherited from DuplexOptions.destroy</p>
<ul>
<li>Defined in node_modules/@types/node/stream.d.ts:242</li>
<li>Defined in node_modules/@types/node/stream.d.ts:246</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -399,7 +459,7 @@
<aside class="tsd-sources">
<p>Inherited from DuplexOptions.final</p>
<ul>
<li>Defined in node_modules/@types/node/stream.d.ts:241</li>
<li>Defined in node_modules/@types/node/stream.d.ts:245</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -441,7 +501,7 @@
<aside class="tsd-sources">
<p>Inherited from DuplexOptions.read</p>
<ul>
<li>Defined in node_modules/@types/node/stream.d.ts:238</li>
<li>Defined in node_modules/@types/node/stream.d.ts:242</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -465,7 +525,7 @@
<aside class="tsd-sources">
<p>Inherited from DuplexOptions.write</p>
<ul>
<li>Defined in node_modules/@types/node/stream.d.ts:239</li>
<li>Defined in node_modules/@types/node/stream.d.ts:243</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -513,7 +573,7 @@
<aside class="tsd-sources">
<p>Inherited from DuplexOptions.writev</p>
<ul>
<li>Defined in node_modules/@types/node/stream.d.ts:240</li>
<li>Defined in node_modules/@types/node/stream.d.ts:244</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -600,6 +660,9 @@
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="util_streamutil.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="util_streamutil.asynctransformoptions.html#signal" class="tsd-kind-icon">signal</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="util_streamutil.asynctransformoptions.html#transform" class="tsd-kind-icon">transform</a>
</li>
@@ -612,6 +675,9 @@
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="util_streamutil.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="util_streamutil.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="util_streamutil.asynctransformoptions.html#destroy" class="tsd-kind-icon">destroy</a>
</li>
@@ -631,6 +697,9 @@
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="../modules/util_streamutil.html#endofstream" class="tsd-kind-icon">end<wbr>OfStream</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="../modules/util_streamutil.html#guardedstreamfrom" class="tsd-kind-icon">guarded<wbr>Stream<wbr>From</a>
</li>