@ferricstore/ferricstore 0.12.2 → 0.13.1

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 (110) hide show
  1. package/README.md +45 -3
  2. package/dist/index.cjs +804 -198
  3. package/dist/index.cjs.map +1 -1
  4. package/dist/index.d.cts +87 -9
  5. package/dist/index.d.ts +87 -9
  6. package/dist/index.js +798 -194
  7. package/dist/index.js.map +1 -1
  8. package/dist/langgraph.cjs.map +1 -1
  9. package/dist/langgraph.d.cts +1 -1
  10. package/dist/langgraph.d.ts +1 -1
  11. package/dist/langgraph.js.map +1 -1
  12. package/dist/openai-agents.cjs.map +1 -1
  13. package/dist/openai-agents.js.map +1 -1
  14. package/dist/{outcomes-DmBwnq0Y.d.cts → outcomes-CcX956h4.d.cts} +20 -1
  15. package/dist/{outcomes-BbFDp3AH.d.ts → outcomes-DLJYTrX8.d.ts} +20 -1
  16. package/docs/api/assets/hierarchy.js +1 -1
  17. package/docs/api/assets/highlight.css +9 -2
  18. package/docs/api/assets/navigation.js +1 -1
  19. package/docs/api/assets/search.js +1 -1
  20. package/docs/api/classes/ConnectionClosedError.html +5 -5
  21. package/docs/api/classes/FerricStoreClient.html +68 -23
  22. package/docs/api/classes/FerricStoreError.html +2 -1
  23. package/docs/api/classes/FlowAlreadyExistsError.html +3 -3
  24. package/docs/api/classes/FlowBatchError.html +1 -1
  25. package/docs/api/classes/FlowNotFoundError.html +3 -3
  26. package/docs/api/classes/FlowQueryError.html +1 -1
  27. package/docs/api/classes/FlowWrongStateError.html +3 -3
  28. package/docs/api/classes/HTTPTransportError.html +14 -8
  29. package/docs/api/classes/InvalidCommandError.html +3 -3
  30. package/docs/api/classes/LeaseRenewalError.html +3 -3
  31. package/docs/api/classes/LockHeldError.html +3 -3
  32. package/docs/api/classes/LockNotOwnedError.html +3 -3
  33. package/docs/api/classes/NativeAdapter.html +3 -3
  34. package/docs/api/classes/OverloadedError.html +5 -5
  35. package/docs/api/classes/QueueCompletionError.html +1 -1
  36. package/docs/api/classes/RequestNotSentError.html +225 -0
  37. package/docs/api/classes/RequestTimeoutError.html +6 -6
  38. package/docs/api/classes/RerouteError.html +3 -3
  39. package/docs/api/classes/StaleLeaseError.html +3 -3
  40. package/docs/api/classes/StalePolicyGenerationError.html +3 -3
  41. package/docs/api/classes/Workflow.html +19 -19
  42. package/docs/api/classes/WorkflowClient.html +4 -4
  43. package/docs/api/classes/WorkflowContext.html +73 -37
  44. package/docs/api/classes/WorkflowFlowCommands.html +26 -22
  45. package/docs/api/classes/WorkflowWorker.html +6 -6
  46. package/docs/api/functions/classifyServerError.html +1 -1
  47. package/docs/api/functions/complete.html +1 -1
  48. package/docs/api/functions/fail.html +1 -1
  49. package/docs/api/functions/isAlreadyAppliedOutcome.html +41 -0
  50. package/docs/api/functions/isOutcome.html +1 -1
  51. package/docs/api/functions/mapException.html +1 -1
  52. package/docs/api/functions/retry.html +1 -1
  53. package/docs/api/functions/transition.html +1 -1
  54. package/docs/api/hierarchy.html +56 -47
  55. package/docs/api/index.html +32 -4
  56. package/docs/api/interfaces/AdminListOptions.html +1 -1
  57. package/docs/api/interfaces/AdvanceOptions.html +145 -0
  58. package/docs/api/interfaces/AlreadyAppliedOutcome.html +69 -0
  59. package/docs/api/interfaces/AppliedStepOutcome.html +87 -0
  60. package/docs/api/interfaces/CancelOptions.html +13 -9
  61. package/docs/api/interfaces/CompleteOptions.html +13 -9
  62. package/docs/api/interfaces/CompleteOutcome.html +13 -13
  63. package/docs/api/interfaces/CreateManyOptions.html +1 -1
  64. package/docs/api/interfaces/EffectCompensateOptions.html +1 -1
  65. package/docs/api/interfaces/EffectConfirmOptions.html +1 -1
  66. package/docs/api/interfaces/EffectFailOptions.html +1 -1
  67. package/docs/api/interfaces/EffectStatusOptions.html +1 -1
  68. package/docs/api/interfaces/ExtendLeaseOptions.html +10 -8
  69. package/docs/api/interfaces/FailOptions.html +13 -9
  70. package/docs/api/interfaces/FailOutcome.html +13 -13
  71. package/docs/api/interfaces/FerricStoreClientFromUrlOptions.html +1 -1
  72. package/docs/api/interfaces/FerricStoreClientOptions.html +1 -1
  73. package/docs/api/interfaces/FlowQueryCountResult.html +1 -1
  74. package/docs/api/interfaces/FlowQueryIndexBuild.html +1 -1
  75. package/docs/api/interfaces/FlowQueryIndexProgress.html +1 -1
  76. package/docs/api/interfaces/FlowQueryIndexValidation.html +1 -1
  77. package/docs/api/interfaces/FlowQueryRecordsResult.html +1 -1
  78. package/docs/api/interfaces/HistoryOptions.html +16 -16
  79. package/docs/api/interfaces/InvocationCreateOptions.html +1 -1
  80. package/docs/api/interfaces/LeaseMutationOptions.html +11 -7
  81. package/docs/api/interfaces/LimitListOptions.html +1 -1
  82. package/docs/api/interfaces/MutateOptions.html +8 -4
  83. package/docs/api/interfaces/NamedValueMutation.html +9 -9
  84. package/docs/api/interfaces/ReadOptions.html +12 -12
  85. package/docs/api/interfaces/ReclaimOptions.html +1 -1
  86. package/docs/api/interfaces/ReplayedStepResult.html +73 -0
  87. package/docs/api/interfaces/RequestContextOptions.html +1 -1
  88. package/docs/api/interfaces/RetryOptions.html +13 -9
  89. package/docs/api/interfaces/RetryOutcome.html +13 -13
  90. package/docs/api/interfaces/RunStepsItem.html +3 -3
  91. package/docs/api/interfaces/RunStepsManyOptions.html +11 -11
  92. package/docs/api/interfaces/SearchOptions.html +13 -13
  93. package/docs/api/interfaces/StepContinueOptions.html +16 -12
  94. package/docs/api/interfaces/StepOptions.html +166 -0
  95. package/docs/api/interfaces/StepResult.html +67 -0
  96. package/docs/api/interfaces/TDigestCreateOptions.html +1 -1
  97. package/docs/api/interfaces/TDigestMergeOptions.html +1 -1
  98. package/docs/api/interfaces/TransitionOptions.html +15 -11
  99. package/docs/api/interfaces/TransitionOutcome.html +14 -14
  100. package/docs/api/media/design.md +12 -1
  101. package/docs/api/modules.html +8 -8
  102. package/docs/api/types/ConnectionRequestDisposition.html +1 -1
  103. package/docs/api/types/ManagementPairs.html +1 -1
  104. package/docs/api/types/Outcome.html +1 -1
  105. package/docs/api/types/RequestDisposition.html +1 -1
  106. package/docs/api/types/SearchStateMeta.html +1 -1
  107. package/docs/api/types/WorkflowStepResult.html +38 -0
  108. package/docs/api/variables/FERRICSTORE_SDK_VERSION.html +1 -1
  109. package/docs/design.md +12 -1
  110. package/package.json +1 -1
package/docs/api/interfaces/HistoryOptions.html CHANGED
@@ -12,7 +12,7 @@
12
12
  <h1>Interface HistoryOptions</h1></div>
13
13
  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">HistoryOptions</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#consistentprojection">consistentProjection</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#count">count</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#event">event</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#fromevent">fromEvent</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#fromms">fromMs</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#fromversion">fromVersion</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#includecold">includeCold</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#partitionkey">partitionKey</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#payloadmaxbytes">payloadMaxBytes</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#rev">rev</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#toevent">toEvent</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#toms">toMs</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#toversion">toVersion</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#values">values</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#worker">worker</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources">
14
14
  <ul>
15
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L331">src/client-options.ts:331</a></li></ul></aside>
15
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L360">src/client-options.ts:360</a></li></ul></aside>
16
16
  <section class="tsd-panel-group tsd-index-group">
17
17
  <section class="tsd-panel tsd-index-panel">
18
18
  <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>
@@ -43,77 +43,77 @@
43
43
  <h3 class="tsd-anchor-link" id="consistentprojection"><code class="tsd-tag">Optional</code><span>consistent<wbr/>Projection</span><a href="#consistentprojection" 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>
44
44
  <div class="tsd-signature"><span class="tsd-kind-property">consistentProjection</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
45
45
  <ul>
46
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L344">src/client-options.ts:344</a></li></ul></aside></section>
46
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L373">src/client-options.ts:373</a></li></ul></aside></section>
47
47
  <section class="tsd-panel tsd-member">
48
48
  <h3 class="tsd-anchor-link" id="count"><code class="tsd-tag">Optional</code><span>count</span><a href="#count" 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
49
  <div class="tsd-signature"><span class="tsd-kind-property">count</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
50
50
  <ul>
51
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L333">src/client-options.ts:333</a></li></ul></aside></section>
51
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L362">src/client-options.ts:362</a></li></ul></aside></section>
52
52
  <section class="tsd-panel tsd-member">
53
53
  <h3 class="tsd-anchor-link" id="event"><code class="tsd-tag">Optional</code><span>event</span><a href="#event" 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>
54
54
  <div class="tsd-signature"><span class="tsd-kind-property">event</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
55
55
  <ul>
56
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L341">src/client-options.ts:341</a></li></ul></aside></section>
56
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L370">src/client-options.ts:370</a></li></ul></aside></section>
57
57
  <section class="tsd-panel tsd-member">
58
58
  <h3 class="tsd-anchor-link" id="fromevent"><code class="tsd-tag">Optional</code><span>from<wbr/>Event</span><a href="#fromevent" 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>
59
59
  <div class="tsd-signature"><span class="tsd-kind-property">fromEvent</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
60
60
  <ul>
61
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L334">src/client-options.ts:334</a></li></ul></aside></section>
61
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L363">src/client-options.ts:363</a></li></ul></aside></section>
62
62
  <section class="tsd-panel tsd-member">
63
63
  <h3 class="tsd-anchor-link" id="fromms"><code class="tsd-tag">Optional</code><span>from<wbr/>Ms</span><a href="#fromms" 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>
64
64
  <div class="tsd-signature"><span class="tsd-kind-property">fromMs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
65
65
  <ul>
66
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L336">src/client-options.ts:336</a></li></ul></aside></section>
66
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L365">src/client-options.ts:365</a></li></ul></aside></section>
67
67
  <section class="tsd-panel tsd-member">
68
68
  <h3 class="tsd-anchor-link" id="fromversion"><code class="tsd-tag">Optional</code><span>from<wbr/>Version</span><a href="#fromversion" 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>
69
69
  <div class="tsd-signature"><span class="tsd-kind-property">fromVersion</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
70
70
  <ul>
71
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L338">src/client-options.ts:338</a></li></ul></aside></section>
71
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L367">src/client-options.ts:367</a></li></ul></aside></section>
72
72
  <section class="tsd-panel tsd-member">
73
73
  <h3 class="tsd-anchor-link" id="includecold"><code class="tsd-tag">Optional</code><span>include<wbr/>Cold</span><a href="#includecold" 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>
74
74
  <div class="tsd-signature"><span class="tsd-kind-property">includeCold</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
75
75
  <ul>
76
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L343">src/client-options.ts:343</a></li></ul></aside></section>
76
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L372">src/client-options.ts:372</a></li></ul></aside></section>
77
77
  <section class="tsd-panel tsd-member">
78
78
  <h3 class="tsd-anchor-link" id="partitionkey"><code class="tsd-tag">Optional</code><span>partition<wbr/>Key</span><a href="#partitionkey" 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>
79
79
  <div class="tsd-signature"><span class="tsd-kind-property">partitionKey</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
80
80
  <ul>
81
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L332">src/client-options.ts:332</a></li></ul></aside></section>
81
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L361">src/client-options.ts:361</a></li></ul></aside></section>
82
82
  <section class="tsd-panel tsd-member">
83
83
  <h3 class="tsd-anchor-link" id="payloadmaxbytes"><code class="tsd-tag">Optional</code><span>payload<wbr/>Max<wbr/>Bytes</span><a href="#payloadmaxbytes" 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">payloadMaxBytes</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
85
85
  <ul>
86
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L346">src/client-options.ts:346</a></li></ul></aside></section>
86
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L375">src/client-options.ts:375</a></li></ul></aside></section>
87
87
  <section class="tsd-panel tsd-member">
88
88
  <h3 class="tsd-anchor-link" id="rev"><code class="tsd-tag">Optional</code><span>rev</span><a href="#rev" 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">rev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
90
90
  <ul>
91
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L340">src/client-options.ts:340</a></li></ul></aside></section>
91
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L369">src/client-options.ts:369</a></li></ul></aside></section>
92
92
  <section class="tsd-panel tsd-member">
93
93
  <h3 class="tsd-anchor-link" id="toevent"><code class="tsd-tag">Optional</code><span>to<wbr/>Event</span><a href="#toevent" 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>
94
94
  <div class="tsd-signature"><span class="tsd-kind-property">toEvent</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
95
95
  <ul>
96
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L335">src/client-options.ts:335</a></li></ul></aside></section>
96
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L364">src/client-options.ts:364</a></li></ul></aside></section>
97
97
  <section class="tsd-panel tsd-member">
98
98
  <h3 class="tsd-anchor-link" id="toms"><code class="tsd-tag">Optional</code><span>to<wbr/>Ms</span><a href="#toms" 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
99
  <div class="tsd-signature"><span class="tsd-kind-property">toMs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
100
100
  <ul>
101
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L337">src/client-options.ts:337</a></li></ul></aside></section>
101
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L366">src/client-options.ts:366</a></li></ul></aside></section>
102
102
  <section class="tsd-panel tsd-member">
103
103
  <h3 class="tsd-anchor-link" id="toversion"><code class="tsd-tag">Optional</code><span>to<wbr/>Version</span><a href="#toversion" 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>
104
104
  <div class="tsd-signature"><span class="tsd-kind-property">toVersion</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
105
105
  <ul>
106
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L339">src/client-options.ts:339</a></li></ul></aside></section>
106
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L368">src/client-options.ts:368</a></li></ul></aside></section>
107
107
  <section class="tsd-panel tsd-member">
108
108
  <h3 class="tsd-anchor-link" id="values"><code class="tsd-tag">Optional</code><span>values</span><a href="#values" 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>
109
109
  <div class="tsd-signature"><span class="tsd-kind-property">values</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
110
110
  <ul>
111
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L345">src/client-options.ts:345</a></li></ul></aside></section>
111
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L374">src/client-options.ts:374</a></li></ul></aside></section>
112
112
  <section class="tsd-panel tsd-member">
113
113
  <h3 class="tsd-anchor-link" id="worker"><code class="tsd-tag">Optional</code><span>worker</span><a href="#worker" 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>
114
114
  <div class="tsd-signature"><span class="tsd-kind-property">worker</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
115
115
  <ul>
116
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L342">src/client-options.ts:342</a></li></ul></aside></section></section></details></div>
116
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L371">src/client-options.ts:371</a></li></ul></aside></section></section></details></div>
117
117
  <div class="col-sidebar">
118
118
  <div class="page-menu">
119
119
  <div class="tsd-navigation settings">
package/docs/api/interfaces/InvocationCreateOptions.html CHANGED
@@ -11,7 +11,7 @@
11
11
  <li><a href="" aria-current="page">InvocationCreateOptions</a></li></ul>
12
12
  <h1>Interface InvocationCreateOptions</h1></div>
13
13
  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">InvocationCreateOptions</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#context">context</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#idempotencykey">idempotencyKey</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#requestcontext">requestContext</a><span class="tsd-signature-symbol">?:</span> <a href="RequestContext.html" class="tsd-signature-type tsd-kind-interface">RequestContext</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
14
- <section class="tsd-panel tsd-hierarchy" data-refl="1722">
14
+ <section class="tsd-panel tsd-hierarchy" data-refl="1744">
15
15
  <h4>Hierarchy (<a href="../hierarchy.html#InvocationCreateOptions">View Summary</a>)</h4>
16
16
  <ul class="tsd-hierarchy">
17
17
  <li class="tsd-hierarchy-item"><a href="RequestContextOptions.html" class="tsd-signature-type tsd-kind-interface">RequestContextOptions</a>
package/docs/api/interfaces/LeaseMutationOptions.html CHANGED
@@ -11,7 +11,7 @@
11
11
  <li><a href="" aria-current="page">LeaseMutationOptions</a></li></ul>
12
12
  <h1>Interface LeaseMutationOptions</h1></div>
13
13
  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">LeaseMutationOptions</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#attributesdelete">attributesDelete</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#attributesmerge">attributesMerge</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <a href="../types/CommandArgument.html" class="tsd-signature-type tsd-kind-type-alias">CommandArgument</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#dropvalues">dropValues</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#fencingtoken">fencingToken</a><span class="tsd-signature-symbol">:</span> <a href="../types/FencingToken.html" class="tsd-signature-type tsd-kind-type-alias">FencingToken</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#leasetoken">leaseToken</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#nowms">nowMs</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#overridevalues">overrideValues</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#partitionkey">partitionKey</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#payload">payload</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#returnrecord">returnRecord</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#statemeta">stateMeta</a><span class="tsd-signature-symbol">?:</span> <a href="../types/StateMeta.html" class="tsd-signature-type tsd-kind-type-alias">StateMeta</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#valuerefs">valueRefs</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#values">values</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
14
- <section class="tsd-panel tsd-hierarchy" data-refl="1745">
14
+ <section class="tsd-panel tsd-hierarchy" data-refl="1767">
15
15
  <h4>Hierarchy (<a href="../hierarchy.html#LeaseMutationOptions">View Summary</a>)</h4>
16
16
  <ul class="tsd-hierarchy">
17
17
  <li class="tsd-hierarchy-item"><a href="MutateOptions.html" class="tsd-signature-type tsd-kind-interface">MutateOptions</a>
@@ -23,7 +23,7 @@
23
23
  <li class="tsd-hierarchy-item"><a href="RetryOptions.html" class="tsd-signature-type tsd-kind-interface">RetryOptions</a></li>
24
24
  <li class="tsd-hierarchy-item"><a href="TransitionOptions.html" class="tsd-signature-type tsd-kind-interface">TransitionOptions</a></li></ul></li></ul></li></ul></section><aside class="tsd-sources">
25
25
  <ul>
26
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L246">src/client-options.ts:246</a></li></ul></aside>
26
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L251">src/client-options.ts:251</a></li></ul></aside>
27
27
  <section class="tsd-panel-group tsd-index-group">
28
28
  <section class="tsd-panel tsd-index-panel">
29
29
  <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>
@@ -70,18 +70,22 @@
70
70
  <h3 class="tsd-anchor-link" id="fencingtoken"><span>fencing<wbr/>Token</span><a href="#fencingtoken" 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>
71
71
  <div class="tsd-signature"><span class="tsd-kind-property">fencingToken</span><span class="tsd-signature-symbol">:</span> <a href="../types/FencingToken.html" class="tsd-signature-type tsd-kind-type-alias">FencingToken</a></div><aside class="tsd-sources">
72
72
  <ul>
73
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L248">src/client-options.ts:248</a></li></ul></aside></section>
73
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L253">src/client-options.ts:253</a></li></ul></aside></section>
74
74
  <section class="tsd-panel tsd-member">
75
75
  <h3 class="tsd-anchor-link" id="leasetoken"><span>lease<wbr/>Token</span><a href="#leasetoken" 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>
76
76
  <div class="tsd-signature"><span class="tsd-kind-property">leaseToken</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Buffer</span></div><aside class="tsd-sources">
77
77
  <ul>
78
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L247">src/client-options.ts:247</a></li></ul></aside></section>
78
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L252">src/client-options.ts:252</a></li></ul></aside></section>
79
79
  <section class="tsd-panel tsd-member tsd-is-inherited">
80
80
  <h3 class="tsd-anchor-link" id="nowms"><code class="tsd-tag">Optional</code><span>now<wbr/>Ms</span><a href="#nowms" 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">nowMs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
81
+ <div class="tsd-signature"><span class="tsd-kind-property">nowMs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
82
+ <div class="tsd-comment tsd-typography"><p>Explicit client-supplied command timestamp. Omit in production so each
83
+ request samples the current client wall clock; primarily useful for tests.
84
+ This is not the server response time or the client transport deadline.</p>
85
+ </div><aside class="tsd-sources">
82
86
  <p>Inherited from <a href="MutateOptions.html">MutateOptions</a>.<a href="MutateOptions.html#nowms">nowMs</a></p>
83
87
  <ul>
84
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L242">src/client-options.ts:242</a></li></ul></aside></section>
88
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L247">src/client-options.ts:247</a></li></ul></aside></section>
85
89
  <section class="tsd-panel tsd-member tsd-is-inherited">
86
90
  <h3 class="tsd-anchor-link" id="overridevalues"><code class="tsd-tag">Optional</code><span>override<wbr/>Values</span><a href="#overridevalues" 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
91
  <div class="tsd-signature"><span class="tsd-kind-property">overrideValues</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
@@ -105,7 +109,7 @@
105
109
  <div class="tsd-signature"><span class="tsd-kind-property">returnRecord</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
106
110
  <p>Inherited from <a href="MutateOptions.html">MutateOptions</a>.<a href="MutateOptions.html#returnrecord">returnRecord</a></p>
107
111
  <ul>
108
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L243">src/client-options.ts:243</a></li></ul></aside></section>
112
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L248">src/client-options.ts:248</a></li></ul></aside></section>
109
113
  <section class="tsd-panel tsd-member tsd-is-inherited">
110
114
  <h3 class="tsd-anchor-link" id="statemeta"><code class="tsd-tag">Optional</code><span>state<wbr/>Meta</span><a href="#statemeta" 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>
111
115
  <div class="tsd-signature"><span class="tsd-kind-property">stateMeta</span><span class="tsd-signature-symbol">?:</span> <a href="../types/StateMeta.html" class="tsd-signature-type tsd-kind-type-alias">StateMeta</a></div><aside class="tsd-sources">
package/docs/api/interfaces/LimitListOptions.html CHANGED
@@ -11,7 +11,7 @@
11
11
  <li><a href="" aria-current="page">LimitListOptions</a></li></ul>
12
12
  <h1>Interface LimitListOptions</h1></div>
13
13
  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">LimitListOptions</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#limit">limit</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#nowms">nowMs</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#partitionkey">partitionKey</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#scope">scope</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
14
- <section class="tsd-panel tsd-hierarchy" data-refl="1736">
14
+ <section class="tsd-panel tsd-hierarchy" data-refl="1758">
15
15
  <h4>Hierarchy (<a href="../hierarchy.html#LimitListOptions">View Summary</a>)</h4>
16
16
  <ul class="tsd-hierarchy">
17
17
  <li class="tsd-hierarchy-item"><a href="AdminListOptions.html" class="tsd-signature-type tsd-kind-interface">AdminListOptions</a>
package/docs/api/interfaces/MutateOptions.html CHANGED
@@ -11,7 +11,7 @@
11
11
  <li><a href="" aria-current="page">MutateOptions</a></li></ul>
12
12
  <h1>Interface MutateOptions</h1></div>
13
13
  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">MutateOptions</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#attributesdelete">attributesDelete</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#attributesmerge">attributesMerge</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <a href="../types/CommandArgument.html" class="tsd-signature-type tsd-kind-type-alias">CommandArgument</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#dropvalues">dropValues</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#nowms">nowMs</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#overridevalues">overrideValues</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#partitionkey">partitionKey</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#payload">payload</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#returnrecord">returnRecord</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#statemeta">stateMeta</a><span class="tsd-signature-symbol">?:</span> <a href="../types/StateMeta.html" class="tsd-signature-type tsd-kind-type-alias">StateMeta</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#valuerefs">valueRefs</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#values">values</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
14
- <section class="tsd-panel tsd-hierarchy" data-refl="1760">
14
+ <section class="tsd-panel tsd-hierarchy" data-refl="1782">
15
15
  <h4>Hierarchy (<a href="../hierarchy.html#MutateOptions">View Summary</a>)</h4>
16
16
  <ul class="tsd-hierarchy">
17
17
  <li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">MutateOptions</span>
@@ -58,9 +58,13 @@
58
58
  <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L237">src/client-options.ts:237</a></li></ul></aside></section>
59
59
  <section class="tsd-panel tsd-member">
60
60
  <h3 class="tsd-anchor-link" id="nowms"><code class="tsd-tag">Optional</code><span>now<wbr/>Ms</span><a href="#nowms" 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>
61
- <div class="tsd-signature"><span class="tsd-kind-property">nowMs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
61
+ <div class="tsd-signature"><span class="tsd-kind-property">nowMs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
62
+ <div class="tsd-comment tsd-typography"><p>Explicit client-supplied command timestamp. Omit in production so each
63
+ request samples the current client wall clock; primarily useful for tests.
64
+ This is not the server response time or the client transport deadline.</p>
65
+ </div><aside class="tsd-sources">
62
66
  <ul>
63
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L242">src/client-options.ts:242</a></li></ul></aside></section>
67
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L247">src/client-options.ts:247</a></li></ul></aside></section>
64
68
  <section class="tsd-panel tsd-member">
65
69
  <h3 class="tsd-anchor-link" id="overridevalues"><code class="tsd-tag">Optional</code><span>override<wbr/>Values</span><a href="#overridevalues" 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>
66
70
  <div class="tsd-signature"><span class="tsd-kind-property">overrideValues</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
@@ -80,7 +84,7 @@
80
84
  <h3 class="tsd-anchor-link" id="returnrecord"><code class="tsd-tag">Optional</code><span>return<wbr/>Record</span><a href="#returnrecord" 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
85
  <div class="tsd-signature"><span class="tsd-kind-property">returnRecord</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
82
86
  <ul>
83
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L243">src/client-options.ts:243</a></li></ul></aside></section>
87
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L248">src/client-options.ts:248</a></li></ul></aside></section>
84
88
  <section class="tsd-panel tsd-member">
85
89
  <h3 class="tsd-anchor-link" id="statemeta"><code class="tsd-tag">Optional</code><span>state<wbr/>Meta</span><a href="#statemeta" 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
90
  <div class="tsd-signature"><span class="tsd-kind-property">stateMeta</span><span class="tsd-signature-symbol">?:</span> <a href="../types/StateMeta.html" class="tsd-signature-type tsd-kind-type-alias">StateMeta</a></div><aside class="tsd-sources">
package/docs/api/interfaces/NamedValueMutation.html CHANGED
@@ -11,7 +11,7 @@
11
11
  <li><a href="" aria-current="page">NamedValueMutation</a></li></ul>
12
12
  <h1>Interface NamedValueMutation</h1></div>
13
13
  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">NamedValueMutation</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#attributesdelete">attributesDelete</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#attributesmerge">attributesMerge</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <a href="../types/CommandArgument.html" class="tsd-signature-type tsd-kind-type-alias">CommandArgument</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#dropvalues">dropValues</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#overridevalues">overrideValues</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#statemeta">stateMeta</a><span class="tsd-signature-symbol">?:</span> <a href="../types/StateMeta.html" class="tsd-signature-type tsd-kind-type-alias">StateMeta</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#valuerefs">valueRefs</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#values">values</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
14
- <section class="tsd-panel tsd-hierarchy" data-refl="2759">
14
+ <section class="tsd-panel tsd-hierarchy" data-refl="2851">
15
15
  <h4>Hierarchy (<a href="../hierarchy.html#NamedValueMutation">View Summary</a>)</h4>
16
16
  <ul class="tsd-hierarchy">
17
17
  <li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">NamedValueMutation</span>
@@ -21,7 +21,7 @@
21
21
  <li class="tsd-hierarchy-item"><a href="RetryOutcome.html" class="tsd-signature-type tsd-kind-interface">RetryOutcome</a></li>
22
22
  <li class="tsd-hierarchy-item"><a href="TransitionOutcome.html" class="tsd-signature-type tsd-kind-interface">TransitionOutcome</a></li></ul></li></ul></section><aside class="tsd-sources">
23
23
  <ul>
24
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/outcomes.ts#L8">src/outcomes.ts:8</a></li></ul></aside>
24
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/outcomes.ts#L32">src/outcomes.ts:32</a></li></ul></aside>
25
25
  <section class="tsd-panel-group tsd-index-group">
26
26
  <section class="tsd-panel tsd-index-panel">
27
27
  <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>
@@ -44,37 +44,37 @@
44
44
  <h3 class="tsd-anchor-link" id="attributesdelete"><code class="tsd-tag">Optional</code><span>attributes<wbr/>Delete</span><a href="#attributesdelete" 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>
45
45
  <div class="tsd-signature"><span class="tsd-kind-property">attributesDelete</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
46
46
  <ul>
47
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/outcomes.ts#L14">src/outcomes.ts:14</a></li></ul></aside></section>
47
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/outcomes.ts#L38">src/outcomes.ts:38</a></li></ul></aside></section>
48
48
  <section class="tsd-panel tsd-member">
49
49
  <h3 class="tsd-anchor-link" id="attributesmerge"><code class="tsd-tag">Optional</code><span>attributes<wbr/>Merge</span><a href="#attributesmerge" 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>
50
50
  <div class="tsd-signature"><span class="tsd-kind-property">attributesMerge</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <a href="../types/CommandArgument.html" class="tsd-signature-type tsd-kind-type-alias">CommandArgument</a><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources">
51
51
  <ul>
52
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/outcomes.ts#L13">src/outcomes.ts:13</a></li></ul></aside></section>
52
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/outcomes.ts#L37">src/outcomes.ts:37</a></li></ul></aside></section>
53
53
  <section class="tsd-panel tsd-member">
54
54
  <h3 class="tsd-anchor-link" id="dropvalues"><code class="tsd-tag">Optional</code><span>drop<wbr/>Values</span><a href="#dropvalues" 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>
55
55
  <div class="tsd-signature"><span class="tsd-kind-property">dropValues</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
56
56
  <ul>
57
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/outcomes.ts#L11">src/outcomes.ts:11</a></li></ul></aside></section>
57
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/outcomes.ts#L35">src/outcomes.ts:35</a></li></ul></aside></section>
58
58
  <section class="tsd-panel tsd-member">
59
59
  <h3 class="tsd-anchor-link" id="overridevalues"><code class="tsd-tag">Optional</code><span>override<wbr/>Values</span><a href="#overridevalues" 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>
60
60
  <div class="tsd-signature"><span class="tsd-kind-property">overrideValues</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
61
61
  <ul>
62
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/outcomes.ts#L12">src/outcomes.ts:12</a></li></ul></aside></section>
62
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/outcomes.ts#L36">src/outcomes.ts:36</a></li></ul></aside></section>
63
63
  <section class="tsd-panel tsd-member">
64
64
  <h3 class="tsd-anchor-link" id="statemeta"><code class="tsd-tag">Optional</code><span>state<wbr/>Meta</span><a href="#statemeta" 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>
65
65
  <div class="tsd-signature"><span class="tsd-kind-property">stateMeta</span><span class="tsd-signature-symbol">?:</span> <a href="../types/StateMeta.html" class="tsd-signature-type tsd-kind-type-alias">StateMeta</a></div><aside class="tsd-sources">
66
66
  <ul>
67
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/outcomes.ts#L15">src/outcomes.ts:15</a></li></ul></aside></section>
67
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/outcomes.ts#L39">src/outcomes.ts:39</a></li></ul></aside></section>
68
68
  <section class="tsd-panel tsd-member">
69
69
  <h3 class="tsd-anchor-link" id="valuerefs"><code class="tsd-tag">Optional</code><span>value<wbr/>Refs</span><a href="#valuerefs" 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>
70
70
  <div class="tsd-signature"><span class="tsd-kind-property">valueRefs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources">
71
71
  <ul>
72
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/outcomes.ts#L10">src/outcomes.ts:10</a></li></ul></aside></section>
72
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/outcomes.ts#L34">src/outcomes.ts:34</a></li></ul></aside></section>
73
73
  <section class="tsd-panel tsd-member">
74
74
  <h3 class="tsd-anchor-link" id="values"><code class="tsd-tag">Optional</code><span>values</span><a href="#values" 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
75
  <div class="tsd-signature"><span class="tsd-kind-property">values</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources">
76
76
  <ul>
77
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/outcomes.ts#L9">src/outcomes.ts:9</a></li></ul></aside></section></section></details></div>
77
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/outcomes.ts#L33">src/outcomes.ts:33</a></li></ul></aside></section></section></details></div>
78
78
  <div class="col-sidebar">
79
79
  <div class="page-menu">
80
80
  <div class="tsd-navigation settings">
package/docs/api/interfaces/ReadOptions.html CHANGED
@@ -11,14 +11,14 @@
11
11
  <li><a href="" aria-current="page">ReadOptions</a></li></ul>
12
12
  <h1>Interface ReadOptions</h1></div>
13
13
  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ReadOptions</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#attributes">attributes</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <a href="../types/CommandArgument.html" class="tsd-signature-type tsd-kind-type-alias">CommandArgument</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#consistentprojection">consistentProjection</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#count">count</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#fromms">fromMs</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#includecold">includeCold</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#partitionkey">partitionKey</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#rev">rev</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#state">state</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#terminalonly">terminalOnly</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#toms">toMs</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
14
- <section class="tsd-panel tsd-hierarchy" data-refl="1772">
14
+ <section class="tsd-panel tsd-hierarchy" data-refl="1794">
15
15
  <h4>Hierarchy (<a href="../hierarchy.html#ReadOptions">View Summary</a>)</h4>
16
16
  <ul class="tsd-hierarchy">
17
17
  <li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">ReadOptions</span>
18
18
  <ul class="tsd-hierarchy">
19
19
  <li class="tsd-hierarchy-item"><a href="SearchOptions.html" class="tsd-signature-type tsd-kind-interface">SearchOptions</a></li></ul></li></ul></section><aside class="tsd-sources">
20
20
  <ul>
21
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L317">src/client-options.ts:317</a></li></ul></aside>
21
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L346">src/client-options.ts:346</a></li></ul></aside>
22
22
  <section class="tsd-panel-group tsd-index-group">
23
23
  <section class="tsd-panel tsd-index-panel">
24
24
  <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>
@@ -44,54 +44,54 @@
44
44
  <h3 class="tsd-anchor-link" id="attributes"><code class="tsd-tag">Optional</code><span>attributes</span><a href="#attributes" 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>
45
45
  <div class="tsd-signature"><span class="tsd-kind-property">attributes</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <a href="../types/CommandArgument.html" class="tsd-signature-type tsd-kind-type-alias">CommandArgument</a><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources">
46
46
  <ul>
47
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L328">src/client-options.ts:328</a></li></ul></aside></section>
47
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L357">src/client-options.ts:357</a></li></ul></aside></section>
48
48
  <section class="tsd-panel tsd-member">
49
49
  <h3 class="tsd-anchor-link" id="consistentprojection"><code class="tsd-tag">Optional</code><span>consistent<wbr/>Projection</span><a href="#consistentprojection" 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>
50
50
  <div class="tsd-signature"><span class="tsd-kind-property">consistentProjection</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
51
51
  <ul>
52
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L327">src/client-options.ts:327</a></li></ul></aside></section>
52
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L356">src/client-options.ts:356</a></li></ul></aside></section>
53
53
  <section class="tsd-panel tsd-member">
54
54
  <h3 class="tsd-anchor-link" id="count"><code class="tsd-tag">Optional</code><span>count</span><a href="#count" 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>
55
55
  <div class="tsd-signature"><span class="tsd-kind-property">count</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
56
56
  <ul>
57
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L319">src/client-options.ts:319</a></li></ul></aside></section>
57
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L348">src/client-options.ts:348</a></li></ul></aside></section>
58
58
  <section class="tsd-panel tsd-member">
59
59
  <h3 class="tsd-anchor-link" id="fromms"><code class="tsd-tag">Optional</code><span>from<wbr/>Ms</span><a href="#fromms" 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>
60
60
  <div class="tsd-signature"><span class="tsd-kind-property">fromMs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
61
61
  <ul>
62
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L320">src/client-options.ts:320</a></li></ul></aside></section>
62
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L349">src/client-options.ts:349</a></li></ul></aside></section>
63
63
  <section class="tsd-panel tsd-member">
64
64
  <h3 class="tsd-anchor-link" id="includecold"><code class="tsd-tag">Optional</code><span>include<wbr/>Cold</span><a href="#includecold" 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>
65
65
  <div class="tsd-signature"><span class="tsd-kind-property">includeCold</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
66
66
  <ul>
67
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L326">src/client-options.ts:326</a></li></ul></aside></section>
67
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L355">src/client-options.ts:355</a></li></ul></aside></section>
68
68
  <section class="tsd-panel tsd-member">
69
69
  <h3 class="tsd-anchor-link" id="partitionkey"><span>partition<wbr/>Key</span><a href="#partitionkey" 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>
70
70
  <div class="tsd-signature"><span class="tsd-kind-property">partitionKey</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
71
71
  <ul>
72
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L318">src/client-options.ts:318</a></li></ul></aside></section>
72
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L347">src/client-options.ts:347</a></li></ul></aside></section>
73
73
  <section class="tsd-panel tsd-member">
74
74
  <h3 class="tsd-anchor-link" id="rev"><code class="tsd-tag">Optional</code><span>rev</span><a href="#rev" 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
75
  <div class="tsd-signature"><span class="tsd-kind-property">rev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
76
76
  <div class="tsd-comment tsd-typography"><p>Newest-first when true. Flow query conveniences default to true.</p>
77
77
  </div><aside class="tsd-sources">
78
78
  <ul>
79
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L323">src/client-options.ts:323</a></li></ul></aside></section>
79
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L352">src/client-options.ts:352</a></li></ul></aside></section>
80
80
  <section class="tsd-panel tsd-member">
81
81
  <h3 class="tsd-anchor-link" id="state"><code class="tsd-tag">Optional</code><span>state</span><a href="#state" 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>
82
82
  <div class="tsd-signature"><span class="tsd-kind-property">state</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
83
83
  <ul>
84
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L324">src/client-options.ts:324</a></li></ul></aside></section>
84
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L353">src/client-options.ts:353</a></li></ul></aside></section>
85
85
  <section class="tsd-panel tsd-member">
86
86
  <h3 class="tsd-anchor-link" id="terminalonly"><code class="tsd-tag">Optional</code><span>terminal<wbr/>Only</span><a href="#terminalonly" 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
87
  <div class="tsd-signature"><span class="tsd-kind-property">terminalOnly</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
88
88
  <ul>
89
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L325">src/client-options.ts:325</a></li></ul></aside></section>
89
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L354">src/client-options.ts:354</a></li></ul></aside></section>
90
90
  <section class="tsd-panel tsd-member">
91
91
  <h3 class="tsd-anchor-link" id="toms"><code class="tsd-tag">Optional</code><span>to<wbr/>Ms</span><a href="#toms" 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>
92
92
  <div class="tsd-signature"><span class="tsd-kind-property">toMs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
93
93
  <ul>
94
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L321">src/client-options.ts:321</a></li></ul></aside></section></section></details></div>
94
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L350">src/client-options.ts:350</a></li></ul></aside></section></section></details></div>
95
95
  <div class="col-sidebar">
96
96
  <div class="page-menu">
97
97
  <div class="tsd-navigation settings">
package/docs/api/interfaces/ReclaimOptions.html CHANGED
@@ -11,7 +11,7 @@
11
11
  <li><a href="" aria-current="page">ReclaimOptions</a></li></ul>
12
12
  <h1>Interface ReclaimOptions</h1></div>
13
13
  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ReclaimOptions</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#includeattributes">includeAttributes</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#jobonly">jobOnly</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#leasems">leaseMs</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#limit">limit</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#nowms">nowMs</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#partitionkey">partitionKey</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#partitionkeys">partitionKeys</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#payload">payload</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#payloadmaxbytes">payloadMaxBytes</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#priority">priority</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#state">state</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">&quot;running&quot;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#valuemaxbytes">valueMaxBytes</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#values">values</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-keyword">readonly</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#worker">worker</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
14
- <section class="tsd-panel tsd-hierarchy" data-refl="1783">
14
+ <section class="tsd-panel tsd-hierarchy" data-refl="1805">
15
15
  <h4>Hierarchy</h4>
16
16
  <ul class="tsd-hierarchy">
17
17
  <li class="tsd-hierarchy-item"><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol">&lt;</span><br/>    <a href="ClaimDueOptions.html" class="tsd-signature-type tsd-kind-interface">ClaimDueOptions</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;state&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;states&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;blockMs&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;reclaimExpired&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;reclaimRatio&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;includeState&quot;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span>