better-lock 3.1.0 → 3.3.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 (40) hide show
  1. package/README.md +35 -1
  2. package/dist/better_lock.d.ts +13 -7
  3. package/dist/better_lock.js +60 -5
  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 +3 -4
  35. package/spec/better_lock.spec.ts +112 -0
  36. package/src/better_lock.ts +97 -13
  37. package/src/errors.ts +14 -1
  38. package/src/types.ts +5 -0
  39. package/tsconfig.build.json +6 -0
  40. package/tsconfig.json +1 -0
package/docs/classes/BetterLockExecutionTimeoutError.html CHANGED
@@ -59,17 +59,17 @@
59
59
  <h3 class="tsd-anchor-link"><span>executed_<wbr/>at</span><a href="#executed_at" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
60
60
  <div class="tsd-signature">executed_<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#L81">errors.ts:81</a></li></ul></aside></section>
62
+ <li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/errors.ts#L86">errors.ts:86</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#L79">errors.ts:79</a></li></ul></aside></section>
67
+ <li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/errors.ts#L84">errors.ts:84</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#L80">errors.ts:80</a></li></ul></aside></section>
72
+ <li>Defined in <a href="https://github.com/panta82/better-lock/blob/91aeb2b/src/errors.ts#L85">errors.ts:85</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/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">