This commit is contained in:
RubenVerborgh
2021-05-04 14:35:57 +00:00
parent 9f1be64682
commit e1e35a84d0
676 changed files with 23412 additions and 73346 deletions

View File

@@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>util/StreamUtil | Community Solid Server - v0.8.1</title>
<meta name="description" content="Documentation for Community Solid Server - v0.8.1">
<title>util/StreamUtil | Community Solid Server - v0.9.0</title>
<meta name="description" content="Documentation for Community Solid Server - v0.9.0">
<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 - v0.8.1</a>
<a href="../index.html" class="title">Community Solid Server - v0.9.0</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 - v0.8.1</a>
<a href="../modules.html">Community Solid Server - v0.9.0</a>
</li>
<li>
<a href="util_streamutil.html">util/StreamUtil</a>
@@ -99,7 +99,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/54ff231/src/util/StreamUtil.ts#L104">src/util/StreamUtil.ts:104</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/util/StreamUtil.ts#L121">src/util/StreamUtil.ts:121</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -130,13 +130,13 @@
<a name="pipesafely" class="tsd-anchor"></a>
<h3>pipe<wbr>Safely</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
<li class="tsd-signature tsd-kind-icon">pipe<wbr>Safely&lt;T&gt;<span class="tsd-signature-symbol">(</span>readable<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ReadableStream</span>, destination<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, mapError<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span>error<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">Error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="util_guardedstream.html#guarded" class="tsd-signature-type" data-tsd-kind="Type alias">Guarded</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-signature tsd-kind-icon">pipe<wbr>Safely&lt;T&gt;<span class="tsd-signature-symbol">(</span>readable<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">NodeJS.ReadableStream</span>, destination<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, mapError<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span>error<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">Error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="util_guardedstream.html#guarded" class="tsd-signature-type" data-tsd-kind="Type alias">Guarded</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</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/54ff231/src/util/StreamUtil.ts#L31">src/util/StreamUtil.ts:31</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/util/StreamUtil.ts#L32">src/util/StreamUtil.ts:32</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -155,7 +155,7 @@
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>readable: <span class="tsd-signature-type">ReadableStream</span></h5>
<h5>readable: <span class="tsd-signature-type">NodeJS.ReadableStream</span></h5>
<div class="tsd-comment tsd-typography">
<p>Initial readable stream.</p>
</div>
@@ -206,7 +206,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/54ff231/src/util/StreamUtil.ts#L17">src/util/StreamUtil.ts:17</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/util/StreamUtil.ts#L18">src/util/StreamUtil.ts:18</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -232,13 +232,13 @@
<a name="transformsafely" class="tsd-anchor"></a>
<h3>transform<wbr>Safely</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
<li class="tsd-signature tsd-kind-icon">transform<wbr>Safely&lt;T&gt;<span class="tsd-signature-symbol">(</span>source<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ReadableStream</span>, __namedParameters<span class="tsd-signature-symbol">?: </span><a href="../interfaces/util_streamutil.asynctransformoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">AsyncTransformOptions</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="util_guardedstream.html#guarded" class="tsd-signature-type" data-tsd-kind="Type alias">Guarded</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Transform</span><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-signature tsd-kind-icon">transform<wbr>Safely&lt;T&gt;<span class="tsd-signature-symbol">(</span>source<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">NodeJS.ReadableStream</span>, __namedParameters<span class="tsd-signature-symbol">?: </span><a href="../interfaces/util_streamutil.asynctransformoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">AsyncTransformOptions</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="util_guardedstream.html#guarded" class="tsd-signature-type" data-tsd-kind="Type alias">Guarded</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Transform</span><span class="tsd-signature-symbol">&gt;</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/54ff231/src/util/StreamUtil.ts#L65">src/util/StreamUtil.ts:65</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/util/StreamUtil.ts#L82">src/util/StreamUtil.ts:82</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -255,13 +255,13 @@
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>source: <span class="tsd-signature-type">ReadableStream</span></h5>
<h5>source: <span class="tsd-signature-type">NodeJS.ReadableStream</span></h5>
<div class="tsd-comment tsd-typography">
<p>The stream to be transformed</p>
</div>
</li>
<li>
<h5>__namedParameters: <a href="../interfaces/util_streamutil.asynctransformoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">AsyncTransformOptions</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></h5>
<h5>__namedParameters: <a href="../interfaces/util_streamutil.asynctransformoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">AsyncTransformOptions</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = {}</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="util_guardedstream.html#guarded" class="tsd-signature-type" data-tsd-kind="Type alias">Guarded</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Transform</span><span class="tsd-signature-symbol">&gt;</span></h4>