Mirroristas/CommunitySolidServer
2
0
Fork 0
mirror of https://github.com/CommunitySolidServer/CommunitySolidServer.git synced 2024-10-03 14:55:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

deploy: 4faf916ece

Browse Source
This commit is contained in:
RubenVerborgh
2021-01-02 15:15:51 +00:00
parent 0d5e28eba7
commit ea78f70f30
342 changed files with 1845 additions and 1698 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
docs/modules/util_guardedstream.html
View File

@@ -79,6 +79,7 @@
<h3>Functions</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a href="util_guardedstream.html#guardstream" class="tsd-kind-icon">guard<wbr>Stream</a></li>
<li class="tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a href="util_guardedstream.html#isguarded" class="tsd-kind-icon">is<wbr>Guarded</a></li>
</ul>
</section>
</div>
@@ -92,20 +93,20 @@
<div class="tsd-signature tsd-kind-icon">Guarded&lt;T&gt;<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">Guard</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/4df11c1/src/util/GuardedStream.ts#L32">src/util/GuardedStream.ts:32</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/4faf916/src/util/GuardedStream.ts#L22">src/util/GuardedStream.ts:22</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A stream that is guarded.
This means that if this stream emits an error before a listener is attached,
it will store the error and emit it once a listener is added.</p>
<p>A stream that is guarded from emitting errors when there are no listeners.
If an error occurs while no listener is attached,
it will store the error and emit it once a listener is added (or a timeout occurs).</p>
</div>
</div>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">NodeJS.EventEmitter</span></h4>
<h4>T<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">NodeJS.EventEmitter</span> = <span class="tsd-signature-type">NodeJS.EventEmitter</span></h4>
</li>
</ul>
</section>
@@ -122,7 +123,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/4df11c1/src/util/GuardedStream.ts#L86">src/util/GuardedStream.ts:86</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/4faf916/src/util/GuardedStream.ts#L37">src/util/GuardedStream.ts:37</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -148,7 +149,41 @@
</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">T</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>The wrapped stream.</p>
<p>The stream.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
<a name="isguarded" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> is<wbr>Guarded</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
<li class="tsd-signature tsd-kind-icon">is<wbr>Guarded&lt;T&gt;<span class="tsd-signature-symbol">(</span>stream<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-type">stream</span><span class="tsd-signature-symbol"> is </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/4faf916/src/util/GuardedStream.ts#L27">src/util/GuardedStream.ts:27</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Determines whether the stream is guarded from emitting errors.</p>
</div>
</div>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EventEmitter</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>stream: <span class="tsd-signature-type">T</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">stream</span><span class="tsd-signature-symbol"> is </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></h4>
</li>
</ul>
</section>
@@ -173,6 +208,9 @@
<li class=" tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
<a href="util_guardedstream.html#guardstream" class="tsd-kind-icon">guard<wbr>Stream</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
<a href="util_guardedstream.html#isguarded" class="tsd-kind-icon">is<wbr>Guarded</a>
</li>
</ul>
</nav>
</div>