This commit is contained in:
joachimvh
2023-11-28 08:48:17 +00:00
parent 9a114588f4
commit 9488ae4b30
806 changed files with 4394 additions and 4394 deletions

View File

@@ -29,7 +29,7 @@ this locker is threadsafe if its inputs are as well.</p>
<ul class="tsd-hierarchy">
<li><span class="target">GreedyReadWriteLocker</span></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1f88864/src/util/locking/GreedyReadWriteLocker.ts#L14">src/util/locking/GreedyReadWriteLocker.ts:14</a></li></ul></aside>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/dca71bc/src/util/locking/GreedyReadWriteLocker.ts#L14">src/util/locking/GreedyReadWriteLocker.ts:14</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -90,7 +90,7 @@ this locker is threadsafe if its inputs are as well.</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Overrides <a href="BaseReadWriteLocker.html">BaseReadWriteLocker</a>.<a href="BaseReadWriteLocker.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1f88864/src/util/locking/GreedyReadWriteLocker.ts#L25">src/util/locking/GreedyReadWriteLocker.ts:25</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/dca71bc/src/util/locking/GreedyReadWriteLocker.ts#L25">src/util/locking/GreedyReadWriteLocker.ts:25</a></li></ul></aside></li></ul></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="countLocker" class="tsd-anchor"></a>
@@ -98,28 +98,28 @@ this locker is threadsafe if its inputs are as well.</p>
<div class="tsd-signature"><span class="tsd-kind-property">count<wbr/>Locker</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/ResourceLocker.html" class="tsd-signature-type tsd-kind-interface">ResourceLocker</a></div><aside class="tsd-sources">
<p>Inherited from <a href="BaseReadWriteLocker.html">BaseReadWriteLocker</a>.<a href="BaseReadWriteLocker.html#countLocker">countLocker</a></p>
<ul>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1f88864/src/util/locking/BaseReadWriteLocker.ts#L22">src/util/locking/BaseReadWriteLocker.ts:22</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/dca71bc/src/util/locking/BaseReadWriteLocker.ts#L22">src/util/locking/BaseReadWriteLocker.ts:22</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-protected"><a id="countSuffix" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>count<wbr/>Suffix</span><a href="#countSuffix" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">count<wbr/>Suffix</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1f88864/src/util/locking/GreedyReadWriteLocker.ts#L17">src/util/locking/GreedyReadWriteLocker.ts:17</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/dca71bc/src/util/locking/GreedyReadWriteLocker.ts#L17">src/util/locking/GreedyReadWriteLocker.ts:17</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="locker" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>locker</span><a href="#locker" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">locker</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/ResourceLocker.html" class="tsd-signature-type tsd-kind-interface">ResourceLocker</a></div><aside class="tsd-sources">
<p>Inherited from <a href="BaseReadWriteLocker.html">BaseReadWriteLocker</a>.<a href="BaseReadWriteLocker.html#locker">locker</a></p>
<ul>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1f88864/src/util/locking/EqualReadWriteLocker.ts#L10">src/util/locking/EqualReadWriteLocker.ts:10</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/dca71bc/src/util/locking/EqualReadWriteLocker.ts#L10">src/util/locking/EqualReadWriteLocker.ts:10</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-protected"><a id="readSuffix" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>read<wbr/>Suffix</span><a href="#readSuffix" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">read<wbr/>Suffix</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1f88864/src/util/locking/GreedyReadWriteLocker.ts#L16">src/util/locking/GreedyReadWriteLocker.ts:16</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/dca71bc/src/util/locking/GreedyReadWriteLocker.ts#L16">src/util/locking/GreedyReadWriteLocker.ts:16</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-protected"><a id="storage" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>storage</span><a href="#storage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">storage</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/KeyValueStorage.html" class="tsd-signature-type tsd-kind-interface">KeyValueStorage</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1f88864/src/util/locking/GreedyReadWriteLocker.ts#L15">src/util/locking/GreedyReadWriteLocker.ts:15</a></li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/dca71bc/src/util/locking/GreedyReadWriteLocker.ts#L15">src/util/locking/GreedyReadWriteLocker.ts:15</a></li></ul></aside></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-is-protected"><a id="getCountKey" class="tsd-anchor"></a>
@@ -137,7 +137,7 @@ this locker is threadsafe if its inputs are as well.</p>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1f88864/src/util/locking/GreedyReadWriteLocker.ts#L44">src/util/locking/GreedyReadWriteLocker.ts:44</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/dca71bc/src/util/locking/GreedyReadWriteLocker.ts#L44">src/util/locking/GreedyReadWriteLocker.ts:44</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-protected"><a id="getCountLockIdentifier" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>get<wbr/>Count<wbr/>Lock<wbr/>Identifier</span><a href="#getCountLockIdentifier" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-protected">
@@ -158,7 +158,7 @@ this generated identifier needs to be different.</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Overrides <a href="BaseReadWriteLocker.html">BaseReadWriteLocker</a>.<a href="BaseReadWriteLocker.html#getCountLockIdentifier">getCountLockIdentifier</a></p>
<ul>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1f88864/src/util/locking/GreedyReadWriteLocker.ts#L37">src/util/locking/GreedyReadWriteLocker.ts:37</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/dca71bc/src/util/locking/GreedyReadWriteLocker.ts#L37">src/util/locking/GreedyReadWriteLocker.ts:37</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-protected"><a id="modifyCount" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>modify<wbr/>Count</span><a href="#modifyCount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-protected">
@@ -179,7 +179,7 @@ Deletes the data when the count reaches zero.</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Overrides <a href="BaseReadWriteLocker.html">BaseReadWriteLocker</a>.<a href="BaseReadWriteLocker.html#modifyCount">modifyCount</a></p>
<ul>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1f88864/src/util/locking/GreedyReadWriteLocker.ts#L53">src/util/locking/GreedyReadWriteLocker.ts:53</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/dca71bc/src/util/locking/GreedyReadWriteLocker.ts#L53">src/util/locking/GreedyReadWriteLocker.ts:53</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="withLock" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>with<wbr/>Lock</span><a href="#withLock" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
@@ -216,7 +216,7 @@ Will resolve when the input function resolves.</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Inherited from <a href="BaseReadWriteLocker.html">BaseReadWriteLocker</a>.<a href="BaseReadWriteLocker.html#withLock">withLock</a></p>
<ul>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1f88864/src/util/locking/EqualReadWriteLocker.ts#L30">src/util/locking/EqualReadWriteLocker.ts:30</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/dca71bc/src/util/locking/EqualReadWriteLocker.ts#L30">src/util/locking/EqualReadWriteLocker.ts:30</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="withReadLock" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>with<wbr/>Read<wbr/>Lock</span><a href="#withReadLock" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-inherited">
@@ -255,7 +255,7 @@ This function should be used for operations that only require reading the resour
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Inherited from <a href="BaseReadWriteLocker.html">BaseReadWriteLocker</a>.<a href="BaseReadWriteLocker.html#withReadLock">withReadLock</a></p>
<ul>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1f88864/src/util/locking/BaseReadWriteLocker.ts#L33">src/util/locking/BaseReadWriteLocker.ts:33</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/dca71bc/src/util/locking/BaseReadWriteLocker.ts#L33">src/util/locking/BaseReadWriteLocker.ts:33</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="withWriteLock" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>with<wbr/>Write<wbr/>Lock</span><a href="#withWriteLock" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-inherited">
@@ -294,7 +294,7 @@ This function should be used for operations that could modify the resource.</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Inherited from <a href="BaseReadWriteLocker.html">BaseReadWriteLocker</a>.<a href="BaseReadWriteLocker.html#withWriteLock">withWriteLock</a></p>
<ul>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1f88864/src/util/locking/EqualReadWriteLocker.ts#L20">src/util/locking/EqualReadWriteLocker.ts:20</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/dca71bc/src/util/locking/EqualReadWriteLocker.ts#L20">src/util/locking/EqualReadWriteLocker.ts:20</a></li></ul></aside></li></ul></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">