better-lock 3.0.0 → 3.2.0

package/docs/classes/_internal_.BetterLock.html

@@ -39,6 +39,7 @@
 <div class="tsd-index-list"><a href="_internal_.BetterLock.html#abort" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF4DB8" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-2048-path"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)" id="icon-2048-text"></path></svg><span>abort</span></a>
 <a href="_internal_.BetterLock.html#abortAll" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>abort<wbr/>All</span></a>
 <a href="_internal_.BetterLock.html#acquire" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>acquire</span></a>
+<a href="_internal_.BetterLock.html#acquireOr" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>acquire<wbr/>Or</span></a>
 <a href="_internal_.BetterLock.html#canAcquire" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>can<wbr/>Acquire</span></a>
 </div></section></div></details></section></section>
 <section class="tsd-panel-group tsd-member-group">
@@ -65,7 +66,7 @@
 <div class="tsd-comment tsd-typography"><p>Default options to be used when creating BetterLock instances.</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/better_lock.ts#L21">better_lock.ts:21</a></li></ul></aside></section></section>
+<li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/better_lock.ts#L22">better_lock.ts:22</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="abort" class="tsd-anchor"></a>
@@ -116,7 +117,7 @@ once promise resolves or rejects.</p>
 <h4 class="tsd-type-parameters-title">Type Parameters</h4>
 <ul class="tsd-type-parameters">
 <li>
-<h4>TResult</h4></li></ul></div>
+<h4>TResult<span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">unknown</span></h4></li></ul></div>
 <div class="tsd-parameters">
 <h4 class="tsd-parameters-title">Parameters</h4>
 <ul class="tsd-parameter-list">
@@ -141,7 +142,7 @@ once promise resolves or rejects.</p>
 <h4 class="tsd-type-parameters-title">Type Parameters</h4>
 <ul class="tsd-type-parameters">
 <li>
-<h4>TResult</h4></li></ul></div>
+<h4>TResult<span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">unknown</span></h4></li></ul></div>
 <div class="tsd-parameters">
 <h4 class="tsd-parameters-title">Parameters</h4>
 <ul class="tsd-parameter-list">
@@ -166,7 +167,7 @@ once promise resolves or rejects.</p>
 <h4 class="tsd-type-parameters-title">Type Parameters</h4>
 <ul class="tsd-type-parameters">
 <li>
-<h4>TResult</h4></li></ul></div>
+<h4>TResult<span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">unknown</span></h4></li></ul></div>
 <div class="tsd-parameters">
 <h4 class="tsd-parameters-title">Parameters</h4>
 <ul class="tsd-parameter-list">
@@ -195,7 +196,7 @@ once promise resolves or rejects.</p>
 <h4 class="tsd-type-parameters-title">Type Parameters</h4>
 <ul class="tsd-type-parameters">
 <li>
-<h4>TResult</h4></li></ul></div>
+<h4>TResult<span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">unknown</span></h4></li></ul></div>
 <div class="tsd-parameters">
 <h4 class="tsd-parameters-title">Parameters</h4>
 <ul class="tsd-parameter-list">
@@ -224,7 +225,7 @@ once promise resolves or rejects.</p>
 <h4 class="tsd-type-parameters-title">Type Parameters</h4>
 <ul class="tsd-type-parameters">
 <li>
-<h4>TResult</h4></li></ul></div>
+<h4>TResult<span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">unknown</span></h4></li></ul></div>
 <div class="tsd-parameters">
 <h4 class="tsd-parameters-title">Parameters</h4>
 <ul class="tsd-parameter-list">
@@ -253,7 +254,7 @@ once promise resolves or rejects.</p>
 <h4 class="tsd-type-parameters-title">Type Parameters</h4>
 <ul class="tsd-type-parameters">
 <li>
-<h4>TResult</h4></li></ul></div>
+<h4>TResult<span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">unknown</span></h4></li></ul></div>
 <div class="tsd-parameters">
 <h4 class="tsd-parameters-title">Parameters</h4>
 <ul class="tsd-parameter-list">
@@ -274,6 +275,186 @@ once promise resolves or rejects.</p>
 <div class="tsd-comment tsd-typography"><p>Options to be applied on this job only</p>
 </div></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section>
+<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="acquireOr" class="tsd-anchor"></a>
+<h3 class="tsd-anchor-link"><span>acquire<wbr/>Or</span><a href="#acquireOr" 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">
+<li class="tsd-signature" id="acquireOr.acquireOr-1">acquire<wbr/>Or<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TResult</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>failureResult<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TResult</span>, executor<span class="tsd-signature-symbol">: </span><a href="../types/_internal_.IPromiseExecutor.html" class="tsd-signature-type" data-tsd-kind="Type alias">IPromiseExecutor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TResult</span><span class="tsd-signature-symbol">&gt;</span>, jobOptions<span class="tsd-signature-symbol">?: </span><a href="../interfaces/BetterLockJobOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">BetterLockJobOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TResult</span><span class="tsd-signature-symbol">&gt;</span></li>
+<li class="tsd-signature" id="acquireOr.acquireOr-2">acquire<wbr/>Or<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TResult</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>failureResult<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TResult</span>, executor<span class="tsd-signature-symbol">: </span><a href="../types/_internal_.ICallbackExecutor.html" class="tsd-signature-type" data-tsd-kind="Type alias">ICallbackExecutor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TResult</span><span class="tsd-signature-symbol">&gt;</span>, jobOptions<span class="tsd-signature-symbol">?: </span><a href="../interfaces/BetterLockJobOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">BetterLockJobOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TResult</span><span class="tsd-signature-symbol">&gt;</span></li>
+<li class="tsd-signature" id="acquireOr.acquireOr-3">acquire<wbr/>Or<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TResult</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>failureResult<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TResult</span>, executor<span class="tsd-signature-symbol">: </span><a href="../types/_internal_.ICallbackExecutor.html" class="tsd-signature-type" data-tsd-kind="Type alias">ICallbackExecutor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TResult</span><span class="tsd-signature-symbol">&gt;</span>, callback<span class="tsd-signature-symbol">: </span><a href="../types/_internal_.ICallback.html" class="tsd-signature-type" data-tsd-kind="Type alias">ICallback</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TResult</span><span class="tsd-signature-symbol">&gt;</span>, jobOptions<span class="tsd-signature-symbol">?: </span><a href="../interfaces/BetterLockJobOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">BetterLockJobOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
+<li class="tsd-signature" id="acquireOr.acquireOr-4">acquire<wbr/>Or<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TResult</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><a href="../types/BetterLockKey.html" class="tsd-signature-type" data-tsd-kind="Type alias">BetterLockKey</a><span class="tsd-signature-symbol"> | </span><a href="../types/BetterLockKey.html" class="tsd-signature-type" data-tsd-kind="Type alias">BetterLockKey</a><span class="tsd-signature-symbol">[]</span>, failureResult<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TResult</span>, executor<span class="tsd-signature-symbol">: </span><a href="../types/_internal_.IPromiseExecutor.html" class="tsd-signature-type" data-tsd-kind="Type alias">IPromiseExecutor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TResult</span><span class="tsd-signature-symbol">&gt;</span>, jobOptions<span class="tsd-signature-symbol">?: </span><a href="../interfaces/BetterLockJobOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">BetterLockJobOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TResult</span><span class="tsd-signature-symbol">&gt;</span></li>
+<li class="tsd-signature" id="acquireOr.acquireOr-5">acquire<wbr/>Or<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TResult</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><a href="../types/BetterLockKey.html" class="tsd-signature-type" data-tsd-kind="Type alias">BetterLockKey</a><span class="tsd-signature-symbol"> | </span><a href="../types/BetterLockKey.html" class="tsd-signature-type" data-tsd-kind="Type alias">BetterLockKey</a><span class="tsd-signature-symbol">[]</span>, failureResult<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TResult</span>, executor<span class="tsd-signature-symbol">: </span><a href="../types/_internal_.ICallbackExecutor.html" class="tsd-signature-type" data-tsd-kind="Type alias">ICallbackExecutor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TResult</span><span class="tsd-signature-symbol">&gt;</span>, jobOptions<span class="tsd-signature-symbol">?: </span><a href="../interfaces/BetterLockJobOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">BetterLockJobOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TResult</span><span class="tsd-signature-symbol">&gt;</span></li>
+<li class="tsd-signature" id="acquireOr.acquireOr-6">acquire<wbr/>Or<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TResult</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><a href="../types/BetterLockKey.html" class="tsd-signature-type" data-tsd-kind="Type alias">BetterLockKey</a><span class="tsd-signature-symbol"> | </span><a href="../types/BetterLockKey.html" class="tsd-signature-type" data-tsd-kind="Type alias">BetterLockKey</a><span class="tsd-signature-symbol">[]</span>, failureResult<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TResult</span>, executor<span class="tsd-signature-symbol">: </span><a href="../types/_internal_.ICallbackExecutor.html" class="tsd-signature-type" data-tsd-kind="Type alias">ICallbackExecutor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TResult</span><span class="tsd-signature-symbol">&gt;</span>, callback<span class="tsd-signature-symbol">: </span><a href="../types/_internal_.ICallback.html" class="tsd-signature-type" data-tsd-kind="Type alias">ICallback</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TResult</span><span class="tsd-signature-symbol">&gt;</span>, jobOptions<span class="tsd-signature-symbol">?: </span><a href="../interfaces/BetterLockJobOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">BetterLockJobOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul>
+<ul class="tsd-descriptions">
+<li class="tsd-description">
+<div class="tsd-comment tsd-typography"><p>The same as acquire, except if the lock can&#39;t be acquired (the executor never gets called), instead of throwing
+an error, the lock will resolve/callback with the provided failureResult value (for example, a <code>null</code>).</p>
+</div>
+<div class="tsd-type-parameters">
+<h4 class="tsd-type-parameters-title">Type Parameters</h4>
+<ul class="tsd-type-parameters">
+<li>
+<h4>TResult<span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">unknown</span></h4></li></ul></div>
+<div class="tsd-parameters">
+<h4 class="tsd-parameters-title">Parameters</h4>
+<ul class="tsd-parameter-list">
+<li>
+<h5>failureResult: <span class="tsd-signature-type" data-tsd-kind="Type parameter">TResult</span></h5>
+<div class="tsd-comment tsd-typography"><p>The value to return if the executor never get called. This happens instead of rejecting.</p>
+</div></li>
+<li>
+<h5>executor: <a href="../types/_internal_.IPromiseExecutor.html" class="tsd-signature-type" data-tsd-kind="Type alias">IPromiseExecutor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TResult</span><span class="tsd-signature-symbol">&gt;</span></h5>
+<div class="tsd-comment tsd-typography"><p>Function that will run inside the lock. Required.</p>
+</div></li>
+<li>
+<h5><code class="tsd-tag ts-flagOptional">Optional</code> jobOptions: <a href="../interfaces/BetterLockJobOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">BetterLockJobOptions</a></h5>
+<div class="tsd-comment tsd-typography"><p>Options to be applied on this job only</p>
+</div></li></ul></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" data-tsd-kind="Type parameter">TResult</span><span class="tsd-signature-symbol">&gt;</span></h4></li>
+<li class="tsd-description">
+<div class="tsd-comment tsd-typography"><p>The same as acquire, except if the lock can&#39;t be acquired (the executor never gets called), instead of throwing
+an error, the lock will resolve/callback with the provided failureResult value (for example, a <code>null</code>).</p>
+</div>
+<div class="tsd-type-parameters">
+<h4 class="tsd-type-parameters-title">Type Parameters</h4>
+<ul class="tsd-type-parameters">
+<li>
+<h4>TResult<span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">unknown</span></h4></li></ul></div>
+<div class="tsd-parameters">
+<h4 class="tsd-parameters-title">Parameters</h4>
+<ul class="tsd-parameter-list">
+<li>
+<h5>failureResult: <span class="tsd-signature-type" data-tsd-kind="Type parameter">TResult</span></h5>
+<div class="tsd-comment tsd-typography"><p>The value to return if the executor never get called. This happens instead of rejecting.</p>
+</div></li>
+<li>
+<h5>executor: <a href="../types/_internal_.ICallbackExecutor.html" class="tsd-signature-type" data-tsd-kind="Type alias">ICallbackExecutor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TResult</span><span class="tsd-signature-symbol">&gt;</span></h5>
+<div class="tsd-comment tsd-typography"><p>Function that will run inside the lock. Required.</p>
+</div></li>
+<li>
+<h5><code class="tsd-tag ts-flagOptional">Optional</code> jobOptions: <a href="../interfaces/BetterLockJobOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">BetterLockJobOptions</a></h5>
+<div class="tsd-comment tsd-typography"><p>Options to be applied on this job only</p>
+</div></li></ul></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" data-tsd-kind="Type parameter">TResult</span><span class="tsd-signature-symbol">&gt;</span></h4></li>
+<li class="tsd-description">
+<div class="tsd-comment tsd-typography"><p>The same as acquire, except if the lock can&#39;t be acquired (the executor never gets called), instead of throwing
+an error, the lock will resolve/callback with the provided failureResult value (for example, a <code>null</code>).</p>
+</div>
+<div class="tsd-type-parameters">
+<h4 class="tsd-type-parameters-title">Type Parameters</h4>
+<ul class="tsd-type-parameters">
+<li>
+<h4>TResult<span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">unknown</span></h4></li></ul></div>
+<div class="tsd-parameters">
+<h4 class="tsd-parameters-title">Parameters</h4>
+<ul class="tsd-parameter-list">
+<li>
+<h5>failureResult: <span class="tsd-signature-type" data-tsd-kind="Type parameter">TResult</span></h5>
+<div class="tsd-comment tsd-typography"><p>The value to return if the executor never get called. This happens instead of rejecting.</p>
+</div></li>
+<li>
+<h5>executor: <a href="../types/_internal_.ICallbackExecutor.html" class="tsd-signature-type" data-tsd-kind="Type alias">ICallbackExecutor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TResult</span><span class="tsd-signature-symbol">&gt;</span></h5>
+<div class="tsd-comment tsd-typography"><p>Function that will run inside the lock. Required.</p>
+</div></li>
+<li>
+<h5>callback: <a href="../types/_internal_.ICallback.html" class="tsd-signature-type" data-tsd-kind="Type alias">ICallback</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TResult</span><span class="tsd-signature-symbol">&gt;</span></h5>
+<div class="tsd-comment tsd-typography"><p>Function to be called after the executor finishes, or there is an execution timeout. Leave out to use promises.</p>
+</div></li>
+<li>
+<h5><code class="tsd-tag ts-flagOptional">Optional</code> jobOptions: <a href="../interfaces/BetterLockJobOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">BetterLockJobOptions</a></h5>
+<div class="tsd-comment tsd-typography"><p>Options to be applied on this job only</p>
+</div></li></ul></div>
+<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li>
+<li class="tsd-description">
+<div class="tsd-comment tsd-typography"><p>The same as acquire, except if the lock can&#39;t be acquired (the executor never gets called), instead of throwing
+an error, the lock will resolve/callback with the provided failureResult value (for example, a <code>null</code>).</p>
+</div>
+<div class="tsd-type-parameters">
+<h4 class="tsd-type-parameters-title">Type Parameters</h4>
+<ul class="tsd-type-parameters">
+<li>
+<h4>TResult<span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">unknown</span></h4></li></ul></div>
+<div class="tsd-parameters">
+<h4 class="tsd-parameters-title">Parameters</h4>
+<ul class="tsd-parameter-list">
+<li>
+<h5>key: <a href="../types/BetterLockKey.html" class="tsd-signature-type" data-tsd-kind="Type alias">BetterLockKey</a><span class="tsd-signature-symbol"> | </span><a href="../types/BetterLockKey.html" class="tsd-signature-type" data-tsd-kind="Type alias">BetterLockKey</a><span class="tsd-signature-symbol">[]</span></h5>
+<div class="tsd-comment tsd-typography"><p>Named key or array of keys for this particular call. Calls with different keys will be run in parallel. Not required.</p>
+</div></li>
+<li>
+<h5>failureResult: <span class="tsd-signature-type" data-tsd-kind="Type parameter">TResult</span></h5>
+<div class="tsd-comment tsd-typography"><p>The value to return if the executor never get called. This happens instead of rejecting.</p>
+</div></li>
+<li>
+<h5>executor: <a href="../types/_internal_.IPromiseExecutor.html" class="tsd-signature-type" data-tsd-kind="Type alias">IPromiseExecutor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TResult</span><span class="tsd-signature-symbol">&gt;</span></h5>
+<div class="tsd-comment tsd-typography"><p>Function that will run inside the lock. Required.</p>
+</div></li>
+<li>
+<h5><code class="tsd-tag ts-flagOptional">Optional</code> jobOptions: <a href="../interfaces/BetterLockJobOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">BetterLockJobOptions</a></h5>
+<div class="tsd-comment tsd-typography"><p>Options to be applied on this job only</p>
+</div></li></ul></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" data-tsd-kind="Type parameter">TResult</span><span class="tsd-signature-symbol">&gt;</span></h4></li>
+<li class="tsd-description">
+<div class="tsd-comment tsd-typography"><p>The same as acquire, except if the lock can&#39;t be acquired (the executor never gets called), instead of throwing
+an error, the lock will resolve/callback with the provided failureResult value (for example, a <code>null</code>).</p>
+</div>
+<div class="tsd-type-parameters">
+<h4 class="tsd-type-parameters-title">Type Parameters</h4>
+<ul class="tsd-type-parameters">
+<li>
+<h4>TResult<span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">unknown</span></h4></li></ul></div>
+<div class="tsd-parameters">
+<h4 class="tsd-parameters-title">Parameters</h4>
+<ul class="tsd-parameter-list">
+<li>
+<h5>key: <a href="../types/BetterLockKey.html" class="tsd-signature-type" data-tsd-kind="Type alias">BetterLockKey</a><span class="tsd-signature-symbol"> | </span><a href="../types/BetterLockKey.html" class="tsd-signature-type" data-tsd-kind="Type alias">BetterLockKey</a><span class="tsd-signature-symbol">[]</span></h5>
+<div class="tsd-comment tsd-typography"><p>Named key or array of keys for this particular call. Calls with different keys will be run in parallel. Not required.</p>
+</div></li>
+<li>
+<h5>failureResult: <span class="tsd-signature-type" data-tsd-kind="Type parameter">TResult</span></h5>
+<div class="tsd-comment tsd-typography"><p>The value to return if the executor never get called. This happens instead of rejecting.</p>
+</div></li>
+<li>
+<h5>executor: <a href="../types/_internal_.ICallbackExecutor.html" class="tsd-signature-type" data-tsd-kind="Type alias">ICallbackExecutor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TResult</span><span class="tsd-signature-symbol">&gt;</span></h5>
+<div class="tsd-comment tsd-typography"><p>Function that will run inside the lock. Required.</p>
+</div></li>
+<li>
+<h5><code class="tsd-tag ts-flagOptional">Optional</code> jobOptions: <a href="../interfaces/BetterLockJobOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">BetterLockJobOptions</a></h5>
+<div class="tsd-comment tsd-typography"><p>Options to be applied on this job only</p>
+</div></li></ul></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" data-tsd-kind="Type parameter">TResult</span><span class="tsd-signature-symbol">&gt;</span></h4></li>
+<li class="tsd-description">
+<div class="tsd-comment tsd-typography"><p>The same as acquire, except if the lock can&#39;t be acquired (the executor never gets called), instead of throwing
+an error, the lock will resolve/callback with the provided failureResult value (for example, a <code>null</code>).</p>
+</div>
+<div class="tsd-type-parameters">
+<h4 class="tsd-type-parameters-title">Type Parameters</h4>
+<ul class="tsd-type-parameters">
+<li>
+<h4>TResult<span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">unknown</span></h4></li></ul></div>
+<div class="tsd-parameters">
+<h4 class="tsd-parameters-title">Parameters</h4>
+<ul class="tsd-parameter-list">
+<li>
+<h5>key: <a href="../types/BetterLockKey.html" class="tsd-signature-type" data-tsd-kind="Type alias">BetterLockKey</a><span class="tsd-signature-symbol"> | </span><a href="../types/BetterLockKey.html" class="tsd-signature-type" data-tsd-kind="Type alias">BetterLockKey</a><span class="tsd-signature-symbol">[]</span></h5>
+<div class="tsd-comment tsd-typography"><p>Named key or array of keys for this particular call. Calls with different keys will be run in parallel. Not required.</p>
+</div></li>
+<li>
+<h5>failureResult: <span class="tsd-signature-type" data-tsd-kind="Type parameter">TResult</span></h5>
+<div class="tsd-comment tsd-typography"><p>The value to return if the executor never get called. This happens instead of rejecting.</p>
+</div></li>
+<li>
+<h5>executor: <a href="../types/_internal_.ICallbackExecutor.html" class="tsd-signature-type" data-tsd-kind="Type alias">ICallbackExecutor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TResult</span><span class="tsd-signature-symbol">&gt;</span></h5>
+<div class="tsd-comment tsd-typography"><p>Function that will run inside the lock. Required.</p>
+</div></li>
+<li>
+<h5>callback: <a href="../types/_internal_.ICallback.html" class="tsd-signature-type" data-tsd-kind="Type alias">ICallback</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TResult</span><span class="tsd-signature-symbol">&gt;</span></h5>
+<div class="tsd-comment tsd-typography"><p>Function to be called after the executor finishes, or there is an execution timeout. Leave out to use promises.</p>
+</div></li>
+<li>
+<h5><code class="tsd-tag ts-flagOptional">Optional</code> jobOptions: <a href="../interfaces/BetterLockJobOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">BetterLockJobOptions</a></h5>
+<div class="tsd-comment tsd-typography"><p>Options to be applied on this job only</p>
+</div></li></ul></div>
+<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="canAcquire" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>can<wbr/>Acquire</span><a href="#canAcquire" 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">
@@ -318,6 +499,7 @@ once promise resolves or rejects.</p>
 <li class="tsd-kind-method tsd-parent-kind-class"><a href="_internal_.BetterLock.html#abort" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>abort</a></li>
 <li class="tsd-kind-method tsd-parent-kind-class"><a href="_internal_.BetterLock.html#abortAll" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>abort<wbr/>All</a></li>
 <li class="tsd-kind-method tsd-parent-kind-class"><a href="_internal_.BetterLock.html#acquire" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>acquire</a></li>
+<li class="tsd-kind-method tsd-parent-kind-class"><a href="_internal_.BetterLock.html#acquireOr" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>acquire<wbr/>Or</a></li>
 <li class="tsd-kind-method tsd-parent-kind-class"><a href="_internal_.BetterLock.html#canAcquire" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>can<wbr/>Acquire</a></li></ul></li></ul></nav></div></div>
 <div class="container tsd-generator">
 <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>

package/docs/classes/_internal_.KeyQueue.html

@@ -63,7 +63,7 @@
 <div class="tsd-comment tsd-typography"><p>Active job that is holding this key. This job could be waiting on other keys or executing.</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/internals.ts#L109">internals.ts:109</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/internals.ts#L109">internals.ts:109</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="jobs" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>jobs</span><a href="#jobs" 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">jobs<span class="tsd-signature-symbol">:</span> <a href="_internal_.LockJob.html" class="tsd-signature-type" data-tsd-kind="Class">LockJob</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div>
@@ -71,17 +71,17 @@
 Jobs in this state are governed by the wait_timeout.</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/internals.ts#L104">internals.ts:104</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/internals.ts#L104">internals.ts:104</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="key" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>key</span><a href="#key" 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">key<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/panta82/better-lock/blob/336aa4f/src/internals.ts#L98">internals.ts:98</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/internals.ts#L98">internals.ts:98</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="DEFAULT_QUEUE_KEY" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>DEFAULT_<wbr/>QUEUE_<wbr/>KEY</span><a href="#DEFAULT_QUEUE_KEY" 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">DEFAULT_<wbr/>QUEUE_<wbr/>KEY<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;___DEFAULT_QUEUE_KEY___&quot;</span><span class="tsd-signature-symbol"> = &#39;___DEFAULT_QUEUE_KEY___&#39;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/internals.ts#L96">internals.ts:96</a></li></ul></aside></section></section>
+<li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/internals.ts#L96">internals.ts:96</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="toString" class="tsd-anchor"></a>

package/docs/classes/_internal_.LockJob.html

@@ -89,89 +89,89 @@
 This is supplied by user in callback API, and generated internally otherwise.</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/internals.ts#L32">internals.ts:32</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/internals.ts#L32">internals.ts:32</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="ended_at" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>ended_<wbr/>at</span><a href="#ended_at" 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">ended_<wbr/>at<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol"> = null</span></div>
 <div class="tsd-comment tsd-typography"><p>This is set when job ends, in case something holds a reference to it</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/internals.ts#L47">internals.ts:47</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/internals.ts#L47">internals.ts:47</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="enqueued_at" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>enqueued_<wbr/>at</span><a href="#enqueued_at" 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">enqueued_<wbr/>at<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol"> = ...</span></div>
 <div class="tsd-comment tsd-typography"><p>Timestamp when job was created</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/internals.ts#L37">internals.ts:37</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/internals.ts#L37">internals.ts:37</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="executed_at" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>executed_<wbr/>at</span><a href="#executed_at" 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">executed_<wbr/>at<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol"> = null</span></div>
 <div class="tsd-comment tsd-typography"><p>Timestamp when job was executed</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/internals.ts#L42">internals.ts:42</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/internals.ts#L42">internals.ts:42</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="execution_timeout_id" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>execution_<wbr/>timeout_<wbr/>id</span><a href="#execution_timeout_id" 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">execution_<wbr/>timeout_<wbr/>id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = null</span></div>
 <div class="tsd-comment tsd-typography"><p>Id of the execution timer</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/internals.ts#L62">internals.ts:62</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/internals.ts#L62">internals.ts:62</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="executor" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>executor</span><a href="#executor" 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">executor<span class="tsd-signature-symbol">:</span> <a href="../types/BetterLockExecutor.html" class="tsd-signature-type" data-tsd-kind="Type alias">BetterLockExecutor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TResult</span><span class="tsd-signature-symbol">&gt;</span></div>
 <div class="tsd-comment tsd-typography"><p>Function that will be called inside the lock</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/internals.ts#L26">internals.ts:26</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/internals.ts#L26">internals.ts:26</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="id" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>id</span><a href="#id" 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">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = undefined</span></div>
 <div class="tsd-comment tsd-typography"><p>ID to uniquely identify this particular job</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/internals.ts#L11">internals.ts:11</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/internals.ts#L11">internals.ts:11</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="incoming_stack" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>incoming_<wbr/>stack</span><a href="#incoming_stack" 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">incoming_<wbr/>stack<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = null</span></div>
 <div class="tsd-comment tsd-typography"><p>Saved incoming stack, for the purpose of extending stack traces</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/internals.ts#L67">internals.ts:67</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/internals.ts#L67">internals.ts:67</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="keys" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>keys</span><a href="#keys" 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">keys<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
 <div class="tsd-comment tsd-typography"><p>List of keys that will be locked. Always an array</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/internals.ts#L16">internals.ts:16</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/internals.ts#L16">internals.ts:16</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="options" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>options</span><a href="#options" 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">options<span class="tsd-signature-symbol">:</span> <a href="../interfaces/BetterLockJobOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">BetterLockJobOptions</a></div>
 <div class="tsd-comment tsd-typography"><p>Options that apply to this particular job</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/internals.ts#L52">internals.ts:52</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/internals.ts#L52">internals.ts:52</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="wait_timeout_id" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>wait_<wbr/>timeout_<wbr/>id</span><a href="#wait_timeout_id" 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">wait_<wbr/>timeout_<wbr/>id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = null</span></div>
 <div class="tsd-comment tsd-typography"><p>Id of the wait timer</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/internals.ts#L57">internals.ts:57</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/internals.ts#L57">internals.ts:57</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="waiting_count" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>waiting_<wbr/>count</span><a href="#waiting_count" 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">waiting_<wbr/>count<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
 <div class="tsd-comment tsd-typography"><p>Number of keys which this job is waiting on. Once this reaches 0, job will be executed</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/internals.ts#L21">internals.ts:21</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/internals.ts#L21">internals.ts:21</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="_lastId" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>_last<wbr/>Id</span><a href="#_lastId" 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">_last<wbr/>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/internals.ts#L8">internals.ts:8</a></li></ul></aside></section></section>
+<li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/internals.ts#L8">internals.ts:8</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="toString" class="tsd-anchor"></a>

package/docs/functions/_internal_.__home_panta_dev_pantas_better_lock_src_errors_.isAcquisitionFailureError.html

@@ -0,0 +1,62 @@
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>isAcquisitionFailureError | better-lock</title><meta name="description" content="Documentation for better-lock"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.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">better-lock</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">better-lock</a></li>
+<li><a href="../modules/_internal_.html">&lt;internal&gt;</a></li>
+<li><a href="../modules/_internal_.__home_panta_dev_pantas_better_lock_src_errors_.html">&quot;/home/panta/dev/pantas/better-lock/src/errors&quot;</a></li>
+<li><a href="_internal_.__home_panta_dev_pantas_better_lock_src_errors_.isAcquisitionFailureError.html">isAcquisitionFailureError</a></li></ul>
+<h1>Function isAcquisitionFailureError</h1></div>
+<section class="tsd-panel">
+<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
+<li class="tsd-signature" id="isAcquisitionFailureError">is<wbr/>Acquisition<wbr/>Failure<wbr/>Error<span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul>
+<ul class="tsd-descriptions">
+<li class="tsd-description">
+<div class="tsd-parameters">
+<h4 class="tsd-parameters-title">Parameters</h4>
+<ul class="tsd-parameter-list">
+<li>
+<h5>err: <span class="tsd-signature-type">any</span></h5></li></ul></div>
+<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></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">
+<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> Settings</h3></summary>
+<div class="tsd-accordion-details">
+<div class="tsd-filter-visibility">
+<h4 class="uppercase">Member Visibility</h4><form>
+<ul id="tsd-filter-options">
+<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></form></div>
+<div class="tsd-theme-toggle">
+<h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
+<nav class="tsd-navigation primary">
+<details class="tsd-index-accordion" open><summary class="tsd-accordion-summary">
+<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 class="current"><a href="../modules.html">better-<wbr/>lock</a>
+<ul>
+<li class="current tsd-kind-namespace"><a href="../modules/_internal_.html">&lt;internal&gt;</a>
+<ul>
+<li class="current tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/_internal_.__home_panta_dev_pantas_better_lock_src_errors_.html">&quot;/home/panta/dev/pantas/better-<wbr/>lock/src/errors&quot;</a></li></ul></li></ul></li></ul></div></details></nav>
+<nav class="tsd-navigation secondary menu-sticky">
+<ul>
+<li class="tsd-kind-reference tsd-parent-kind-namespace"><a href="../modules/_internal_.__home_panta_dev_pantas_better_lock_src_errors_.html#BetterLockError" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF4D82" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-8388608-path"></rect><path d="M10.354 17V8.24H13.066C13.586 8.24 14.042 8.348 14.434 8.564C14.826 8.772 15.13 9.064 15.346 9.44C15.562 9.816 15.67 10.256 15.67 10.76C15.67 11.352 15.514 11.86 15.202 12.284C14.898 12.708 14.482 13 13.954 13.16L15.79 17H14.518L12.838 13.28H11.434V17H10.354ZM11.434 12.308H13.066C13.514 12.308 13.874 12.168 14.146 11.888C14.418 11.6 14.554 11.224 14.554 10.76C14.554 10.288 14.418 9.912 14.146 9.632C13.874 9.352 13.514 9.212 13.066 9.212H11.434V12.308Z" fill="var(--color-text)" id="icon-8388608-text"></path></svg>Better<wbr/>Lock<wbr/>Error</a></li>
+<li class="tsd-kind-reference tsd-parent-kind-namespace"><a href="../modules/_internal_.__home_panta_dev_pantas_better_lock_src_errors_.html#BetterLockExecutionTimeoutError" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-8388608-path"></use><use href="#icon-8388608-text"></use></svg>Better<wbr/>Lock<wbr/>Execution<wbr/>Timeout<wbr/>Error</a></li>
+<li class="tsd-kind-reference tsd-parent-kind-namespace"><a href="../modules/_internal_.__home_panta_dev_pantas_better_lock_src_errors_.html#BetterLockInternalError" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-8388608-path"></use><use href="#icon-8388608-text"></use></svg>Better<wbr/>Lock<wbr/>Internal<wbr/>Error</a></li>
+<li class="tsd-kind-reference tsd-parent-kind-namespace"><a href="../modules/_internal_.__home_panta_dev_pantas_better_lock_src_errors_.html#BetterLockInvalidArgumentError" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-8388608-path"></use><use href="#icon-8388608-text"></use></svg>Better<wbr/>Lock<wbr/>Invalid<wbr/>Argument<wbr/>Error</a></li>
+<li class="tsd-kind-reference tsd-parent-kind-namespace"><a href="../modules/_internal_.__home_panta_dev_pantas_better_lock_src_errors_.html#BetterLockJobAbortedError" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-8388608-path"></use><use href="#icon-8388608-text"></use></svg>Better<wbr/>Lock<wbr/>Job<wbr/>Aborted<wbr/>Error</a></li>
+<li class="tsd-kind-reference tsd-parent-kind-namespace"><a href="../modules/_internal_.__home_panta_dev_pantas_better_lock_src_errors_.html#BetterLockQueueOverflowError" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-8388608-path"></use><use href="#icon-8388608-text"></use></svg>Better<wbr/>Lock<wbr/>Queue<wbr/>Overflow<wbr/>Error</a></li>
+<li class="tsd-kind-reference tsd-parent-kind-namespace"><a href="../modules/_internal_.__home_panta_dev_pantas_better_lock_src_errors_.html#BetterLockWaitTimeoutError" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-8388608-path"></use><use href="#icon-8388608-text"></use></svg>Better<wbr/>Lock<wbr/>Wait<wbr/>Timeout<wbr/>Error</a></li>
+<li class="current tsd-kind-function tsd-parent-kind-namespace"><a href="_internal_.__home_panta_dev_pantas_better_lock_src_errors_.isAcquisitionFailureError.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-64-path"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)" id="icon-64-text"></path></svg>is<wbr/>Acquisition<wbr/>Failure<wbr/>Error</a></li></ul></nav></div></div>
+<div class="container tsd-generator">
+<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
+<div class="overlay"></div><script src="../assets/main.js"></script></body></html>