mirror of
https://github.com/CommunitySolidServer/CommunitySolidServer.git
synced 2024-10-03 14:55:10 +00:00
deploy: 409782c205
This commit is contained in:
RubenVerborgh
@@ -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.4.0</title>
|
||||
<meta name="description" content="Documentation for Community Solid Server - v0.4.0">
|
||||
<title>util/StreamUtil | Community Solid Server - v0.4.1</title>
|
||||
<meta name="description" content="Documentation for Community Solid Server - v0.4.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 - v0.4.0</a>
|
||||
<a href="../index.html" class="title">Community Solid Server - v0.4.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 - v0.4.0</a>
|
||||
<a href="../modules.html">Community Solid Server - v0.4.1</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="util_streamutil.html">util/StreamUtil</a>
|
||||
@@ -69,12 +69,19 @@
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Interfaces</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter"><a href="../interfaces/util_streamutil.asynctransformoptions.html" class="tsd-kind-icon">Async<wbr>Transform<wbr>Options</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Functions</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-function tsd-parent-kind-module"><a href="util_streamutil.html#guardedstreamfrom" class="tsd-kind-icon">guarded<wbr>Stream<wbr>From</a></li>
|
||||
<li class="tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a href="util_streamutil.html#pipesafely" class="tsd-kind-icon">pipe<wbr>Safely</a></li>
|
||||
<li class="tsd-kind-function tsd-parent-kind-module"><a href="util_streamutil.html#readabletostring" class="tsd-kind-icon">readable<wbr>ToString</a></li>
|
||||
<li class="tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a href="util_streamutil.html#transformsafely" class="tsd-kind-icon">transform<wbr>Safely</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
@@ -86,24 +93,24 @@
|
||||
<a name="guardedstreamfrom" class="tsd-anchor"></a>
|
||||
<h3>guarded<wbr>Stream<wbr>From</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
||||
<li class="tsd-signature tsd-kind-icon">guarded<wbr>Stream<wbr>From<span class="tsd-signature-symbol">(</span>iterable<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Iterable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ReadableOptions</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"><</span><span class="tsd-signature-type">Readable</span><span class="tsd-signature-symbol">></span></li>
|
||||
<li class="tsd-signature tsd-kind-icon">guarded<wbr>Stream<wbr>From<span class="tsd-signature-symbol">(</span>contents<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Iterable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ReadableOptions</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"><</span><span class="tsd-signature-type">Readable</span><span class="tsd-signature-symbol">></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/867af28/src/util/StreamUtil.ts#L51">src/util/StreamUtil.ts:51</a></li>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/409782c/src/util/StreamUtil.ts#L104">src/util/StreamUtil.ts:104</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Converts an iterable to a stream and applies an error guard so that it is <a href="util_guardedstream.html#guarded">Guarded</a>.</p>
|
||||
<p>Converts a string or array to a stream and applies an error guard so that it is <a href="util_guardedstream.html#guarded">Guarded</a>.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>iterable: <span class="tsd-signature-type">Iterable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5>
|
||||
<h5>contents: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Iterable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Data to stream.</p>
|
||||
</div>
|
||||
@@ -129,7 +136,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/867af28/src/util/StreamUtil.ts#L30">src/util/StreamUtil.ts:30</a></li>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/409782c/src/util/StreamUtil.ts#L30">src/util/StreamUtil.ts:30</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -199,7 +206,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/867af28/src/util/StreamUtil.ts#L16">src/util/StreamUtil.ts:16</a></li>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/409782c/src/util/StreamUtil.ts#L16">src/util/StreamUtil.ts:16</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -221,6 +228,47 @@
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
|
||||
<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<T><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"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></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"><</span><span class="tsd-signature-type">Transform</span><span class="tsd-signature-symbol">></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/409782c/src/util/StreamUtil.ts#L65">src/util/StreamUtil.ts:65</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Transforms a stream, ensuring that all errors are forwarded.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>T = <span class="tsd-signature-type">any</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>source: <span class="tsd-signature-type">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"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></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"><</span><span class="tsd-signature-type">Transform</span><span class="tsd-signature-symbol">></span></h4>
|
||||
<p>The transformed stream</p>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
@@ -236,6 +284,9 @@
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter">
|
||||
<a href="../interfaces/util_streamutil.asynctransformoptions.html" class="tsd-kind-icon">Async<wbr>Transform<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function tsd-parent-kind-module">
|
||||
<a href="util_streamutil.html#guardedstreamfrom" class="tsd-kind-icon">guarded<wbr>Stream<wbr>From</a>
|
||||
</li>
|
||||
@@ -245,6 +296,9 @@
|
||||
<li class=" tsd-kind-function tsd-parent-kind-module">
|
||||
<a href="util_streamutil.html#readabletostring" class="tsd-kind-icon">readable<wbr>ToString</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
|
||||
<a href="util_streamutil.html#transformsafely" class="tsd-kind-icon">transform<wbr>Safely</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user