better-lock 3.0.0 → 3.2.0

package/docs/index.html

@@ -87,6 +87,9 @@
 <li><code>jobOptions</code>: An object that should match interface <code>BetterLockJobOptions</code>. A subset of main options that will serve as overrides for this particular job (for example, timeout settings).</li>
 </ul>
 </li>
+<li><p><code>BetterLock.acquireOr([key], failureResult, executor, [callback], [jobOptions])</code><br>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>
+</li>
 <li><p><code>BetterLock.canAcquire([key])</code><br>Returns true if given key can be acquired.</p>
 </li>
 <li><p><code>BetterLock.abort([key])</code><br>Abort all jobs for a given key (or from the default job queue, if no key is given). Job executors will not be called. Callbacks will be called with <code>JobAbortedError</code>. Currently executing job will not be interrupted.</p>
@@ -112,8 +115,6 @@ If you do that, though, and you have a swallowed callback, the lock can remain l
 </li>
 <li><p><code>queue_size</code><br>Max queue size for waiting jobs.</p>
 </li>
-<li><p><code>queue_ejection_strategy</code><br>Which job to eject from the queue when it&#39;s full. Default is <code>newest</code>.</p>
-</li>
 </ul>
 <p>Default options are a static member <code>DEFAULT_OPTIONS</code> on the <code>BetterLock</code> class. During runtime, you can change the defaults like this:</p>
 <pre><code class="language-javascript"><span class="hl-5">import</span><span class="hl-0"> </span><span class="hl-6">BetterLock</span><span class="hl-0"> </span><span class="hl-5">from</span><span class="hl-0"> </span><span class="hl-7">&#39;better-lock&#39;</span><span class="hl-0">;</span><br/><br/><span class="hl-6">BetterLock</span><span class="hl-0">.</span><span class="hl-3">DEFAULT_OPTIONS</span><span class="hl-0">.</span><span class="hl-6">wait_timeout</span><span class="hl-0"> = </span><span class="hl-8">1000</span><span class="hl-0">;</span>
@@ -141,6 +142,16 @@ If you do that, though, and you have a swallowed callback, the lock can remain l
   <h3>Change log</h3>
 </a>
 
+<a href="#320-20240621" id="320-20240621" style="color: inherit; text-decoration: none;">
+  <h4><strong>3.2.0</strong> (<em>2024/06/21</em>)</h4>
+</a>
+<p>Add new api <code>canAcquire</code>. A helper for &quot;best effort&quot; lock acquisition.</p>
+
+<a href="#310-20240621" id="310-20240621" style="color: inherit; text-decoration: none;">
+  <h4><strong>3.1.0</strong> (<em>2024/06/21</em>)</h4>
+</a>
+<p>Add option <code>lock_condition</code>.</p>
+
 <a href="#300-20240418" id="300-20240418" style="color: inherit; text-decoration: none;">
   <h4><strong>3.0.0</strong> (<em>2024/04/18</em>)</h4>
 </a>

package/docs/interfaces/BetterLockJobOptions.html

@@ -32,6 +32,10 @@
 <div class="tsd-index-list"><a href="BetterLockJobOptions.html#execution_timeout" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><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>execution_<wbr/>timeout</span></a>
 <a href="BetterLockJobOptions.html#extend_stack_traces" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><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>extend_<wbr/>stack_<wbr/>traces</span></a>
 <a href="BetterLockJobOptions.html#wait_timeout" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><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>wait_<wbr/>timeout</span></a>
+</div></section>
+<section class="tsd-index-section">
+<h3 class="tsd-index-heading">Methods</h3>
+<div class="tsd-index-list"><a href="BetterLockJobOptions.html#lock_condition" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface"><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>lock_<wbr/>condition</span></a>
 </div></section></div></details></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Properties</h2>
@@ -41,21 +45,39 @@
 <div class="tsd-comment tsd-typography"><p>How long can a job be executing before timing out. Null to disable timeout. Overrides BetterLockOptions value.</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/options.ts#L13">options.ts:13</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/options.ts#L15">options.ts:15</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="extend_stack_traces" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>extend_<wbr/>stack_<wbr/>traces</span><a href="#extend_stack_traces" 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">extend_<wbr/>stack_<wbr/>traces<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
 <div class="tsd-comment tsd-typography"><p>In any error produced by BetterLock, extend the stack trace to include incoming trace. Overrides BetterLockOptions value.</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/options.ts#L18">options.ts:18</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/options.ts#L20">options.ts:20</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="wait_timeout" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>wait_<wbr/>timeout</span><a href="#wait_timeout" 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<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
 <div class="tsd-comment tsd-typography"><p>How long can jobs wait in queue before timing out. Overrides BetterLockOptions value.</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/options.ts#L8">options.ts:8</a></li></ul></aside></section></section></div>
+<li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/options.ts#L10">options.ts:10</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-interface"><a id="lock_condition" class="tsd-anchor"></a>
+<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>lock_<wbr/>condition</span><a href="#lock_condition" 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-interface">
+<li class="tsd-signature" id="lock_condition.lock_condition-1">lock_<wbr/>condition<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><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-comment tsd-typography"><p>Before acquiring lock, call this function with the given key. If condition is rejected, the executor is immediately called, without locking.
+This can be used to more conveniently opt out of locking, without duplicating or extracting the executor.
+Overrides BetterLockOptions value.</p>
+</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></li></ul></div>
+<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></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">
@@ -83,7 +105,8 @@
 <ul>
 <li class="tsd-kind-property tsd-parent-kind-interface"><a href="BetterLockJobOptions.html#execution_timeout" 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>execution_<wbr/>timeout</a></li>
 <li class="tsd-kind-property tsd-parent-kind-interface"><a href="BetterLockJobOptions.html#extend_stack_traces" 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>extend_<wbr/>stack_<wbr/>traces</a></li>
-<li class="tsd-kind-property tsd-parent-kind-interface"><a href="BetterLockJobOptions.html#wait_timeout" 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>wait_<wbr/>timeout</a></li></ul></li></ul></nav></div></div>
+<li class="tsd-kind-property tsd-parent-kind-interface"><a href="BetterLockJobOptions.html#wait_timeout" 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>wait_<wbr/>timeout</a></li>
+<li class="tsd-kind-method tsd-parent-kind-interface"><a href="BetterLockJobOptions.html#lock_condition" 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>lock_<wbr/>condition</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>
 <div class="overlay"></div><script src="../assets/main.js"></script></body></html>

package/docs/interfaces/BetterLockOptions.html

@@ -39,7 +39,8 @@
 </div></section>
 <section class="tsd-index-section">
 <h3 class="tsd-index-heading">Methods</h3>
-<div class="tsd-index-list"><a href="BetterLockOptions.html#promise_tester" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface"><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>promise_<wbr/>tester</span></a>
+<div class="tsd-index-list"><a href="BetterLockOptions.html#lock_condition" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface"><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>lock_<wbr/>condition</span></a>
+<a href="BetterLockOptions.html#promise_tester" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface"><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>promise_<wbr/>tester</span></a>
 </div></section></div></details></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Properties</h2>
@@ -51,7 +52,7 @@ If you do that, though, and you have a swallowed callback, the lock can remain l
 </div><aside class="tsd-sources">
 <p>Overrides <a href="BetterLockJobOptions.html">BetterLockJobOptions</a>.<a href="BetterLockJobOptions.html#execution_timeout">execution_timeout</a></p>
 <ul>
-<li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/options.ts#L36">options.ts:36</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/options.ts#L45">options.ts:45</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="extend_stack_traces" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>extend_<wbr/>stack_<wbr/>traces</span><a href="#extend_stack_traces" 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">extend_<wbr/>stack_<wbr/>traces<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
@@ -60,35 +61,35 @@ Defaults to true.</p>
 </div><aside class="tsd-sources">
 <p>Overrides <a href="BetterLockJobOptions.html">BetterLockJobOptions</a>.<a href="BetterLockJobOptions.html#extend_stack_traces">extend_stack_traces</a></p>
 <ul>
-<li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/options.ts#L62">options.ts:62</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/options.ts#L77">options.ts:77</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="log" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>log</span><a href="#log" 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">log<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>msg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></div>
 <div class="tsd-comment tsd-typography"><p>Whether to log the internal actions. Set to true to use console.log. Alternatively, provide your own function</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/options.ts#L56">options.ts:56</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/options.ts#L71">options.ts:71</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="name" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>name</span><a href="#name" 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">name<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
 <div class="tsd-comment tsd-typography"><p>Lock name. This will be written in all logs and error messages, to help you distinguish between different locks</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/options.ts#L51">options.ts:51</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/options.ts#L66">options.ts:66</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="queue_ejection_strategy" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>queue_<wbr/>ejection_<wbr/>strategy</span><a href="#queue_ejection_strategy" 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">queue_<wbr/>ejection_<wbr/>strategy<span class="tsd-signature-symbol">?:</span> <a href="../types/BetterLockQueueEjectionStrategy.html" class="tsd-signature-type" data-tsd-kind="Type alias">BetterLockQueueEjectionStrategy</a></div>
 <div class="tsd-comment tsd-typography"><p>If queue is full, which job to eject. Defaults to &#39;oldest&#39;.</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/options.ts#L46">options.ts:46</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/options.ts#L55">options.ts:55</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="queue_size" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>queue_<wbr/>size</span><a href="#queue_size" 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">queue_<wbr/>size<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
 <div class="tsd-comment tsd-typography"><p>Max queue size for waiting jobs.</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/options.ts#L41">options.ts:41</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/options.ts#L50">options.ts:50</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="wait_timeout" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>wait_<wbr/>timeout</span><a href="#wait_timeout" 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<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
@@ -96,9 +97,25 @@ Defaults to true.</p>
 </div><aside class="tsd-sources">
 <p>Overrides <a href="BetterLockJobOptions.html">BetterLockJobOptions</a>.<a href="BetterLockJobOptions.html#wait_timeout">wait_timeout</a></p>
 <ul>
-<li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/options.ts#L30">options.ts:30</a></li></ul></aside></section></section>
+<li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/options.ts#L39">options.ts:39</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-interface"><a id="lock_condition" class="tsd-anchor"></a>
+<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>lock_<wbr/>condition</span><a href="#lock_condition" 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-interface">
+<li class="tsd-signature" id="lock_condition.lock_condition-1">lock_<wbr/>condition<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><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-comment tsd-typography"><p>Before acquiring lock, call this function with the given key. If condition is rejected, the executor is immediately called, without locking.
+This can be used to more conveniently opt out of locking, without duplicating or extracting the executor.</p>
+</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></li></ul></div>
+<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
+<p>Overrides <a href="BetterLockJobOptions.html">BetterLockJobOptions</a>.<a href="BetterLockJobOptions.html#lock_condition">lock_condition</a></p></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="promise_tester" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>promise_<wbr/>tester</span><a href="#promise_tester" 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-interface">
@@ -147,6 +164,7 @@ you might want to tighten or loosen this bit.</p>
 <li class="tsd-kind-property tsd-parent-kind-interface"><a href="BetterLockOptions.html#queue_ejection_strategy" 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>queue_<wbr/>ejection_<wbr/>strategy</a></li>
 <li class="tsd-kind-property tsd-parent-kind-interface"><a href="BetterLockOptions.html#queue_size" 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>queue_<wbr/>size</a></li>
 <li class="tsd-kind-property tsd-parent-kind-interface"><a href="BetterLockOptions.html#wait_timeout" 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>wait_<wbr/>timeout</a></li>
+<li class="tsd-kind-method tsd-parent-kind-interface"><a href="BetterLockOptions.html#lock_condition" 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>lock_<wbr/>condition</a></li>
 <li class="tsd-kind-method tsd-parent-kind-interface"><a href="BetterLockOptions.html#promise_tester" 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>promise_<wbr/>tester</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/modules/_internal_.__home_panta_dev_pantas_better_lock_src_errors_.html

@@ -28,6 +28,10 @@
 <a href="_internal_.__home_panta_dev_pantas_better_lock_src_errors_.html#BetterLockJobAbortedError" class="tsd-index-link tsd-kind-reference tsd-parent-kind-namespace"><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><span>Better<wbr/>Lock<wbr/>Job<wbr/>Aborted<wbr/>Error</span></a>
 <a href="_internal_.__home_panta_dev_pantas_better_lock_src_errors_.html#BetterLockQueueOverflowError" class="tsd-index-link tsd-kind-reference tsd-parent-kind-namespace"><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><span>Better<wbr/>Lock<wbr/>Queue<wbr/>Overflow<wbr/>Error</span></a>
 <a href="_internal_.__home_panta_dev_pantas_better_lock_src_errors_.html#BetterLockWaitTimeoutError" class="tsd-index-link tsd-kind-reference tsd-parent-kind-namespace"><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><span>Better<wbr/>Lock<wbr/>Wait<wbr/>Timeout<wbr/>Error</span></a>
+</div></section>
+<section class="tsd-index-section">
+<h3 class="tsd-index-heading">Functions</h3>
+<div class="tsd-index-list"><a href="../functions/_internal_.__home_panta_dev_pantas_better_lock_src_errors_.isAcquisitionFailureError.html" class="tsd-index-link tsd-kind-function tsd-parent-kind-namespace"><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><span>is<wbr/>Acquisition<wbr/>Failure<wbr/>Error</span></a>
 </div></section></div></details></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>References</h2>
@@ -74,7 +78,8 @@
 <li class="tsd-kind-reference tsd-parent-kind-namespace"><a href="_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="_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="_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="_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></ul></nav></div></div>
+<li class="tsd-kind-reference tsd-parent-kind-namespace"><a href="_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="tsd-kind-function tsd-parent-kind-namespace"><a href="../functions/_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"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></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>

package/docs/types/BetterLockErrorName.html

@@ -17,7 +17,7 @@
 <div class="tsd-comment tsd-typography"><p>All error names that we can emit</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/types.ts#L8">types.ts:8</a></li></ul></aside></div>
+<li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/types.ts#L8">types.ts:8</a></li></ul></aside></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">

package/docs/types/BetterLockExecutor.html

@@ -19,7 +19,7 @@
 <li>
 <h4>TResult</h4></li></ul><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/types.ts#L24">types.ts:24</a></li></ul></aside></div>
+<li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/types.ts#L24">types.ts:24</a></li></ul></aside></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">

package/docs/types/BetterLockKey.html

@@ -17,7 +17,7 @@
 <div class="tsd-comment tsd-typography"><p>Key types that can be used for a lock.</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/types.ts#L29">types.ts:29</a></li></ul></aside></div>
+<li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/types.ts#L29">types.ts:29</a></li></ul></aside></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">

package/docs/types/BetterLockQueueEjectionStrategy.html

@@ -15,7 +15,7 @@
 <h1>Type alias BetterLockQueueEjectionStrategy</h1></div>
 <div class="tsd-signature">Better<wbr/>Lock<wbr/>Queue<wbr/>Ejection<wbr/>Strategy<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;oldest&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;newest&quot;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/options.ts#L21">options.ts:21</a></li></ul></aside></div>
+<li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/options.ts#L30">options.ts:30</a></li></ul></aside></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">

package/docs/types/_internal_.ICallback.html

@@ -23,7 +23,7 @@ but also old-school callbacks, with varargs return values.</p>
 <li>
 <h4>TResult</h4></li></ul><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/types.ts#L14">types.ts:14</a></li></ul></aside></div>
+<li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/types.ts#L14">types.ts:14</a></li></ul></aside></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">

package/docs/types/_internal_.ICallbackExecutor.html

@@ -37,7 +37,7 @@ It can either accept a done() function, or return a promise.</p>
 <h5>lockDone: <a href="_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></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/types.ts#L22">types.ts:22</a></li></ul></aside></div>
+<li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/types.ts#L22">types.ts:22</a></li></ul></aside></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">

package/docs/types/_internal_.IErrorExports.html

@@ -16,7 +16,7 @@
 <h1>Type alias IErrorExports</h1></div>
 <div class="tsd-signature">IError<wbr/>Exports<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">typeof </span><a href="../modules/_internal_.__home_panta_dev_pantas_better_lock_src_errors_.html" class="tsd-signature-type" data-tsd-kind="Namespace">&quot;/home/panta/dev/pantas/better-lock/src/errors&quot;</a></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/types.ts#L3">types.ts:3</a></li></ul></aside></div>
+<li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/types.ts#L3">types.ts:3</a></li></ul></aside></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">

package/docs/types/_internal_.IPromiseExecutor.html

@@ -29,7 +29,7 @@
 <li class="tsd-description">
 <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></ul></li></ul></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/types.ts#L23">types.ts:23</a></li></ul></aside></div>
+<li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/types.ts#L23">types.ts:23</a></li></ul></aside></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">

package/docs/variables/BetterLock.html

@@ -15,7 +15,7 @@
 <h1>Variable BetterLock<code class="tsd-tag ts-flagConst">Const</code> </h1></div>
 <div class="tsd-signature">Better<wbr/>Lock<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">typeof </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace">&lt;internal&gt;</a><span class="tsd-signature-symbol">.</span><a href="../classes/_internal_.BetterLock.html" class="tsd-signature-type" data-tsd-kind="Class">BetterLock</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span>BetterLock<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">typeof </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace">&lt;internal&gt;</a><span class="tsd-signature-symbol">.</span><a href="../classes/_internal_.BetterLock.html" class="tsd-signature-type" data-tsd-kind="Class">BetterLock</a><span class="tsd-signature-symbol">; </span>Error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">typeof </span><a href="../classes/BetterLockError.html" class="tsd-signature-type" data-tsd-kind="Class">BetterLockError</a><span class="tsd-signature-symbol">; </span>ExecutionTimeoutError<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">typeof </span><a href="../classes/BetterLockExecutionTimeoutError.html" class="tsd-signature-type" data-tsd-kind="Class">BetterLockExecutionTimeoutError</a><span class="tsd-signature-symbol">; </span>InternalError<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">typeof </span><a href="../classes/BetterLockInternalError.html" class="tsd-signature-type" data-tsd-kind="Class">BetterLockInternalError</a><span class="tsd-signature-symbol">; </span>InvalidArgumentError<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">typeof </span><a href="../classes/BetterLockInvalidArgumentError.html" class="tsd-signature-type" data-tsd-kind="Class">BetterLockInvalidArgumentError</a><span class="tsd-signature-symbol">; </span>JobAbortedError<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">typeof </span><a href="../classes/BetterLockJobAbortedError.html" class="tsd-signature-type" data-tsd-kind="Class">BetterLockJobAbortedError</a><span class="tsd-signature-symbol">; </span>QueueOverflowError<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">typeof </span><a href="../classes/BetterLockQueueOverflowError.html" class="tsd-signature-type" data-tsd-kind="Class">BetterLockQueueOverflowError</a><span class="tsd-signature-symbol">; </span>WaitTimeoutError<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">typeof </span><a href="../classes/BetterLockWaitTimeoutError.html" class="tsd-signature-type" data-tsd-kind="Class">BetterLockWaitTimeoutError</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/index.ts#L43">index.ts:43</a></li></ul></aside></div>
+<li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/index.ts#L43">index.ts:43</a></li></ul></aside></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">

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "better-lock",
-  "version": "3.0.0",
+  "version": "3.2.0",
   "description": "A (better) node.js lock library",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/spec/better_lock.spec.ts

@@ -1,5 +1,6 @@
 import BetterLock from '../src/index';
 import { LockJob } from '../src/internals';
+import { ILockJobOptions } from '../src/options';
 
 describe('BetterLock', () => {
   let baseDefaultOptions;
@@ -626,6 +627,165 @@ describe('BetterLock', () => {
         });
     });
   });
+
+  describe('will respect lock_condition', () => {
+    function runJob(
+      lock: InstanceType<typeof BetterLock>,
+      key: string,
+      expectedMs: number,
+      options?: ILockJobOptions
+    ) {
+      const startedAt = new Date();
+      let executed = false;
+      return lock
+        .acquire(
+          key,
+          () => {
+            executed = true;
+            expectMs(new Date().valueOf() - startedAt.valueOf(), expectedMs);
+            return waitPromise(50);
+          },
+          options
+        )
+        .finally(() => {
+          expect(executed).toBeTruthy();
+        });
+    }
+
+    it('for global condition', async () => {
+      const lock = new BetterLock({
+        lock_condition: key => !String(key).startsWith('a'),
+      });
+
+      await Promise.all([
+        runJob(lock, 'a', 0),
+        runJob(lock, 'a', 0),
+        runJob(lock, 'a', 0),
+        runJob(lock, 'b', 0),
+        runJob(lock, 'b', 50),
+        runJob(lock, 'b', 100),
+      ]);
+    });
+
+    it('for local condition', async () => {
+      const lock = new BetterLock({
+        lock_condition: key => !String(key).startsWith('a'),
+      });
+
+      const overrideToB = {
+        lock_condition: key => !String(key).startsWith('b'),
+      };
+
+      await Promise.all([
+        runJob(lock, 'b', 0, overrideToB),
+        runJob(lock, 'b', 0, overrideToB),
+        runJob(lock, 'b', 0, overrideToB),
+        runJob(lock, 'a', 0, overrideToB),
+        runJob(lock, 'a', 50, overrideToB),
+        runJob(lock, 'a', 100, overrideToB),
+      ]);
+    });
+  });
+
+  describe('acquireOr', () => {
+    describe('will correctly handle failureResults', () => {
+      it('from QueueOverflowError', testDone => {
+        const lock = new BetterLock({
+          wait_timeout: 200, // should never trigger
+          execution_timeout: 300, // should never trigger
+          queue_size: 2,
+        });
+
+        let cbCount = 0;
+        lock.acquireOr(0, waitCallback(25, null, 1), (err, res) => {
+          // The executing one
+          cbCount++;
+          expect(cbCount).toEqual(2);
+          expect(err).toBeNull();
+          expect(res).toEqual(1);
+        });
+        lock.acquireOr(0, waitCallback(5, null, 2), (err, res) => {
+          // This is the one that will get kicked out
+          cbCount++;
+          expect(cbCount).toEqual(1);
+          expect(err).toBeNull();
+          expect(res).toEqual(0);
+        });
+        lock.acquireOr(0, waitCallback(5, null, 3), (err, res) => {
+          cbCount++;
+          expect(cbCount).toEqual(3);
+          expect(err).toBeNull();
+          expect(res).toEqual(3);
+          testDone();
+        });
+        lock.acquireOr(0, waitCallback(5, null, 4), (err, res) => {
+          // This one will trigger the kicking out.
+          cbCount++;
+          expect(cbCount).toEqual(4);
+          expect(err).toBeNull();
+          expect(res).toEqual(4);
+        });
+      });
+
+      it('from WaitTimeoutError', async () => {
+        const lock = new BetterLock({
+          wait_timeout: 50,
+          execution_timeout: 100, // should never trigger
+        });
+
+        const promise1 = lock.acquireOr('fail1', waitCallback(75, null, 'ok1'));
+        const promise2 = lock.acquireOr('fail2', waitCallback(200000, null, 'ok2'));
+
+        // Enqueue after some time, this one should run
+        await waitPromise(50);
+        const promise3 = lock.acquireOr('fail3', waitCallback(50, null, 'ok3'));
+
+        const results = await Promise.all([promise1, promise2, promise3]);
+
+        expect(results).toEqual(['ok1', 'fail2', 'ok3']);
+      });
+
+      it('from AbortedError', async () => {
+        const lock = new BetterLock();
+
+        let noCallCount = 0;
+        const noCall = () => {
+          noCallCount++;
+        };
+
+        let cbCount = 0;
+        const callback = (err, res) => {
+          cbCount++;
+          expect(err).toBeNull();
+          expect(res).toEqual('fail');
+        };
+
+        lock.acquireOr('fail', noCall, callback);
+        lock.acquireOr('a', 'fail', noCall, callback);
+        lock.acquireOr('b', 'fail', noCall, callback);
+
+        lock.abortAll();
+
+        expect(lock.canAcquire()).toBeTruthy();
+        expect(lock.canAcquire('a')).toBeTruthy();
+        expect(lock.canAcquire('b')).toBeTruthy();
+        expect(noCallCount).toEqual(0);
+        expect(cbCount).toEqual(3);
+      });
+    });
+
+    it('will correctly pass other errors ', async () => {
+      const lock = new BetterLock({
+        execution_timeout: 10,
+      });
+
+      await expect(
+        lock.acquireOr('fail', async () => {
+          await waitPromise(20); // Should cause ExecutionTimeoutError.
+        })
+      ).rejects.toBeInstanceOf(BetterLock.ExecutionTimeoutError);
+    });
+  });
 });
 
 function waitCallback(ms: number, ...args): (done: (...args: any) => void) => void {