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: dca71bc5b8

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

30
7.x/docs/classes/FileSystemResourceLocker.html
View File

@@ -37,7 +37,7 @@ however will be ignored and replaced by our own LockUtils' retryFunction fun
<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/FileSystemResourceLocker.ts#L64">src/util/locking/FileSystemResourceLocker.ts:64</a></li></ul></aside>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/dca71bc/src/util/locking/FileSystemResourceLocker.ts#L64">src/util/locking/FileSystemResourceLocker.ts:64</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">
@@ -86,19 +86,19 @@ however will be ignored and replaced by our own LockUtils&#39; retryFunction fun
<h4 class="tsd-returns-title">Returns <a href="FileSystemResourceLocker.html" class="tsd-signature-type tsd-kind-class">FileSystemResourceLocker</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/FileSystemResourceLocker.ts#L76">src/util/locking/FileSystemResourceLocker.ts:76</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/dca71bc/src/util/locking/FileSystemResourceLocker.ts#L76">src/util/locking/FileSystemResourceLocker.ts:76</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/FileSystemResourceLocker.ts#L66">src/util/locking/FileSystemResourceLocker.ts:66</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/dca71bc/src/util/locking/FileSystemResourceLocker.ts#L66">src/util/locking/FileSystemResourceLocker.ts:66</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/FileSystemResourceLocker.ts#L70">src/util/locking/FileSystemResourceLocker.ts:70</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/dca71bc/src/util/locking/FileSystemResourceLocker.ts#L70">src/util/locking/FileSystemResourceLocker.ts:70</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="lockFolder" 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>lock<wbr/>Folder</span><a href="#lockFolder" 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">lock<wbr/>Folder</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
@@ -106,17 +106,17 @@ however will be ignored and replaced by our own LockUtils&#39; retryFunction fun
</div>
<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/FileSystemResourceLocker.ts#L69">src/util/locking/FileSystemResourceLocker.ts:69</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/dca71bc/src/util/locking/FileSystemResourceLocker.ts#L69">src/util/locking/FileSystemResourceLocker.ts:69</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="lockOptions" 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>lock<wbr/>Options</span><a href="#lockOptions" 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">lock<wbr/>Options</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">LockOptions</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1f88864/src/util/locking/FileSystemResourceLocker.ts#L67">src/util/locking/FileSystemResourceLocker.ts:67</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/dca71bc/src/util/locking/FileSystemResourceLocker.ts#L67">src/util/locking/FileSystemResourceLocker.ts:67</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/FileSystemResourceLocker.ts#L65">src/util/locking/FileSystemResourceLocker.ts:65</a></li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/dca71bc/src/util/locking/FileSystemResourceLocker.ts#L65">src/util/locking/FileSystemResourceLocker.ts:65</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>
@@ -139,7 +139,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/FileSystemResourceLocker.ts#L105">src/util/locking/FileSystemResourceLocker.ts:105</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/dca71bc/src/util/locking/FileSystemResourceLocker.ts#L105">src/util/locking/FileSystemResourceLocker.ts:105</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="customOnCompromised" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>custom<wbr/>On<wbr/>Compromised</span><a href="#customOnCompromised" 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">
@@ -157,7 +157,7 @@ This allows for a clean shutdown procedure.</p>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</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/FileSystemResourceLocker.ts#L191">src/util/locking/FileSystemResourceLocker.ts:191</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/dca71bc/src/util/locking/FileSystemResourceLocker.ts#L191">src/util/locking/FileSystemResourceLocker.ts:191</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">
@@ -166,7 +166,7 @@ This allows for a clean shutdown procedure.</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/FileSystemResourceLocker.ts#L179">src/util/locking/FileSystemResourceLocker.ts:179</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/dca71bc/src/util/locking/FileSystemResourceLocker.ts#L179">src/util/locking/FileSystemResourceLocker.ts:179</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="generateOptions" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>generate<wbr/>Options</span><a href="#generateOptions" 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">
@@ -197,7 +197,7 @@ A custom lockFilePath mapping strategy will be used.</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/FileSystemResourceLocker.ts#L157">src/util/locking/FileSystemResourceLocker.ts:157</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/dca71bc/src/util/locking/FileSystemResourceLocker.ts#L157">src/util/locking/FileSystemResourceLocker.ts:157</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">
@@ -212,7 +212,7 @@ remain on disk, so that request will not be blocked because a lock was acquired
<div class="tsd-comment tsd-typography"></div><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/FileSystemResourceLocker.ts#L172">src/util/locking/FileSystemResourceLocker.ts:172</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/dca71bc/src/util/locking/FileSystemResourceLocker.ts#L172">src/util/locking/FileSystemResourceLocker.ts:172</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">
@@ -234,7 +234,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/FileSystemResourceLocker.ts#L122">src/util/locking/FileSystemResourceLocker.ts:122</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/dca71bc/src/util/locking/FileSystemResourceLocker.ts#L122">src/util/locking/FileSystemResourceLocker.ts:122</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="swallowErrors" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>swallow<wbr/>Errors</span><a href="#swallowErrors" 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 @@ This wrapper returns undefined because retryFunction expects that when a retry n
<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/FileSystemResourceLocker.ts#L91">src/util/locking/FileSystemResourceLocker.ts:91</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/dca71bc/src/util/locking/FileSystemResourceLocker.ts#L91">src/util/locking/FileSystemResourceLocker.ts:91</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="toLockfilePath" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>to<wbr/>Lockfile<wbr/>Path</span><a href="#toLockfilePath" 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">
@@ -294,7 +294,7 @@ This wrapper returns undefined because retryFunction expects that when a retry n
<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/FileSystemResourceLocker.ts#L144">src/util/locking/FileSystemResourceLocker.ts:144</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/dca71bc/src/util/locking/FileSystemResourceLocker.ts#L144">src/util/locking/FileSystemResourceLocker.ts:144</a></li></ul></aside></li></ul></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">