@ferricstore/ferricstore 0.13.0 → 0.13.2

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 (74) hide show
  1. package/README.md +53 -1
  2. package/dist/index.cjs +230 -82
  3. package/dist/index.cjs.map +1 -1
  4. package/dist/index.d.cts +30 -6
  5. package/dist/index.d.ts +30 -6
  6. package/dist/index.js +229 -82
  7. package/dist/index.js.map +1 -1
  8. package/dist/langgraph.cjs.map +1 -1
  9. package/dist/langgraph.js.map +1 -1
  10. package/dist/openai-agents.cjs.map +1 -1
  11. package/dist/openai-agents.js.map +1 -1
  12. package/docs/api/assets/hierarchy.js +1 -1
  13. package/docs/api/assets/highlight.css +9 -2
  14. package/docs/api/assets/navigation.js +1 -1
  15. package/docs/api/assets/search.js +1 -1
  16. package/docs/api/classes/ConnectionClosedError.html +4 -4
  17. package/docs/api/classes/FerricStoreClient.html +13 -13
  18. package/docs/api/classes/FerricStoreError.html +1 -0
  19. package/docs/api/classes/FlowAlreadyExistsError.html +3 -3
  20. package/docs/api/classes/FlowNotFoundError.html +3 -3
  21. package/docs/api/classes/FlowWrongStateError.html +3 -3
  22. package/docs/api/classes/HTTPTransportError.html +13 -7
  23. package/docs/api/classes/InvalidCommandError.html +3 -3
  24. package/docs/api/classes/LeaseRenewalError.html +1 -1
  25. package/docs/api/classes/LockHeldError.html +3 -3
  26. package/docs/api/classes/LockNotOwnedError.html +3 -3
  27. package/docs/api/classes/NativeAdapter.html +3 -3
  28. package/docs/api/classes/OverloadedError.html +5 -5
  29. package/docs/api/classes/QueueCompletionError.html +1 -1
  30. package/docs/api/classes/RequestNotSentError.html +225 -0
  31. package/docs/api/classes/RequestTimeoutError.html +6 -6
  32. package/docs/api/classes/RerouteError.html +3 -3
  33. package/docs/api/classes/StaleLeaseError.html +3 -3
  34. package/docs/api/classes/StalePolicyGenerationError.html +3 -3
  35. package/docs/api/classes/WorkflowContext.html +7 -9
  36. package/docs/api/functions/classifyServerError.html +1 -1
  37. package/docs/api/functions/mapException.html +1 -1
  38. package/docs/api/hierarchy.html +21 -20
  39. package/docs/api/index.html +38 -2
  40. package/docs/api/interfaces/AdvanceOptions.html +9 -5
  41. package/docs/api/interfaces/AlreadyAppliedOutcome.html +1 -1
  42. package/docs/api/interfaces/AppliedStepOutcome.html +1 -1
  43. package/docs/api/interfaces/CancelOptions.html +12 -8
  44. package/docs/api/interfaces/CompleteOptions.html +12 -8
  45. package/docs/api/interfaces/CompleteOutcome.html +1 -1
  46. package/docs/api/interfaces/ExtendLeaseOptions.html +10 -8
  47. package/docs/api/interfaces/FailOptions.html +12 -8
  48. package/docs/api/interfaces/FailOutcome.html +1 -1
  49. package/docs/api/interfaces/HistoryOptions.html +16 -16
  50. package/docs/api/interfaces/LeaseMutationOptions.html +10 -6
  51. package/docs/api/interfaces/MutateOptions.html +7 -3
  52. package/docs/api/interfaces/NamedValueMutation.html +1 -1
  53. package/docs/api/interfaces/ReadOptions.html +11 -11
  54. package/docs/api/interfaces/RetryOptions.html +12 -8
  55. package/docs/api/interfaces/RetryOutcome.html +1 -1
  56. package/docs/api/interfaces/RunStepsItem.html +3 -3
  57. package/docs/api/interfaces/RunStepsManyOptions.html +11 -11
  58. package/docs/api/interfaces/SearchOptions.html +12 -12
  59. package/docs/api/interfaces/StepContinueOptions.html +15 -11
  60. package/docs/api/interfaces/StepOptions.html +15 -8
  61. package/docs/api/interfaces/StepResult.html +3 -3
  62. package/docs/api/interfaces/TDigestCreateOptions.html +1 -1
  63. package/docs/api/interfaces/TDigestMergeOptions.html +1 -1
  64. package/docs/api/interfaces/TransitionOptions.html +14 -10
  65. package/docs/api/interfaces/TransitionOutcome.html +1 -1
  66. package/docs/api/media/design.md +22 -1
  67. package/docs/api/modules.html +2 -2
  68. package/docs/api/types/ConnectionRequestDisposition.html +1 -1
  69. package/docs/api/types/ManagementPairs.html +1 -1
  70. package/docs/api/types/RequestDisposition.html +1 -1
  71. package/docs/api/types/SearchStateMeta.html +1 -1
  72. package/docs/api/variables/FERRICSTORE_SDK_VERSION.html +1 -1
  73. package/docs/design.md +22 -1
  74. package/package.json +1 -1
@@ -10,14 +10,14 @@
10
10
  <ul class="tsd-breadcrumb" aria-label="Breadcrumb">
11
11
  <li><a href="" aria-current="page">OverloadedError</a></li></ul>
12
12
  <h1>Class OverloadedError</h1></div>
13
- <section class="tsd-panel tsd-hierarchy" data-refl="2606">
13
+ <section class="tsd-panel tsd-hierarchy" data-refl="2608">
14
14
  <h4>Hierarchy (<a href="../hierarchy.html#OverloadedError">View Summary</a>)</h4>
15
15
  <ul class="tsd-hierarchy">
16
16
  <li class="tsd-hierarchy-item"><a href="FerricStoreError.html" class="tsd-signature-type tsd-kind-class">FerricStoreError</a>
17
17
  <ul class="tsd-hierarchy">
18
18
  <li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">OverloadedError</span></li></ul></li></ul></section><aside class="tsd-sources">
19
19
  <ul>
20
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L109">src/errors.ts:109</a></li></ul></aside>
20
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L138">src/errors.ts:138</a></li></ul></aside>
21
21
  <section class="tsd-panel-group tsd-index-group">
22
22
  <section class="tsd-panel tsd-index-panel">
23
23
  <details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
@@ -63,7 +63,7 @@
63
63
  <h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">OverloadedError</a></h4><aside class="tsd-sources">
64
64
  <p>Overrides <a href="FerricStoreError.html">FerricStoreError</a>.<a href="FerricStoreError.html#constructor">constructor</a></p>
65
65
  <ul>
66
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L113">src/errors.ts:113</a></li></ul></aside></div></li></ul></section></section></details>
66
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L142">src/errors.ts:142</a></li></ul></aside></div></li></ul></section></section></details>
67
67
  <details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
68
68
  <h2 class="tsd-anchor-link" id="properties-1">Properties<a href="#properties-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
69
69
  <section>
@@ -78,7 +78,7 @@
78
78
  <div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;overloaded&quot;</span></div><aside class="tsd-sources">
79
79
  <p>Overrides <a href="FerricStoreError.html">FerricStoreError</a>.<a href="FerricStoreError.html#code">code</a></p>
80
80
  <ul>
81
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L110">src/errors.ts:110</a></li></ul></aside></section>
81
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L139">src/errors.ts:139</a></li></ul></aside></section>
82
82
  <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
83
83
  <h3 class="tsd-anchor-link" id="message"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
84
84
  <div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
@@ -101,7 +101,7 @@
101
101
  <h3 class="tsd-anchor-link" id="reason"><code class="tsd-tag">Readonly</code><span>reason</span><a href="#reason" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
102
102
  <div class="tsd-signature"><span class="tsd-kind-property">reason</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></div><aside class="tsd-sources">
103
103
  <ul>
104
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L111">src/errors.ts:111</a></li></ul></aside></section>
104
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L140">src/errors.ts:140</a></li></ul></aside></section>
105
105
  <section class="tsd-panel tsd-member tsd-is-inherited">
106
106
  <h3 class="tsd-anchor-link" id="retryable"><code class="tsd-tag">Readonly</code><span>retryable</span><a href="#retryable" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
107
107
  <div class="tsd-signature"><span class="tsd-kind-property">retryable</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></div><aside class="tsd-sources">
@@ -13,7 +13,7 @@
13
13
  <section class="tsd-panel tsd-comment">
14
14
  <div class="tsd-comment tsd-typography"><p>Async terminal-write failure with the number of durable successes drained first.</p>
15
15
  </div></section>
16
- <section class="tsd-panel tsd-hierarchy" data-refl="3349">
16
+ <section class="tsd-panel tsd-hierarchy" data-refl="3378">
17
17
  <h4>Hierarchy</h4>
18
18
  <ul class="tsd-hierarchy">
19
19
  <li class="tsd-hierarchy-item"><span class="tsd-signature-type">Error</span>
@@ -0,0 +1,225 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>RequestNotSentError | @ferricstore/ferricstore</title><meta name="description" content="Documentation for @ferricstore/ferricstore"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar">
2
+ <div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@ferricstore/ferricstore</a>
3
+ <div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/>
4
+ <ul role="listbox" id="tsd-search-results"></ul>
5
+ <div id="tsd-search-status" aria-live="polite" aria-atomic="true">
6
+ <div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header>
7
+ <div class="container container-main">
8
+ <div class="col-content">
9
+ <div class="tsd-page-title">
10
+ <ul class="tsd-breadcrumb" aria-label="Breadcrumb">
11
+ <li><a href="" aria-current="page">RequestNotSentError</a></li></ul>
12
+ <h1>Class RequestNotSentError</h1></div>
13
+ <section class="tsd-panel tsd-comment">
14
+ <div class="tsd-comment tsd-typography"><p>A local validation, encoding, sizing, or lifecycle failure before submission.</p>
15
+ </div></section>
16
+ <section class="tsd-panel tsd-hierarchy" data-refl="2639">
17
+ <h4>Hierarchy (<a href="../hierarchy.html#RequestNotSentError">View Summary</a>)</h4>
18
+ <ul class="tsd-hierarchy">
19
+ <li class="tsd-hierarchy-item"><a href="FerricStoreError.html" class="tsd-signature-type tsd-kind-class">FerricStoreError</a>
20
+ <ul class="tsd-hierarchy">
21
+ <li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">RequestNotSentError</span></li></ul></li></ul></section><aside class="tsd-sources">
22
+ <ul>
23
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L87">src/errors.ts:87</a></li></ul></aside>
24
+ <section class="tsd-panel-group tsd-index-group">
25
+ <section class="tsd-panel tsd-index-panel">
26
+ <details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
27
+ <h5 class="tsd-index-heading uppercase">Index</h5></summary>
28
+ <div class="tsd-accordion-details">
29
+ <section class="tsd-index-section">
30
+ <h3 class="tsd-index-heading tsd-anchor-link" id="constructors">Constructors<a href="#constructors" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
31
+ <div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
32
+ </div></section>
33
+ <section class="tsd-index-section">
34
+ <h3 class="tsd-index-heading tsd-anchor-link" id="properties">Properties<a href="#properties" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
35
+ <div class="tsd-index-list"><a href="#cause" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause?</span></a>
36
+ <a href="#code" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a>
37
+ <a href="#message" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a>
38
+ <a href="#name" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a>
39
+ <a href="#raw" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>raw</span></a>
40
+ <a href="#requestdisposition" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request<wbr/>Disposition</span></a>
41
+ <a href="#retryable" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>retryable</span></a>
42
+ <a href="#retryafterms" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>retry<wbr/>After<wbr/>Ms</span></a>
43
+ <a href="#safetoretry" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>safe<wbr/>To<wbr/>Retry</span></a>
44
+ <a href="#stack" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack?</span></a>
45
+ <a href="#stacktracelimit" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a>
46
+ </div></section>
47
+ <section class="tsd-index-section">
48
+ <h3 class="tsd-index-heading tsd-anchor-link" id="methods">Methods<a href="#methods" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
49
+ <div class="tsd-index-list"><a href="#capturestacktrace" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a>
50
+ <a href="#preparestacktrace" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a>
51
+ </div></section></div></details></section></section>
52
+ <details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
53
+ <h2 class="tsd-anchor-link" id="constructors-1">Constructors<a href="#constructors-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
54
+ <section>
55
+ <section class="tsd-panel tsd-member">
56
+ <h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
57
+ <ul class="tsd-signatures">
58
+ <li class="">
59
+ <div class="tsd-signature tsd-anchor-link" id="constructorrequestnotsenterror"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">RequestNotSentError</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">raw</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">RequestNotSentError</a><a href="#constructorrequestnotsenterror" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
60
+ <div class="tsd-description">
61
+ <div class="tsd-parameters">
62
+ <h4 class="tsd-parameters-title">Parameters</h4>
63
+ <ul class="tsd-parameter-list">
64
+ <li><span><span class="tsd-kind-parameter">message</span>: <span class="tsd-signature-type">string</span></span></li>
65
+ <li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">raw</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></span></li></ul></div>
66
+ <h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">RequestNotSentError</a></h4><aside class="tsd-sources">
67
+ <p>Overrides <a href="FerricStoreError.html">FerricStoreError</a>.<a href="FerricStoreError.html#constructor">constructor</a></p>
68
+ <ul>
69
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L91">src/errors.ts:91</a></li></ul></aside></div></li></ul></section></section></details>
70
+ <details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
71
+ <h2 class="tsd-anchor-link" id="properties-1">Properties<a href="#properties-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
72
+ <section>
73
+ <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
74
+ <h3 class="tsd-anchor-link" id="cause"><code class="tsd-tag">Optional</code><span>cause</span><a href="#cause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
75
+ <div class="tsd-signature"><span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span></div><aside class="tsd-sources">
76
+ <p>Inherited from <a href="FerricStoreError.html">FerricStoreError</a>.<a href="FerricStoreError.html#cause">cause</a></p>
77
+ <ul>
78
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/../node_modules/typescript/lib/lib.es2022.error.d.ts#L24">node_modules/typescript/lib/lib.es2022.error.d.ts:24</a></li></ul></aside></section>
79
+ <section class="tsd-panel tsd-member">
80
+ <h3 class="tsd-anchor-link" id="code"><code class="tsd-tag">Readonly</code><span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
81
+ <div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;request_not_sent&quot;</span></div><aside class="tsd-sources">
82
+ <p>Overrides <a href="FerricStoreError.html">FerricStoreError</a>.<a href="FerricStoreError.html#code">code</a></p>
83
+ <ul>
84
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L88">src/errors.ts:88</a></li></ul></aside></section>
85
+ <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
86
+ <h3 class="tsd-anchor-link" id="message"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
87
+ <div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
88
+ <p>Inherited from <a href="FerricStoreError.html">FerricStoreError</a>.<a href="FerricStoreError.html#message">message</a></p>
89
+ <ul>
90
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/../node_modules/typescript/lib/lib.es5.d.ts#L1075">node_modules/typescript/lib/lib.es5.d.ts:1075</a></li></ul></aside></section>
91
+ <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
92
+ <h3 class="tsd-anchor-link" id="name"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
93
+ <div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
94
+ <p>Inherited from <a href="FerricStoreError.html">FerricStoreError</a>.<a href="FerricStoreError.html#name">name</a></p>
95
+ <ul>
96
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/../node_modules/typescript/lib/lib.es5.d.ts#L1074">node_modules/typescript/lib/lib.es5.d.ts:1074</a></li></ul></aside></section>
97
+ <section class="tsd-panel tsd-member tsd-is-inherited">
98
+ <h3 class="tsd-anchor-link" id="raw"><code class="tsd-tag">Readonly</code><span>raw</span><a href="#raw" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
99
+ <div class="tsd-signature"><span class="tsd-kind-property">raw</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div><aside class="tsd-sources">
100
+ <p>Inherited from <a href="FerricStoreError.html">FerricStoreError</a>.<a href="FerricStoreError.html#raw">raw</a></p>
101
+ <ul>
102
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L3">src/errors.ts:3</a></li></ul></aside></section>
103
+ <section class="tsd-panel tsd-member">
104
+ <h3 class="tsd-anchor-link" id="requestdisposition"><code class="tsd-tag">Readonly</code><span>request<wbr/>Disposition</span><a href="#requestdisposition" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
105
+ <div class="tsd-signature"><span class="tsd-kind-property">requestDisposition</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;unsent&quot;</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources">
106
+ <ul>
107
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L89">src/errors.ts:89</a></li></ul></aside></section>
108
+ <section class="tsd-panel tsd-member tsd-is-inherited">
109
+ <h3 class="tsd-anchor-link" id="retryable"><code class="tsd-tag">Readonly</code><span>retryable</span><a href="#retryable" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
110
+ <div class="tsd-signature"><span class="tsd-kind-property">retryable</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></div><aside class="tsd-sources">
111
+ <p>Inherited from <a href="FerricStoreError.html">FerricStoreError</a>.<a href="FerricStoreError.html#retryable">retryable</a></p>
112
+ <ul>
113
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L4">src/errors.ts:4</a></li></ul></aside></section>
114
+ <section class="tsd-panel tsd-member tsd-is-inherited">
115
+ <h3 class="tsd-anchor-link" id="retryafterms"><code class="tsd-tag">Readonly</code><span>retry<wbr/>After<wbr/>Ms</span><a href="#retryafterms" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
116
+ <div class="tsd-signature"><span class="tsd-kind-property">retryAfterMs</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></div><aside class="tsd-sources">
117
+ <p>Inherited from <a href="FerricStoreError.html">FerricStoreError</a>.<a href="FerricStoreError.html#retryafterms">retryAfterMs</a></p>
118
+ <ul>
119
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L6">src/errors.ts:6</a></li></ul></aside></section>
120
+ <section class="tsd-panel tsd-member tsd-is-inherited">
121
+ <h3 class="tsd-anchor-link" id="safetoretry"><code class="tsd-tag">Readonly</code><span>safe<wbr/>To<wbr/>Retry</span><a href="#safetoretry" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
122
+ <div class="tsd-signature"><span class="tsd-kind-property">safeToRetry</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></div><aside class="tsd-sources">
123
+ <p>Inherited from <a href="FerricStoreError.html">FerricStoreError</a>.<a href="FerricStoreError.html#safetoretry">safeToRetry</a></p>
124
+ <ul>
125
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L5">src/errors.ts:5</a></li></ul></aside></section>
126
+ <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
127
+ <h3 class="tsd-anchor-link" id="stack"><code class="tsd-tag">Optional</code><span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
128
+ <div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
129
+ <p>Inherited from <a href="FerricStoreError.html">FerricStoreError</a>.<a href="FerricStoreError.html#stack">stack</a></p>
130
+ <ul>
131
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/../node_modules/typescript/lib/lib.es5.d.ts#L1076">node_modules/typescript/lib/lib.es5.d.ts:1076</a></li></ul></aside></section>
132
+ <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
133
+ <h3 class="tsd-anchor-link" id="stacktracelimit"><code class="tsd-tag">Static</code><span>stack<wbr/>Trace<wbr/>Limit</span><a href="#stacktracelimit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
134
+ <div class="tsd-signature"><span class="tsd-kind-property">stackTraceLimit</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
135
+ <div class="tsd-comment tsd-typography"><p>The <code>Error.stackTraceLimit</code> property specifies the number of stack frames
136
+ collected by a stack trace (whether generated by <code>new Error().stack</code> or
137
+ <code>Error.captureStackTrace(obj)</code>).</p>
138
+ <p>The default value is <code>10</code> but may be set to any valid JavaScript number. Changes
139
+ will affect any stack trace captured <em>after</em> the value has been changed.</p>
140
+ <p>If set to a non-number value, or set to a negative number, stack traces will
141
+ not capture any frames.</p>
142
+ </div><aside class="tsd-sources">
143
+ <p>Inherited from <a href="FerricStoreError.html">FerricStoreError</a>.<a href="FerricStoreError.html#stacktracelimit">stackTraceLimit</a></p>
144
+ <ul>
145
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/../node_modules/@types/node/globals.d.ts#L68">node_modules/@types/node/globals.d.ts:68</a></li></ul></aside></section></section></details>
146
+ <details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
147
+ <h2 class="tsd-anchor-link" id="methods-1">Methods<a href="#methods-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
148
+ <section>
149
+ <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
150
+ <h3 class="tsd-anchor-link" id="capturestacktrace"><code class="tsd-tag">Static</code><span>capture<wbr/>Stack<wbr/>Trace</span><a href="#capturestacktrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
151
+ <ul class="tsd-signatures tsd-is-inherited tsd-is-external">
152
+ <li class="tsd-is-inherited tsd-is-external">
153
+ <div class="tsd-signature tsd-anchor-link" id="capturestacktrace-1"><span class="tsd-kind-call-signature">captureStackTrace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#capturestacktrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
154
+ <div class="tsd-description">
155
+ <div class="tsd-comment tsd-typography"><p>Creates a <code>.stack</code> property on <code>targetObject</code>, which when accessed returns
156
+ a string representing the location in the code at which
157
+ <code>Error.captureStackTrace()</code> was called.</p>
158
+ <pre><code class="js"><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">myObject</span><span class="hl-1"> = {};</span><br/><span class="hl-5">Error</span><span class="hl-1">.</span><span class="hl-0">captureStackTrace</span><span class="hl-1">(</span><span class="hl-5">myObject</span><span class="hl-1">);</span><br/><span class="hl-5">myObject</span><span class="hl-1">.</span><span class="hl-5">stack</span><span class="hl-1">; </span><span class="hl-3">// Similar to `new Error().stack`</span>
159
+ </code><button type="button">Copy</button></pre>
160
+
161
+ <p>The first line of the trace will be prefixed with
162
+ <code>${myObject.name}: ${myObject.message}</code>.</p>
163
+ <p>The optional <code>constructorOpt</code> argument accepts a function. If given, all frames
164
+ above <code>constructorOpt</code>, including <code>constructorOpt</code>, will be omitted from the
165
+ generated stack trace.</p>
166
+ <p>The <code>constructorOpt</code> argument is useful for hiding implementation
167
+ details of error generation from the user. For instance:</p>
168
+ <pre><code class="js"><span class="hl-6">function</span><span class="hl-1"> </span><span class="hl-0">a</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-0">b</span><span class="hl-1">();</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-6">function</span><span class="hl-1"> </span><span class="hl-0">b</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-0">c</span><span class="hl-1">();</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-6">function</span><span class="hl-1"> </span><span class="hl-0">c</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-3">// Create an error without stack trace to avoid calculating the stack trace twice.</span><br/><span class="hl-1"> </span><span class="hl-6">const</span><span class="hl-1"> { </span><span class="hl-7">stackTraceLimit</span><span class="hl-1"> } = </span><span class="hl-5">Error</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-5">Error</span><span class="hl-1">.</span><span class="hl-5">stackTraceLimit</span><span class="hl-1"> = </span><span class="hl-9">0</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">error</span><span class="hl-1"> = </span><span class="hl-6">new</span><span class="hl-1"> </span><span class="hl-0">Error</span><span class="hl-1">();</span><br/><span class="hl-1"> </span><span class="hl-5">Error</span><span class="hl-1">.</span><span class="hl-5">stackTraceLimit</span><span class="hl-1"> = </span><span class="hl-5">stackTraceLimit</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-3">// Capture the stack trace above function b</span><br/><span class="hl-1"> </span><span class="hl-5">Error</span><span class="hl-1">.</span><span class="hl-0">captureStackTrace</span><span class="hl-1">(</span><span class="hl-5">error</span><span class="hl-1">, </span><span class="hl-5">b</span><span class="hl-1">); </span><span class="hl-3">// Neither function c, nor b is included in the stack trace</span><br/><span class="hl-1"> </span><span class="hl-4">throw</span><span class="hl-1"> </span><span class="hl-5">error</span><span class="hl-1">;</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-0">a</span><span class="hl-1">();</span>
169
+ </code><button type="button">Copy</button></pre>
170
+
171
+ </div>
172
+ <div class="tsd-parameters">
173
+ <h4 class="tsd-parameters-title">Parameters</h4>
174
+ <ul class="tsd-parameter-list">
175
+ <li><span><span class="tsd-kind-parameter">targetObject</span>: <span class="tsd-signature-type">object</span></span></li>
176
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">constructorOpt</span>: <span class="tsd-signature-type">Function</span></span></li></ul></div>
177
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
178
+ <p>Inherited from <a href="FerricStoreError.html">FerricStoreError</a>.<a href="FerricStoreError.html#capturestacktrace">captureStackTrace</a></p>
179
+ <ul>
180
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/../node_modules/@types/node/globals.d.ts#L52">node_modules/@types/node/globals.d.ts:52</a></li></ul></aside></div></li></ul></section>
181
+ <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
182
+ <h3 class="tsd-anchor-link" id="preparestacktrace"><code class="tsd-tag">Static</code><span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#preparestacktrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
183
+ <ul class="tsd-signatures tsd-is-inherited tsd-is-external">
184
+ <li class="tsd-is-inherited tsd-is-external">
185
+ <div class="tsd-signature tsd-anchor-link" id="preparestacktrace-1"><span class="tsd-kind-call-signature">prepareStackTrace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><a href="#preparestacktrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
186
+ <div class="tsd-description">
187
+ <div class="tsd-parameters">
188
+ <h4 class="tsd-parameters-title">Parameters</h4>
189
+ <ul class="tsd-parameter-list">
190
+ <li><span><span class="tsd-kind-parameter">err</span>: <span class="tsd-signature-type">Error</span></span></li>
191
+ <li><span><span class="tsd-kind-parameter">stackTraces</span>: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div>
192
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
193
+ <div class="tsd-comment tsd-typography">
194
+ <div class="tsd-tag-see">
195
+ <h4 class="tsd-anchor-link" id="see">See<a href="#see" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="https://v8.dev/docs/stack-trace-api#customizing-stack-traces">https://v8.dev/docs/stack-trace-api#customizing-stack-traces</a></p>
196
+ </div></div><aside class="tsd-sources">
197
+ <p>Inherited from <a href="FerricStoreError.html">FerricStoreError</a>.<a href="FerricStoreError.html#preparestacktrace">prepareStackTrace</a></p>
198
+ <ul>
199
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/../node_modules/@types/node/globals.d.ts#L56">node_modules/@types/node/globals.d.ts:56</a></li></ul></aside></div></li></ul></section></section></details></div>
200
+ <div class="col-sidebar">
201
+ <div class="page-menu">
202
+ <div class="tsd-navigation settings">
203
+ <details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
204
+ <h3>Settings</h3></summary>
205
+ <div class="tsd-accordion-details">
206
+ <div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
207
+ <ul id="tsd-filter-options">
208
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
209
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
210
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div>
211
+ <div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
212
+ <details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
213
+ <h3>On This Page</h3></summary>
214
+ <div class="tsd-accordion-details">
215
+ <details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary>
216
+ <div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details>
217
+ <details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary>
218
+ <div><a href="#cause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause</span></a><a href="#code"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#raw" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>raw</span></a><a href="#requestdisposition"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request<wbr/>Disposition</span></a><a href="#retryable" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>retryable</span></a><a href="#retryafterms" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>retry<wbr/>After<wbr/>Ms</span></a><a href="#safetoretry" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>safe<wbr/>To<wbr/>Retry</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#stacktracelimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a></div></details>
219
+ <details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary>
220
+ <div><a href="#capturestacktrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a><a href="#preparestacktrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a></div></details></div></details></div>
221
+ <div class="site-menu">
222
+ <nav class="tsd-navigation"><a href="../modules.html">@ferricstore/ferricstore</a>
223
+ <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
224
+ <li>Loading...</li></ul></nav></div></div></div><footer></footer>
225
+ <div class="overlay"></div></body></html>
@@ -13,14 +13,14 @@
13
13
  <section class="tsd-panel tsd-comment">
14
14
  <div class="tsd-comment tsd-typography"><p>Request timeout annotated with whether the request may have reached the server.</p>
15
15
  </div></section>
16
- <section class="tsd-panel tsd-hierarchy" data-refl="2637">
16
+ <section class="tsd-panel tsd-hierarchy" data-refl="2666">
17
17
  <h4>Hierarchy (<a href="../hierarchy.html#RequestTimeoutError">View Summary</a>)</h4>
18
18
  <ul class="tsd-hierarchy">
19
19
  <li class="tsd-hierarchy-item"><a href="FerricStoreError.html" class="tsd-signature-type tsd-kind-class">FerricStoreError</a>
20
20
  <ul class="tsd-hierarchy">
21
21
  <li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">RequestTimeoutError</span></li></ul></li></ul></section><aside class="tsd-sources">
22
22
  <ul>
23
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L60">src/errors.ts:60</a></li></ul></aside>
23
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L70">src/errors.ts:70</a></li></ul></aside>
24
24
  <section class="tsd-panel-group tsd-index-group">
25
25
  <section class="tsd-panel tsd-index-panel">
26
26
  <details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
@@ -68,7 +68,7 @@
68
68
  <h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">RequestTimeoutError</a></h4><aside class="tsd-sources">
69
69
  <p>Overrides <a href="FerricStoreError.html">FerricStoreError</a>.<a href="FerricStoreError.html#constructor">constructor</a></p>
70
70
  <ul>
71
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L65">src/errors.ts:65</a></li></ul></aside></div></li></ul></section></section></details>
71
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L75">src/errors.ts:75</a></li></ul></aside></div></li></ul></section></section></details>
72
72
  <details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
73
73
  <h2 class="tsd-anchor-link" id="properties-1">Properties<a href="#properties-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
74
74
  <section>
@@ -83,7 +83,7 @@
83
83
  <div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;request_timeout&quot;</span></div><aside class="tsd-sources">
84
84
  <p>Overrides <a href="FerricStoreError.html">FerricStoreError</a>.<a href="FerricStoreError.html#code">code</a></p>
85
85
  <ul>
86
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L61">src/errors.ts:61</a></li></ul></aside></section>
86
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L71">src/errors.ts:71</a></li></ul></aside></section>
87
87
  <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
88
88
  <h3 class="tsd-anchor-link" id="message"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
89
89
  <div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
@@ -106,7 +106,7 @@
106
106
  <h3 class="tsd-anchor-link" id="requestdisposition"><code class="tsd-tag">Readonly</code><span>request<wbr/>Disposition</span><a href="#requestdisposition" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
107
107
  <div class="tsd-signature"><span class="tsd-kind-property">requestDisposition</span><span class="tsd-signature-symbol">:</span> <a href="../types/RequestDisposition.html" class="tsd-signature-type tsd-kind-type-alias">RequestDisposition</a></div><aside class="tsd-sources">
108
108
  <ul>
109
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L62">src/errors.ts:62</a></li></ul></aside></section>
109
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L72">src/errors.ts:72</a></li></ul></aside></section>
110
110
  <section class="tsd-panel tsd-member tsd-is-inherited">
111
111
  <h3 class="tsd-anchor-link" id="retryable"><code class="tsd-tag">Readonly</code><span>retryable</span><a href="#retryable" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
112
112
  <div class="tsd-signature"><span class="tsd-kind-property">retryable</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></div><aside class="tsd-sources">
@@ -135,7 +135,7 @@
135
135
  <h3 class="tsd-anchor-link" id="timeoutms"><code class="tsd-tag">Readonly</code><span>timeout<wbr/>Ms</span><a href="#timeoutms" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
136
136
  <div class="tsd-signature"><span class="tsd-kind-property">timeoutMs</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
137
137
  <ul>
138
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L63">src/errors.ts:63</a></li></ul></aside></section>
138
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L73">src/errors.ts:73</a></li></ul></aside></section>
139
139
  <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
140
140
  <h3 class="tsd-anchor-link" id="stacktracelimit"><code class="tsd-tag">Static</code><span>stack<wbr/>Trace<wbr/>Limit</span><a href="#stacktracelimit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
141
141
  <div class="tsd-signature"><span class="tsd-kind-property">stackTraceLimit</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
@@ -13,14 +13,14 @@
13
13
  <section class="tsd-panel tsd-comment">
14
14
  <div class="tsd-comment tsd-typography"><p>The contacted endpoint cannot serve this route and topology should be refreshed.</p>
15
15
  </div></section>
16
- <section class="tsd-panel tsd-hierarchy" data-refl="2666">
16
+ <section class="tsd-panel tsd-hierarchy" data-refl="2695">
17
17
  <h4>Hierarchy (<a href="../hierarchy.html#RerouteError">View Summary</a>)</h4>
18
18
  <ul class="tsd-hierarchy">
19
19
  <li class="tsd-hierarchy-item"><a href="FerricStoreError.html" class="tsd-signature-type tsd-kind-class">FerricStoreError</a>
20
20
  <ul class="tsd-hierarchy">
21
21
  <li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">RerouteError</span></li></ul></li></ul></section><aside class="tsd-sources">
22
22
  <ul>
23
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L135">src/errors.ts:135</a></li></ul></aside>
23
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L164">src/errors.ts:164</a></li></ul></aside>
24
24
  <section class="tsd-panel-group tsd-index-group">
25
25
  <section class="tsd-panel tsd-index-panel">
26
26
  <details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
@@ -80,7 +80,7 @@
80
80
  <div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;reroute&quot;</span></div><aside class="tsd-sources">
81
81
  <p>Overrides <a href="FerricStoreError.html">FerricStoreError</a>.<a href="FerricStoreError.html#code">code</a></p>
82
82
  <ul>
83
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L136">src/errors.ts:136</a></li></ul></aside></section>
83
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L165">src/errors.ts:165</a></li></ul></aside></section>
84
84
  <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
85
85
  <h3 class="tsd-anchor-link" id="message"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
86
86
  <div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
@@ -10,14 +10,14 @@
10
10
  <ul class="tsd-breadcrumb" aria-label="Breadcrumb">
11
11
  <li><a href="" aria-current="page">StaleLeaseError</a></li></ul>
12
12
  <h1>Class StaleLeaseError</h1></div>
13
- <section class="tsd-panel tsd-hierarchy" data-refl="2695">
13
+ <section class="tsd-panel tsd-hierarchy" data-refl="2724">
14
14
  <h4>Hierarchy (<a href="../hierarchy.html#StaleLeaseError">View Summary</a>)</h4>
15
15
  <ul class="tsd-hierarchy">
16
16
  <li class="tsd-hierarchy-item"><a href="FerricStoreError.html" class="tsd-signature-type tsd-kind-class">FerricStoreError</a>
17
17
  <ul class="tsd-hierarchy">
18
18
  <li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">StaleLeaseError</span></li></ul></li></ul></section><aside class="tsd-sources">
19
19
  <ul>
20
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L84">src/errors.ts:84</a></li></ul></aside>
20
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L113">src/errors.ts:113</a></li></ul></aside>
21
21
  <section class="tsd-panel-group tsd-index-group">
22
22
  <section class="tsd-panel tsd-index-panel">
23
23
  <details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
@@ -77,7 +77,7 @@
77
77
  <div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;stale_lease&quot;</span></div><aside class="tsd-sources">
78
78
  <p>Overrides <a href="FerricStoreError.html">FerricStoreError</a>.<a href="FerricStoreError.html#code">code</a></p>
79
79
  <ul>
80
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L85">src/errors.ts:85</a></li></ul></aside></section>
80
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L114">src/errors.ts:114</a></li></ul></aside></section>
81
81
  <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
82
82
  <h3 class="tsd-anchor-link" id="message"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
83
83
  <div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
@@ -13,14 +13,14 @@
13
13
  <section class="tsd-panel tsd-comment">
14
14
  <div class="tsd-comment tsd-typography"><p>FLOW.POLICY.SET expected_generation did not match the stored generation.</p>
15
15
  </div></section>
16
- <section class="tsd-panel tsd-hierarchy" data-refl="2724">
16
+ <section class="tsd-panel tsd-hierarchy" data-refl="2753">
17
17
  <h4>Hierarchy (<a href="../hierarchy.html#StalePolicyGenerationError">View Summary</a>)</h4>
18
18
  <ul class="tsd-hierarchy">
19
19
  <li class="tsd-hierarchy-item"><a href="FerricStoreError.html" class="tsd-signature-type tsd-kind-class">FerricStoreError</a>
20
20
  <ul class="tsd-hierarchy">
21
21
  <li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">StalePolicyGenerationError</span></li></ul></li></ul></section><aside class="tsd-sources">
22
22
  <ul>
23
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L89">src/errors.ts:89</a></li></ul></aside>
23
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L118">src/errors.ts:118</a></li></ul></aside>
24
24
  <section class="tsd-panel-group tsd-index-group">
25
25
  <section class="tsd-panel tsd-index-panel">
26
26
  <details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
@@ -80,7 +80,7 @@
80
80
  <div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;stale_policy_generation&quot;</span></div><aside class="tsd-sources">
81
81
  <p>Overrides <a href="FerricStoreError.html">FerricStoreError</a>.<a href="FerricStoreError.html#code">code</a></p>
82
82
  <ul>
83
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L90">src/errors.ts:90</a></li></ul></aside></section>
83
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L119">src/errors.ts:119</a></li></ul></aside></section>
84
84
  <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
85
85
  <h3 class="tsd-anchor-link" id="message"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
86
86
  <div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">