better-lock 3.1.0 → 3.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (38) hide show
  1. package/README.md +8 -0
  2. package/dist/better_lock.d.ts +13 -7
  3. package/dist/better_lock.js +55 -1
  4. package/dist/better_lock.js.map +1 -1
  5. package/dist/errors.d.ts +1 -0
  6. package/dist/errors.js +7 -1
  7. package/dist/errors.js.map +1 -1
  8. package/dist/types.d.ts +4 -0
  9. package/docs/assets/search.js +1 -1
  10. package/docs/classes/BetterLockError.html +3 -3
  11. package/docs/classes/BetterLockExecutionTimeoutError.html +6 -6
  12. package/docs/classes/BetterLockInternalError.html +3 -3
  13. package/docs/classes/BetterLockInvalidArgumentError.html +4 -4
  14. package/docs/classes/BetterLockJobAbortedError.html +5 -5
  15. package/docs/classes/BetterLockQueueOverflowError.html +8 -8
  16. package/docs/classes/BetterLockWaitTimeoutError.html +6 -6
  17. package/docs/classes/_internal_.BetterLock.html +189 -7
  18. package/docs/classes/_internal_.KeyQueue.html +4 -4
  19. package/docs/classes/_internal_.LockJob.html +13 -13
  20. package/docs/functions/_internal_.__home_panta_dev_pantas_better_lock_src_errors_.isAcquisitionFailureError.html +62 -0
  21. package/docs/index.html +13 -2
  22. package/docs/interfaces/BetterLockJobOptions.html +27 -4
  23. package/docs/interfaces/BetterLockOptions.html +26 -8
  24. package/docs/modules/_internal_.__home_panta_dev_pantas_better_lock_src_errors_.html +6 -1
  25. package/docs/types/BetterLockErrorName.html +1 -1
  26. package/docs/types/BetterLockExecutor.html +1 -1
  27. package/docs/types/BetterLockKey.html +1 -1
  28. package/docs/types/BetterLockQueueEjectionStrategy.html +1 -1
  29. package/docs/types/_internal_.ICallback.html +1 -1
  30. package/docs/types/_internal_.ICallbackExecutor.html +1 -1
  31. package/docs/types/_internal_.IErrorExports.html +1 -1
  32. package/docs/types/_internal_.IPromiseExecutor.html +1 -1
  33. package/docs/variables/BetterLock.html +1 -1
  34. package/package.json +1 -1
  35. package/spec/better_lock.spec.ts +100 -0
  36. package/src/better_lock.ts +89 -8
  37. package/src/errors.ts +14 -1
  38. package/src/types.ts +5 -0
package/docs/classes/BetterLockInternalError.html CHANGED
@@ -59,15 +59,15 @@
59
59
  </div><aside class="tsd-sources">
60
60
  <p>Inherited from <a href="BetterLockError.html">BetterLockError</a>.<a href="BetterLockError.html#lock_name">lock_name</a></p>
61
61
  <ul>
62
- <li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/errors.ts#L9">errors.ts:9</a></li></ul></aside></section>
62
+ <li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/errors.ts#L9">errors.ts:9</a></li></ul></aside></section>
63
63
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="name" class="tsd-anchor"></a>
64
64
  <h3 class="tsd-anchor-link"><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>
65
- <div class="tsd-signature">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;BetterLockError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockInternalError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockInvalidArgumentError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockWaitTimeoutError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockExecutionTimeoutError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockQueueOverflowError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockJobAbortedError&quot;</span></div>
65
+ <div class="tsd-signature">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;isAcquisitionFailureError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockInternalError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockInvalidArgumentError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockWaitTimeoutError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockExecutionTimeoutError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockQueueOverflowError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockJobAbortedError&quot;</span></div>
66
66
  <div class="tsd-comment tsd-typography"><p>Error name, maps to error&#39;s class name. Eg. BetterLockError.</p>
67
67
  </div><aside class="tsd-sources">
68
68
  <p>Inherited from <a href="BetterLockError.html">BetterLockError</a>.<a href="BetterLockError.html#name">name</a></p>
69
69
  <ul>
70
- <li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/errors.ts#L14">errors.ts:14</a></li></ul></aside></section></section></div>
70
+ <li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/errors.ts#L14">errors.ts:14</a></li></ul></aside></section></section></div>
71
71
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
72
72
  <div class="tsd-navigation settings">
73
73
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/docs/classes/BetterLockInvalidArgumentError.html CHANGED
@@ -61,7 +61,7 @@
61
61
  <h3 class="tsd-anchor-link"><span>argument</span><a href="#argument" 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>
62
62
  <div class="tsd-signature">argument<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources">
63
63
  <ul>
64
- <li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/errors.ts#L54">errors.ts:54</a></li></ul></aside></section>
64
+ <li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/errors.ts#L56">errors.ts:56</a></li></ul></aside></section>
65
65
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="lock_name" class="tsd-anchor"></a>
66
66
  <h3 class="tsd-anchor-link"><span>lock_<wbr/>name</span><a href="#lock_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>
67
67
  <div class="tsd-signature">lock_<wbr/>name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
@@ -69,15 +69,15 @@
69
69
  </div><aside class="tsd-sources">
70
70
  <p>Inherited from <a href="BetterLockError.html">BetterLockError</a>.<a href="BetterLockError.html#lock_name">lock_name</a></p>
71
71
  <ul>
72
- <li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/errors.ts#L9">errors.ts:9</a></li></ul></aside></section>
72
+ <li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/errors.ts#L9">errors.ts:9</a></li></ul></aside></section>
73
73
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="name" class="tsd-anchor"></a>
74
74
  <h3 class="tsd-anchor-link"><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>
75
- <div class="tsd-signature">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;BetterLockError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockInternalError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockInvalidArgumentError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockWaitTimeoutError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockExecutionTimeoutError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockQueueOverflowError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockJobAbortedError&quot;</span></div>
75
+ <div class="tsd-signature">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;isAcquisitionFailureError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockInternalError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockInvalidArgumentError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockWaitTimeoutError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockExecutionTimeoutError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockQueueOverflowError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockJobAbortedError&quot;</span></div>
76
76
  <div class="tsd-comment tsd-typography"><p>Error name, maps to error&#39;s class name. Eg. BetterLockError.</p>
77
77
  </div><aside class="tsd-sources">
78
78
  <p>Inherited from <a href="BetterLockError.html">BetterLockError</a>.<a href="BetterLockError.html#name">name</a></p>
79
79
  <ul>
80
- <li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/errors.ts#L14">errors.ts:14</a></li></ul></aside></section></section></div>
80
+ <li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/errors.ts#L14">errors.ts:14</a></li></ul></aside></section></section></div>
81
81
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
82
82
  <div class="tsd-navigation settings">
83
83
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/docs/classes/BetterLockJobAbortedError.html CHANGED
@@ -58,12 +58,12 @@
58
58
  <h3 class="tsd-anchor-link"><span>job_<wbr/>id</span><a href="#job_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>
59
59
  <div class="tsd-signature">job_<wbr/>id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
60
60
  <ul>
61
- <li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/errors.ts#L118">errors.ts:118</a></li></ul></aside></section>
61
+ <li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/errors.ts#L123">errors.ts:123</a></li></ul></aside></section>
62
62
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="keys" class="tsd-anchor"></a>
63
63
  <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>
64
64
  <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><aside class="tsd-sources">
65
65
  <ul>
66
- <li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/errors.ts#L119">errors.ts:119</a></li></ul></aside></section>
66
+ <li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/errors.ts#L124">errors.ts:124</a></li></ul></aside></section>
67
67
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="lock_name" class="tsd-anchor"></a>
68
68
  <h3 class="tsd-anchor-link"><span>lock_<wbr/>name</span><a href="#lock_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>
69
69
  <div class="tsd-signature">lock_<wbr/>name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
@@ -71,15 +71,15 @@
71
71
  </div><aside class="tsd-sources">
72
72
  <p>Inherited from <a href="BetterLockError.html">BetterLockError</a>.<a href="BetterLockError.html#lock_name">lock_name</a></p>
73
73
  <ul>
74
- <li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/errors.ts#L9">errors.ts:9</a></li></ul></aside></section>
74
+ <li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/errors.ts#L9">errors.ts:9</a></li></ul></aside></section>
75
75
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="name" class="tsd-anchor"></a>
76
76
  <h3 class="tsd-anchor-link"><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>
77
- <div class="tsd-signature">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;BetterLockError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockInternalError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockInvalidArgumentError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockWaitTimeoutError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockExecutionTimeoutError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockQueueOverflowError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockJobAbortedError&quot;</span></div>
77
+ <div class="tsd-signature">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;isAcquisitionFailureError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockInternalError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockInvalidArgumentError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockWaitTimeoutError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockExecutionTimeoutError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockQueueOverflowError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockJobAbortedError&quot;</span></div>
78
78
  <div class="tsd-comment tsd-typography"><p>Error name, maps to error&#39;s class name. Eg. BetterLockError.</p>
79
79
  </div><aside class="tsd-sources">
80
80
  <p>Inherited from <a href="BetterLockError.html">BetterLockError</a>.<a href="BetterLockError.html#name">name</a></p>
81
81
  <ul>
82
- <li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/errors.ts#L14">errors.ts:14</a></li></ul></aside></section></section></div>
82
+ <li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/errors.ts#L14">errors.ts:14</a></li></ul></aside></section></section></div>
83
83
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
84
84
  <div class="tsd-navigation settings">
85
85
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/docs/classes/BetterLockQueueOverflowError.html CHANGED
@@ -67,22 +67,22 @@
67
67
  <h3 class="tsd-anchor-link"><span>job_<wbr/>count</span><a href="#job_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>
68
68
  <div class="tsd-signature">job_<wbr/>count<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
69
69
  <ul>
70
- <li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/errors.ts#L99">errors.ts:99</a></li></ul></aside></section>
70
+ <li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/errors.ts#L104">errors.ts:104</a></li></ul></aside></section>
71
71
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="job_id" class="tsd-anchor"></a>
72
72
  <h3 class="tsd-anchor-link"><span>job_<wbr/>id</span><a href="#job_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>
73
73
  <div class="tsd-signature">job_<wbr/>id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
74
74
  <ul>
75
- <li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/errors.ts#L97">errors.ts:97</a></li></ul></aside></section>
75
+ <li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/errors.ts#L102">errors.ts:102</a></li></ul></aside></section>
76
76
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="keys" class="tsd-anchor"></a>
77
77
  <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>
78
78
  <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><aside class="tsd-sources">
79
79
  <ul>
80
- <li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/errors.ts#L98">errors.ts:98</a></li></ul></aside></section>
80
+ <li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/errors.ts#L103">errors.ts:103</a></li></ul></aside></section>
81
81
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="kicked_out_job_id" class="tsd-anchor"></a>
82
82
  <h3 class="tsd-anchor-link"><span>kicked_<wbr/>out_<wbr/>job_<wbr/>id</span><a href="#kicked_out_job_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>
83
83
  <div class="tsd-signature">kicked_<wbr/>out_<wbr/>job_<wbr/>id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
84
84
  <ul>
85
- <li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/errors.ts#L100">errors.ts:100</a></li></ul></aside></section>
85
+ <li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/errors.ts#L105">errors.ts:105</a></li></ul></aside></section>
86
86
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="lock_name" class="tsd-anchor"></a>
87
87
  <h3 class="tsd-anchor-link"><span>lock_<wbr/>name</span><a href="#lock_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>
88
88
  <div class="tsd-signature">lock_<wbr/>name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
@@ -90,20 +90,20 @@
90
90
  </div><aside class="tsd-sources">
91
91
  <p>Inherited from <a href="BetterLockError.html">BetterLockError</a>.<a href="BetterLockError.html#lock_name">lock_name</a></p>
92
92
  <ul>
93
- <li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/errors.ts#L9">errors.ts:9</a></li></ul></aside></section>
93
+ <li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/errors.ts#L9">errors.ts:9</a></li></ul></aside></section>
94
94
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="name" class="tsd-anchor"></a>
95
95
  <h3 class="tsd-anchor-link"><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>
96
- <div class="tsd-signature">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;BetterLockError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockInternalError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockInvalidArgumentError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockWaitTimeoutError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockExecutionTimeoutError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockQueueOverflowError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockJobAbortedError&quot;</span></div>
96
+ <div class="tsd-signature">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;isAcquisitionFailureError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockInternalError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockInvalidArgumentError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockWaitTimeoutError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockExecutionTimeoutError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockQueueOverflowError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockJobAbortedError&quot;</span></div>
97
97
  <div class="tsd-comment tsd-typography"><p>Error name, maps to error&#39;s class name. Eg. BetterLockError.</p>
98
98
  </div><aside class="tsd-sources">
99
99
  <p>Inherited from <a href="BetterLockError.html">BetterLockError</a>.<a href="BetterLockError.html#name">name</a></p>
100
100
  <ul>
101
- <li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/errors.ts#L14">errors.ts:14</a></li></ul></aside></section>
101
+ <li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/errors.ts#L14">errors.ts:14</a></li></ul></aside></section>
102
102
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="strategy" class="tsd-anchor"></a>
103
103
  <h3 class="tsd-anchor-link"><span>strategy</span><a href="#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>
104
104
  <div class="tsd-signature">strategy<span class="tsd-signature-symbol">:</span> <a href="../types/BetterLockQueueEjectionStrategy.html" class="tsd-signature-type" data-tsd-kind="Type alias">BetterLockQueueEjectionStrategy</a></div><aside class="tsd-sources">
105
105
  <ul>
106
- <li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/errors.ts#L101">errors.ts:101</a></li></ul></aside></section></section></div>
106
+ <li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/errors.ts#L106">errors.ts:106</a></li></ul></aside></section></section></div>
107
107
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
108
108
  <div class="tsd-navigation settings">
109
109
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/docs/classes/BetterLockWaitTimeoutError.html CHANGED
@@ -59,17 +59,17 @@
59
59
  <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>
60
60
  <div class="tsd-signature">enqueued_<wbr/>at<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div><aside class="tsd-sources">
61
61
  <ul>
62
- <li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/errors.ts#L63">errors.ts:63</a></li></ul></aside></section>
62
+ <li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/errors.ts#L68">errors.ts:68</a></li></ul></aside></section>
63
63
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="job_id" class="tsd-anchor"></a>
64
64
  <h3 class="tsd-anchor-link"><span>job_<wbr/>id</span><a href="#job_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>
65
65
  <div class="tsd-signature">job_<wbr/>id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
66
66
  <ul>
67
- <li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/errors.ts#L61">errors.ts:61</a></li></ul></aside></section>
67
+ <li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/errors.ts#L66">errors.ts:66</a></li></ul></aside></section>
68
68
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="keys" class="tsd-anchor"></a>
69
69
  <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>
70
70
  <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><aside class="tsd-sources">
71
71
  <ul>
72
- <li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/errors.ts#L62">errors.ts:62</a></li></ul></aside></section>
72
+ <li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/errors.ts#L67">errors.ts:67</a></li></ul></aside></section>
73
73
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="lock_name" class="tsd-anchor"></a>
74
74
  <h3 class="tsd-anchor-link"><span>lock_<wbr/>name</span><a href="#lock_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>
75
75
  <div class="tsd-signature">lock_<wbr/>name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
@@ -77,15 +77,15 @@
77
77
  </div><aside class="tsd-sources">
78
78
  <p>Inherited from <a href="BetterLockError.html">BetterLockError</a>.<a href="BetterLockError.html#lock_name">lock_name</a></p>
79
79
  <ul>
80
- <li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/errors.ts#L9">errors.ts:9</a></li></ul></aside></section>
80
+ <li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/errors.ts#L9">errors.ts:9</a></li></ul></aside></section>
81
81
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="name" class="tsd-anchor"></a>
82
82
  <h3 class="tsd-anchor-link"><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>
83
- <div class="tsd-signature">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;BetterLockError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockInternalError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockInvalidArgumentError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockWaitTimeoutError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockExecutionTimeoutError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockQueueOverflowError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockJobAbortedError&quot;</span></div>
83
+ <div class="tsd-signature">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;isAcquisitionFailureError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockInternalError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockInvalidArgumentError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockWaitTimeoutError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockExecutionTimeoutError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockQueueOverflowError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;BetterLockJobAbortedError&quot;</span></div>
84
84
  <div class="tsd-comment tsd-typography"><p>Error name, maps to error&#39;s class name. Eg. BetterLockError.</p>
85
85
  </div><aside class="tsd-sources">
86
86
  <p>Inherited from <a href="BetterLockError.html">BetterLockError</a>.<a href="BetterLockError.html#name">name</a></p>
87
87
  <ul>
88
- <li>Defined in <a href="https://github.com/panta82/better-lock/blob/336aa4f/src/errors.ts#L14">errors.ts:14</a></li></ul></aside></section></section></div>
88
+ <li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/errors.ts#L14">errors.ts:14</a></li></ul></aside></section></section></div>
89
89
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
90
90
  <div class="tsd-navigation settings">
91
91
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/docs/classes/_internal_.BetterLock.html CHANGED
@@ -39,6 +39,7 @@
39
39
  <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>
40
40
  <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>
41
41
  <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>
42
+ <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>
42
43
  <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>
43
44
  </div></section></div></details></section></section>
44
45
  <section class="tsd-panel-group tsd-member-group">
@@ -65,7 +66,7 @@
65
66
  <div class="tsd-comment tsd-typography"><p>Default options to be used when creating BetterLock instances.</p>
66
67
  </div><aside class="tsd-sources">
67
68
  <ul>
68
- <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>
69
+ <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>
69
70
  <section class="tsd-panel-group tsd-member-group">
70
71
  <h2>Methods</h2>
71
72
  <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>
116
117
  <h4 class="tsd-type-parameters-title">Type Parameters</h4>
117
118
  <ul class="tsd-type-parameters">
118
119
  <li>
119
- <h4>TResult</h4></li></ul></div>
120
+ <h4>TResult<span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">unknown</span></h4></li></ul></div>
120
121
  <div class="tsd-parameters">
121
122
  <h4 class="tsd-parameters-title">Parameters</h4>
122
123
  <ul class="tsd-parameter-list">
@@ -141,7 +142,7 @@ once promise resolves or rejects.</p>
141
142
  <h4 class="tsd-type-parameters-title">Type Parameters</h4>
142
143
  <ul class="tsd-type-parameters">
143
144
  <li>
144
- <h4>TResult</h4></li></ul></div>
145
+ <h4>TResult<span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">unknown</span></h4></li></ul></div>
145
146
  <div class="tsd-parameters">
146
147
  <h4 class="tsd-parameters-title">Parameters</h4>
147
148
  <ul class="tsd-parameter-list">
@@ -166,7 +167,7 @@ once promise resolves or rejects.</p>
166
167
  <h4 class="tsd-type-parameters-title">Type Parameters</h4>
167
168
  <ul class="tsd-type-parameters">
168
169
  <li>
169
- <h4>TResult</h4></li></ul></div>
170
+ <h4>TResult<span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">unknown</span></h4></li></ul></div>
170
171
  <div class="tsd-parameters">
171
172
  <h4 class="tsd-parameters-title">Parameters</h4>
172
173
  <ul class="tsd-parameter-list">
@@ -195,7 +196,7 @@ once promise resolves or rejects.</p>
195
196
  <h4 class="tsd-type-parameters-title">Type Parameters</h4>
196
197
  <ul class="tsd-type-parameters">
197
198
  <li>
198
- <h4>TResult</h4></li></ul></div>
199
+ <h4>TResult<span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">unknown</span></h4></li></ul></div>
199
200
  <div class="tsd-parameters">
200
201
  <h4 class="tsd-parameters-title">Parameters</h4>
201
202
  <ul class="tsd-parameter-list">
@@ -224,7 +225,7 @@ once promise resolves or rejects.</p>
224
225
  <h4 class="tsd-type-parameters-title">Type Parameters</h4>
225
226
  <ul class="tsd-type-parameters">
226
227
  <li>
227
- <h4>TResult</h4></li></ul></div>
228
+ <h4>TResult<span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">unknown</span></h4></li></ul></div>
228
229
  <div class="tsd-parameters">
229
230
  <h4 class="tsd-parameters-title">Parameters</h4>
230
231
  <ul class="tsd-parameter-list">
@@ -253,7 +254,7 @@ once promise resolves or rejects.</p>
253
254
  <h4 class="tsd-type-parameters-title">Type Parameters</h4>
254
255
  <ul class="tsd-type-parameters">
255
256
  <li>
256
- <h4>TResult</h4></li></ul></div>
257
+ <h4>TResult<span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">unknown</span></h4></li></ul></div>
257
258
  <div class="tsd-parameters">
258
259
  <h4 class="tsd-parameters-title">Parameters</h4>
259
260
  <ul class="tsd-parameter-list">
@@ -274,6 +275,186 @@ once promise resolves or rejects.</p>
274
275
  <div class="tsd-comment tsd-typography"><p>Options to be applied on this job only</p>
275
276
  </div></li></ul></div>
276
277
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section>
278
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="acquireOr" class="tsd-anchor"></a>
279
+ <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>
280
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
281
+ <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>
282
+ <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>
283
+ <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>
284
+ <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>
285
+ <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>
286
+ <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>
287
+ <ul class="tsd-descriptions">
288
+ <li class="tsd-description">
289
+ <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
290
+ an error, the lock will resolve/callback with the provided failureResult value (for example, a <code>null</code>).</p>
291
+ </div>
292
+ <div class="tsd-type-parameters">
293
+ <h4 class="tsd-type-parameters-title">Type Parameters</h4>
294
+ <ul class="tsd-type-parameters">
295
+ <li>
296
+ <h4>TResult<span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">unknown</span></h4></li></ul></div>
297
+ <div class="tsd-parameters">
298
+ <h4 class="tsd-parameters-title">Parameters</h4>
299
+ <ul class="tsd-parameter-list">
300
+ <li>
301
+ <h5>failureResult: <span class="tsd-signature-type" data-tsd-kind="Type parameter">TResult</span></h5>
302
+ <div class="tsd-comment tsd-typography"><p>The value to return if the executor never get called. This happens instead of rejecting.</p>
303
+ </div></li>
304
+ <li>
305
+ <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>
306
+ <div class="tsd-comment tsd-typography"><p>Function that will run inside the lock. Required.</p>
307
+ </div></li>
308
+ <li>
309
+ <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>
310
+ <div class="tsd-comment tsd-typography"><p>Options to be applied on this job only</p>
311
+ </div></li></ul></div>
312
+ <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>
313
+ <li class="tsd-description">
314
+ <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
315
+ an error, the lock will resolve/callback with the provided failureResult value (for example, a <code>null</code>).</p>
316
+ </div>
317
+ <div class="tsd-type-parameters">
318
+ <h4 class="tsd-type-parameters-title">Type Parameters</h4>
319
+ <ul class="tsd-type-parameters">
320
+ <li>
321
+ <h4>TResult<span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">unknown</span></h4></li></ul></div>
322
+ <div class="tsd-parameters">
323
+ <h4 class="tsd-parameters-title">Parameters</h4>
324
+ <ul class="tsd-parameter-list">
325
+ <li>
326
+ <h5>failureResult: <span class="tsd-signature-type" data-tsd-kind="Type parameter">TResult</span></h5>
327
+ <div class="tsd-comment tsd-typography"><p>The value to return if the executor never get called. This happens instead of rejecting.</p>
328
+ </div></li>
329
+ <li>
330
+ <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>
331
+ <div class="tsd-comment tsd-typography"><p>Function that will run inside the lock. Required.</p>
332
+ </div></li>
333
+ <li>
334
+ <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>
335
+ <div class="tsd-comment tsd-typography"><p>Options to be applied on this job only</p>
336
+ </div></li></ul></div>
337
+ <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>
338
+ <li class="tsd-description">
339
+ <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
340
+ an error, the lock will resolve/callback with the provided failureResult value (for example, a <code>null</code>).</p>
341
+ </div>
342
+ <div class="tsd-type-parameters">
343
+ <h4 class="tsd-type-parameters-title">Type Parameters</h4>
344
+ <ul class="tsd-type-parameters">
345
+ <li>
346
+ <h4>TResult<span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">unknown</span></h4></li></ul></div>
347
+ <div class="tsd-parameters">
348
+ <h4 class="tsd-parameters-title">Parameters</h4>
349
+ <ul class="tsd-parameter-list">
350
+ <li>
351
+ <h5>failureResult: <span class="tsd-signature-type" data-tsd-kind="Type parameter">TResult</span></h5>
352
+ <div class="tsd-comment tsd-typography"><p>The value to return if the executor never get called. This happens instead of rejecting.</p>
353
+ </div></li>
354
+ <li>
355
+ <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>
356
+ <div class="tsd-comment tsd-typography"><p>Function that will run inside the lock. Required.</p>
357
+ </div></li>
358
+ <li>
359
+ <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>
360
+ <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>
361
+ </div></li>
362
+ <li>
363
+ <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>
364
+ <div class="tsd-comment tsd-typography"><p>Options to be applied on this job only</p>
365
+ </div></li></ul></div>
366
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li>
367
+ <li class="tsd-description">
368
+ <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
369
+ an error, the lock will resolve/callback with the provided failureResult value (for example, a <code>null</code>).</p>
370
+ </div>
371
+ <div class="tsd-type-parameters">
372
+ <h4 class="tsd-type-parameters-title">Type Parameters</h4>
373
+ <ul class="tsd-type-parameters">
374
+ <li>
375
+ <h4>TResult<span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">unknown</span></h4></li></ul></div>
376
+ <div class="tsd-parameters">
377
+ <h4 class="tsd-parameters-title">Parameters</h4>
378
+ <ul class="tsd-parameter-list">
379
+ <li>
380
+ <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>
381
+ <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>
382
+ </div></li>
383
+ <li>
384
+ <h5>failureResult: <span class="tsd-signature-type" data-tsd-kind="Type parameter">TResult</span></h5>
385
+ <div class="tsd-comment tsd-typography"><p>The value to return if the executor never get called. This happens instead of rejecting.</p>
386
+ </div></li>
387
+ <li>
388
+ <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>
389
+ <div class="tsd-comment tsd-typography"><p>Function that will run inside the lock. Required.</p>
390
+ </div></li>
391
+ <li>
392
+ <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>
393
+ <div class="tsd-comment tsd-typography"><p>Options to be applied on this job only</p>
394
+ </div></li></ul></div>
395
+ <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>
396
+ <li class="tsd-description">
397
+ <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
398
+ an error, the lock will resolve/callback with the provided failureResult value (for example, a <code>null</code>).</p>
399
+ </div>
400
+ <div class="tsd-type-parameters">
401
+ <h4 class="tsd-type-parameters-title">Type Parameters</h4>
402
+ <ul class="tsd-type-parameters">
403
+ <li>
404
+ <h4>TResult<span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">unknown</span></h4></li></ul></div>
405
+ <div class="tsd-parameters">
406
+ <h4 class="tsd-parameters-title">Parameters</h4>
407
+ <ul class="tsd-parameter-list">
408
+ <li>
409
+ <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>
410
+ <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>
411
+ </div></li>
412
+ <li>
413
+ <h5>failureResult: <span class="tsd-signature-type" data-tsd-kind="Type parameter">TResult</span></h5>
414
+ <div class="tsd-comment tsd-typography"><p>The value to return if the executor never get called. This happens instead of rejecting.</p>
415
+ </div></li>
416
+ <li>
417
+ <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>
418
+ <div class="tsd-comment tsd-typography"><p>Function that will run inside the lock. Required.</p>
419
+ </div></li>
420
+ <li>
421
+ <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>
422
+ <div class="tsd-comment tsd-typography"><p>Options to be applied on this job only</p>
423
+ </div></li></ul></div>
424
+ <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>
425
+ <li class="tsd-description">
426
+ <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
427
+ an error, the lock will resolve/callback with the provided failureResult value (for example, a <code>null</code>).</p>
428
+ </div>
429
+ <div class="tsd-type-parameters">
430
+ <h4 class="tsd-type-parameters-title">Type Parameters</h4>
431
+ <ul class="tsd-type-parameters">
432
+ <li>
433
+ <h4>TResult<span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">unknown</span></h4></li></ul></div>
434
+ <div class="tsd-parameters">
435
+ <h4 class="tsd-parameters-title">Parameters</h4>
436
+ <ul class="tsd-parameter-list">
437
+ <li>
438
+ <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>
439
+ <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>
440
+ </div></li>
441
+ <li>
442
+ <h5>failureResult: <span class="tsd-signature-type" data-tsd-kind="Type parameter">TResult</span></h5>
443
+ <div class="tsd-comment tsd-typography"><p>The value to return if the executor never get called. This happens instead of rejecting.</p>
444
+ </div></li>
445
+ <li>
446
+ <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>
447
+ <div class="tsd-comment tsd-typography"><p>Function that will run inside the lock. Required.</p>
448
+ </div></li>
449
+ <li>
450
+ <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>
451
+ <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>
452
+ </div></li>
453
+ <li>
454
+ <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>
455
+ <div class="tsd-comment tsd-typography"><p>Options to be applied on this job only</p>
456
+ </div></li></ul></div>
457
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section>
277
458
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="canAcquire" class="tsd-anchor"></a>
278
459
  <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>
279
460
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -318,6 +499,7 @@ once promise resolves or rejects.</p>
318
499
  <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>
319
500
  <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>
320
501
  <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>
502
+ <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>
321
503
  <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>
322
504
  <div class="container tsd-generator">
323
505
  <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>