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: 1a07de7c9d

Browse Source
This commit is contained in:
joachimvh
2022-11-03 08:59:05 +00:00
parent 0d3225ff1e
commit 3d724f916f
598 changed files with 6643 additions and 5537 deletions
Download Patch File Download Diff File Expand all files Collapse all files

75
5.x/docs/classes/RedisLocker.html
View File

@@ -1,16 +1,16 @@
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>RedisLocker | Community Solid Server - v5.0.0</title><meta name="description" content="Documentation for Community Solid Server - v5.0.0"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><link rel="stylesheet" href="../assets/custom.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>RedisLocker | Community Solid Server - v5.1.0</title><meta name="description" content="Documentation for Community Solid Server - v5.1.0"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><link rel="stylesheet" href="../assets/custom.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
<div class="tsd-toolbar-contents container">
<div class="table-cell" id="tsd-search" data-base="..">
<div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
<ul class="results">
<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 - v5.0.0</a></div>
<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Community Solid Server - v5.1.0</a></div>
<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
<div class="container container-main">
<div class="col-8 col-content">
<div class="tsd-page-title">
<ul class="tsd-breadcrumb">
<li><a href="../modules.html">Community Solid Server - v5.0.0</a></li>
<li><a href="../modules.html">Community Solid Server - v5.1.0</a></li>
<li><a href="RedisLocker.html">RedisLocker</a></li></ul>
<h1>Class RedisLocker</h1></div>
<section class="tsd-panel tsd-comment">
@@ -65,7 +65,7 @@ use of the LockUtils&#39; retryFunctionUntil function.</p>
<li><a href="../interfaces/Initializable.html" class="tsd-signature-type" data-tsd-kind="Interface">Initializable</a></li>
<li><a href="../interfaces/Finalizable.html" class="tsd-signature-type" data-tsd-kind="Interface">Finalizable</a></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/9a5fc674f/src/util/locking/RedisLocker.ts#L46">src/util/locking/RedisLocker.ts:46</a></li></ul></aside>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/util/locking/RedisLocker.ts#L57">src/util/locking/RedisLocker.ts:57</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">
@@ -80,6 +80,7 @@ use of the LockUtils&#39; retryFunctionUntil function.</p>
<div class="tsd-index-list"><a href="RedisLocker.html#attemptSettings" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>attempt<wbr/>Settings</span></a>
<a href="RedisLocker.html#finalized" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>finalized</span></a>
<a href="RedisLocker.html#logger" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-protected"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>logger</span></a>
<a href="RedisLocker.html#namespacePrefix" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>namespace<wbr/>Prefix</span></a>
<a href="RedisLocker.html#redis" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>redis</span></a>
<a href="RedisLocker.html#redisLock" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>redis<wbr/>Lock</span></a>
<a href="RedisLocker.html#redisRw" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>redis<wbr/>Rw</span></a>
@@ -103,50 +104,65 @@ use of the LockUtils&#39; retryFunctionUntil function.</p>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-anchor-link" id="constructor.new_RedisLocker">new <wbr/>Redis<wbr/>Locker<span class="tsd-signature-symbol">(</span>redisClient<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, attemptSettings<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AttemptSettings</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="RedisLocker.html" class="tsd-signature-type" data-tsd-kind="Class">RedisLocker</a><a href="#constructor.new_RedisLocker" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-signature tsd-anchor-link" id="constructor.new_RedisLocker">new <wbr/>Redis<wbr/>Locker<span class="tsd-signature-symbol">(</span>redisClient<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, attemptSettings<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AttemptSettings</span>, redisSettings<span class="tsd-signature-symbol">?: </span><a href="../interfaces/RedisSettings.html" class="tsd-signature-type" data-tsd-kind="Interface">RedisSettings</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="RedisLocker.html" class="tsd-signature-type" data-tsd-kind="Class">RedisLocker</a><a href="#constructor.new_RedisLocker" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Creates a new RedisClient</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>redisClient: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;127.0.0.1:6379&#39;</span></h5></li>
<h5>redisClient: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;127.0.0.1:6379&#39;</span></h5>
<div class="tsd-comment tsd-typography"><p>Redis connection string of a standalone Redis node</p>
</div></li>
<li>
<h5>attemptSettings: <span class="tsd-signature-type">AttemptSettings</span><span class="tsd-signature-symbol"> = {}</span></h5></li></ul></div>
<h5>attemptSettings: <span class="tsd-signature-type">AttemptSettings</span><span class="tsd-signature-symbol"> = {}</span></h5>
<div class="tsd-comment tsd-typography"><p>Override default AttemptSettings</p>
</div></li>
<li>
<h5>redisSettings: <a href="../interfaces/RedisSettings.html" class="tsd-signature-type" data-tsd-kind="Interface">RedisSettings</a><span class="tsd-signature-symbol"> = ...</span></h5>
<div class="tsd-comment tsd-typography"><p>Addition settings used to create the Redis client or to interact with the Redis server</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="RedisLocker.html" class="tsd-signature-type" data-tsd-kind="Class">RedisLocker</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/9a5fc674f/src/util/locking/RedisLocker.ts#L55">src/util/locking/RedisLocker.ts:55</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/util/locking/RedisLocker.ts#L73">src/util/locking/RedisLocker.ts:73</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-kind-property tsd-parent-kind-class 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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">attempt<wbr/>Settings<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/9a5fc674f/src/util/locking/RedisLocker.ts#L52">src/util/locking/RedisLocker.ts:52</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/util/locking/RedisLocker.ts#L63">src/util/locking/RedisLocker.ts:63</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class 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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">finalized<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/9a5fc674f/src/util/locking/RedisLocker.ts#L53">src/util/locking/RedisLocker.ts:53</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/util/locking/RedisLocker.ts#L65">src/util/locking/RedisLocker.ts:65</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class 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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">logger<span class="tsd-signature-symbol">:</span> <a href="../interfaces/Logger.html" class="tsd-signature-type" data-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/9a5fc674f/src/util/locking/RedisLocker.ts#L47">src/util/locking/RedisLocker.ts:47</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/util/locking/RedisLocker.ts#L58">src/util/locking/RedisLocker.ts:58</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class 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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">namespace<wbr/>Prefix<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/1a07de7/src/util/locking/RedisLocker.ts#L64">src/util/locking/RedisLocker.ts:64</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class 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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">redis<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/9a5fc674f/src/util/locking/RedisLocker.ts#L49">src/util/locking/RedisLocker.ts:49</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/util/locking/RedisLocker.ts#L60">src/util/locking/RedisLocker.ts:60</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class 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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">redis<wbr/>Lock<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/9a5fc674f/src/util/locking/RedisLocker.ts#L51">src/util/locking/RedisLocker.ts:51</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/util/locking/RedisLocker.ts#L62">src/util/locking/RedisLocker.ts:62</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class 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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">redis<wbr/>Rw<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/9a5fc674f/src/util/locking/RedisLocker.ts#L50">src/util/locking/RedisLocker.ts:50</a></li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/util/locking/RedisLocker.ts#L61">src/util/locking/RedisLocker.ts:61</a></li></ul></aside></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="acquire" class="tsd-anchor"></a>
@@ -167,7 +183,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 ResourceLocker.acquire</p>
<ul>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/9a5fc674f/src/util/locking/RedisLocker.ts#L164">src/util/locking/RedisLocker.ts:164</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/util/locking/RedisLocker.ts#L188">src/util/locking/RedisLocker.ts:188</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class 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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -177,11 +193,11 @@ The promise will resolve when the lock has been acquired.</p>
</div>
<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">
<ul>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/9a5fc674f/src/util/locking/RedisLocker.ts#L201">src/util/locking/RedisLocker.ts:201</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/util/locking/RedisLocker.ts#L225">src/util/locking/RedisLocker.ts:225</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class 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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-anchor-link" id="createRedisClient.createRedisClient-1">create<wbr/>Redis<wbr/>Client<span class="tsd-signature-symbol">(</span>redisClientString<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Redis</span><a href="#createRedisClient.createRedisClient-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-signature tsd-anchor-link" id="createRedisClient.createRedisClient-1">create<wbr/>Redis<wbr/>Client<span class="tsd-signature-symbol">(</span>redisClientString<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/RedisSettings.html" class="tsd-signature-type" data-tsd-kind="Interface">RedisSettings</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;namespacePrefix&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Redis</span><a href="#createRedisClient.createRedisClient-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Generate and return a RedisClient based on the provided string</p>
</div>
@@ -192,10 +208,12 @@ The promise will resolve when the lock has been acquired.</p>
<h5>redisClientString: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography"><p>A string that contains either a host address and a
port number like &#39;127.0.0.1:6379&#39; or just a port number like &#39;6379&#39;.</p>
</div></li></ul></div>
</div></li>
<li>
<h5>options: <span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/RedisSettings.html" class="tsd-signature-type" data-tsd-kind="Interface">RedisSettings</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;namespacePrefix&quot;</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Redis</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/9a5fc674f/src/util/locking/RedisLocker.ts#L73">src/util/locking/RedisLocker.ts:73</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/util/locking/RedisLocker.ts#L97">src/util/locking/RedisLocker.ts:97</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -204,7 +222,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 Finalizable.finalize</p>
<ul>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/9a5fc674f/src/util/locking/RedisLocker.ts#L187">src/util/locking/RedisLocker.ts:187</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/util/locking/RedisLocker.ts#L211">src/util/locking/RedisLocker.ts:211</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class 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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -223,7 +241,7 @@ The promise will resolve when the lock has been acquired.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/9a5fc674f/src/util/locking/RedisLocker.ts#L96">src/util/locking/RedisLocker.ts:96</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/util/locking/RedisLocker.ts#L120">src/util/locking/RedisLocker.ts:120</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class 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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -242,7 +260,7 @@ The promise will resolve when the lock has been acquired.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/9a5fc674f/src/util/locking/RedisLocker.ts#L105">src/util/locking/RedisLocker.ts:105</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/util/locking/RedisLocker.ts#L129">src/util/locking/RedisLocker.ts:129</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -251,7 +269,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 Initializable.initialize</p>
<ul>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/9a5fc674f/src/util/locking/RedisLocker.ts#L182">src/util/locking/RedisLocker.ts:182</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/util/locking/RedisLocker.ts#L206">src/util/locking/RedisLocker.ts:206</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -271,7 +289,7 @@ In case there is no lock on the resource an error should be thrown.</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 ResourceLocker.release</p>
<ul>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/9a5fc674f/src/util/locking/RedisLocker.ts#L172">src/util/locking/RedisLocker.ts:172</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/util/locking/RedisLocker.ts#L196">src/util/locking/RedisLocker.ts:196</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class 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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -306,7 +324,7 @@ will return true. Any error coming from <code>fn()</code> will be thrown.</p>
</div>
<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">unknown</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/9a5fc674f/src/util/locking/RedisLocker.ts#L117">src/util/locking/RedisLocker.ts:117</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/util/locking/RedisLocker.ts#L141">src/util/locking/RedisLocker.ts:141</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -343,7 +361,7 @@ This function should be used for operations that only require reading the resour
<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" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
<p>Implementation of ReadWriteLocker.withReadLock</p>
<ul>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/9a5fc674f/src/util/locking/RedisLocker.ts#L130">src/util/locking/RedisLocker.ts:130</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/util/locking/RedisLocker.ts#L154">src/util/locking/RedisLocker.ts:154</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -380,7 +398,7 @@ This function should be used for operations that could modify the resource.</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" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
<p>Implementation of ReadWriteLocker.withWriteLock</p>
<ul>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/9a5fc674f/src/util/locking/RedisLocker.ts#L146">src/util/locking/RedisLocker.ts:146</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/util/locking/RedisLocker.ts#L170">src/util/locking/RedisLocker.ts:170</a></li></ul></aside></li></ul></section></section></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
@@ -400,7 +418,7 @@ This function should be used for operations that could modify the resource.</p>
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary>
<div class="tsd-accordion-details">
<ul>
<li><a href="../modules.html">Community <wbr/>Solid <wbr/>Server -<wbr/> v5.0.0</a>
<li><a href="../modules.html">Community <wbr/>Solid <wbr/>Server -<wbr/> v5.1.0</a>
<ul></ul></li></ul></div></details></nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul>
@@ -410,6 +428,7 @@ This function should be used for operations that could modify the resource.</p>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="RedisLocker.html#attemptSettings" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>attempt<wbr/>Settings</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="RedisLocker.html#finalized" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>finalized</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="RedisLocker.html#logger" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>logger</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="RedisLocker.html#namespacePrefix" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>namespace<wbr/>Prefix</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="RedisLocker.html#redis" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>redis</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="RedisLocker.html#redisLock" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>redis<wbr/>Lock</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="RedisLocker.html#redisRw" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>redis<wbr/>Rw</a></li>