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

@@ -68,7 +68,7 @@ use of the LockUtils&#39; retryFunctionUntil function.</p>
<li><a href="../interfaces/Initializable.html" class="tsd-signature-type tsd-kind-interface">Initializable</a></li>
<li><a href="../interfaces/Finalizable.html" class="tsd-signature-type tsd-kind-interface">Finalizable</a></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1f88864/src/util/locking/RedisLocker.ts#L58">src/util/locking/RedisLocker.ts:58</a></li></ul></aside>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/dca71bc/src/util/locking/RedisLocker.ts#L58">src/util/locking/RedisLocker.ts:58</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">
@@ -132,44 +132,44 @@ use of the LockUtils&#39; retryFunctionUntil function.</p>
<h4 class="tsd-returns-title">Returns <a href="RedisLocker.html" class="tsd-signature-type tsd-kind-class">RedisLocker</a></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/RedisLocker.ts#L74">src/util/locking/RedisLocker.ts:74</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/dca71bc/src/util/locking/RedisLocker.ts#L74">src/util/locking/RedisLocker.ts:74</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-private"><a id="attemptSettings" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>attempt<wbr/>Settings</span><a href="#attemptSettings" 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">attempt<wbr/>Settings</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">Required</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">AttemptSettings</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/RedisLocker.ts#L64">src/util/locking/RedisLocker.ts:64</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/dca71bc/src/util/locking/RedisLocker.ts#L64">src/util/locking/RedisLocker.ts:64</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="finalized" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>finalized</span><a href="#finalized" 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">finalized</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1f88864/src/util/locking/RedisLocker.ts#L66">src/util/locking/RedisLocker.ts:66</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/dca71bc/src/util/locking/RedisLocker.ts#L66">src/util/locking/RedisLocker.ts:66</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-protected"><a id="logger" 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>logger</span><a href="#logger" 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">logger</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Logger.html" class="tsd-signature-type tsd-kind-interface">Logger</a><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1f88864/src/util/locking/RedisLocker.ts#L59">src/util/locking/RedisLocker.ts:59</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/dca71bc/src/util/locking/RedisLocker.ts#L59">src/util/locking/RedisLocker.ts:59</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="namespacePrefix" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>namespace<wbr/>Prefix</span><a href="#namespacePrefix" 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">namespace<wbr/>Prefix</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/RedisLocker.ts#L65">src/util/locking/RedisLocker.ts:65</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/dca71bc/src/util/locking/RedisLocker.ts#L65">src/util/locking/RedisLocker.ts:65</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="redis" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>redis</span><a href="#redis" 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">redis</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">Redis</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1f88864/src/util/locking/RedisLocker.ts#L61">src/util/locking/RedisLocker.ts:61</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/dca71bc/src/util/locking/RedisLocker.ts#L61">src/util/locking/RedisLocker.ts:61</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="redisLock" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>redis<wbr/>Lock</span><a href="#redisLock" 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">redis<wbr/>Lock</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">RedisResourceLock</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1f88864/src/util/locking/RedisLocker.ts#L63">src/util/locking/RedisLocker.ts:63</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/dca71bc/src/util/locking/RedisLocker.ts#L63">src/util/locking/RedisLocker.ts:63</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="redisRw" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>redis<wbr/>Rw</span><a href="#redisRw" 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">redis<wbr/>Rw</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">RedisReadWriteLock</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1f88864/src/util/locking/RedisLocker.ts#L62">src/util/locking/RedisLocker.ts:62</a></li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/dca71bc/src/util/locking/RedisLocker.ts#L62">src/util/locking/RedisLocker.ts:62</a></li></ul></aside></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Methods</h2>
<section class="tsd-panel tsd-member"><a id="acquire" class="tsd-anchor"></a>
@@ -192,7 +192,7 @@ The promise will resolve when the lock has been acquired.</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/ResourceLocker.html">ResourceLocker</a>.<a href="../interfaces/ResourceLocker.html#acquire">acquire</a></p>
<ul>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1f88864/src/util/locking/RedisLocker.ts#L190">src/util/locking/RedisLocker.ts:190</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/dca71bc/src/util/locking/RedisLocker.ts#L190">src/util/locking/RedisLocker.ts:190</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="clearLocks" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>clear<wbr/>Locks</span><a href="#clearLocks" 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-private">
@@ -203,7 +203,7 @@ The promise will resolve when the lock has been acquired.</p>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</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/RedisLocker.ts#L227">src/util/locking/RedisLocker.ts:227</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/dca71bc/src/util/locking/RedisLocker.ts#L227">src/util/locking/RedisLocker.ts:227</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="createRedisClient" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>create<wbr/>Redis<wbr/>Client</span><a href="#createRedisClient" 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-private">
@@ -225,7 +225,7 @@ The promise will resolve when the lock has been acquired.</p>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Redis</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/RedisLocker.ts#L99">src/util/locking/RedisLocker.ts:99</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/dca71bc/src/util/locking/RedisLocker.ts#L99">src/util/locking/RedisLocker.ts:99</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="finalize" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>finalize</span><a href="#finalize" 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">
@@ -234,7 +234,7 @@ The promise will resolve when the lock has been acquired.</p>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/Finalizable.html">Finalizable</a>.<a href="../interfaces/Finalizable.html#finalize">finalize</a></p>
<ul>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1f88864/src/util/locking/RedisLocker.ts#L213">src/util/locking/RedisLocker.ts:213</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/dca71bc/src/util/locking/RedisLocker.ts#L213">src/util/locking/RedisLocker.ts:213</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="getReadWriteKey" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>get<wbr/>Read<wbr/>Write<wbr/>Key</span><a href="#getReadWriteKey" 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-private">
@@ -254,7 +254,7 @@ The promise will resolve when the lock has been acquired.</p>
<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/RedisLocker.ts#L122">src/util/locking/RedisLocker.ts:122</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/dca71bc/src/util/locking/RedisLocker.ts#L122">src/util/locking/RedisLocker.ts:122</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="getResourceKey" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>get<wbr/>Resource<wbr/>Key</span><a href="#getResourceKey" 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-private">
@@ -274,7 +274,7 @@ The promise will resolve when the lock has been acquired.</p>
<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/RedisLocker.ts#L131">src/util/locking/RedisLocker.ts:131</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/dca71bc/src/util/locking/RedisLocker.ts#L131">src/util/locking/RedisLocker.ts:131</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="initialize" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>initialize</span><a href="#initialize" 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">
@@ -283,7 +283,7 @@ The promise will resolve when the lock has been acquired.</p>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/Initializable.html">Initializable</a>.<a href="../interfaces/Initializable.html#initialize">initialize</a></p>
<ul>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1f88864/src/util/locking/RedisLocker.ts#L208">src/util/locking/RedisLocker.ts:208</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/dca71bc/src/util/locking/RedisLocker.ts#L208">src/util/locking/RedisLocker.ts:208</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="release" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>release</span><a href="#release" 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">
@@ -305,7 +305,7 @@ In case there is no lock on the resource an error should be thrown.</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/ResourceLocker.html">ResourceLocker</a>.<a href="../interfaces/ResourceLocker.html#release">release</a></p>
<ul>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1f88864/src/util/locking/RedisLocker.ts#L198">src/util/locking/RedisLocker.ts:198</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/dca71bc/src/util/locking/RedisLocker.ts#L198">src/util/locking/RedisLocker.ts:198</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="swallowFalse" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>swallow<wbr/>False</span><a href="#swallowFalse" 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-private">
@@ -343,7 +343,7 @@ will return true. Any error coming from <code>fn()</code> will be thrown.</p>
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul>
<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/RedisLocker.ts#L143">src/util/locking/RedisLocker.ts:143</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/dca71bc/src/util/locking/RedisLocker.ts#L143">src/util/locking/RedisLocker.ts:143</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><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">
@@ -382,7 +382,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>Implementation of <a href="../interfaces/ReadWriteLocker.html">ReadWriteLocker</a>.<a href="../interfaces/ReadWriteLocker.html#withReadLock">withReadLock</a></p>
<ul>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1f88864/src/util/locking/RedisLocker.ts#L156">src/util/locking/RedisLocker.ts:156</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/dca71bc/src/util/locking/RedisLocker.ts#L156">src/util/locking/RedisLocker.ts:156</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><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">
@@ -421,7 +421,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>Implementation of <a href="../interfaces/ReadWriteLocker.html">ReadWriteLocker</a>.<a href="../interfaces/ReadWriteLocker.html#withWriteLock">withWriteLock</a></p>
<ul>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1f88864/src/util/locking/RedisLocker.ts#L172">src/util/locking/RedisLocker.ts:172</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/dca71bc/src/util/locking/RedisLocker.ts#L172">src/util/locking/RedisLocker.ts:172</a></li></ul></aside></li></ul></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">