@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/EffectCompensateOptions.html CHANGED
@@ -11,7 +11,7 @@
11
11
  <li><a href="" aria-current="page">EffectCompensateOptions</a></li></ul>
12
12
  <h1>Interface EffectCompensateOptions</h1></div>
13
13
  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">EffectCompensateOptions</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#externalid">externalId</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="#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">&lt;</span><span class="tsd-signature-type">ArrayBufferLike</span><span class="tsd-signature-symbol">&gt;</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="#reason">reason</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="1601">
14
+ <section class="tsd-panel tsd-hierarchy" data-refl="1623">
15
15
  <h4>Hierarchy (<a href="../hierarchy.html#EffectCompensateOptions">View Summary</a>)</h4>
16
16
  <ul class="tsd-hierarchy">
17
17
  <li class="tsd-hierarchy-item"><a href="EffectStatusOptions.html" class="tsd-signature-type tsd-kind-interface">EffectStatusOptions</a>
package/docs/api/interfaces/EffectConfirmOptions.html CHANGED
@@ -11,7 +11,7 @@
11
11
  <li><a href="" aria-current="page">EffectConfirmOptions</a></li></ul>
12
12
  <h1>Interface EffectConfirmOptions</h1></div>
13
13
  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">EffectConfirmOptions</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#externalid">externalId</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="#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="#latencyms">latencyMs</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="#leasetoken">leaseToken</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">ArrayBufferLike</span><span class="tsd-signature-symbol">&gt;</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/><span class="tsd-signature-symbol">}</span></div>
14
- <section class="tsd-panel tsd-hierarchy" data-refl="1608">
14
+ <section class="tsd-panel tsd-hierarchy" data-refl="1630">
15
15
  <h4>Hierarchy (<a href="../hierarchy.html#EffectConfirmOptions">View Summary</a>)</h4>
16
16
  <ul class="tsd-hierarchy">
17
17
  <li class="tsd-hierarchy-item"><a href="EffectStatusOptions.html" class="tsd-signature-type tsd-kind-interface">EffectStatusOptions</a>
package/docs/api/interfaces/EffectFailOptions.html CHANGED
@@ -11,7 +11,7 @@
11
11
  <li><a href="" aria-current="page">EffectFailOptions</a></li></ul>
12
12
  <h1>Interface EffectFailOptions</h1></div>
13
13
  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">EffectFailOptions</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#error">error</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="#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="#latencyms">latencyMs</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="#leasetoken">leaseToken</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">ArrayBufferLike</span><span class="tsd-signature-symbol">&gt;</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="#reason">reason</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="1615">
14
+ <section class="tsd-panel tsd-hierarchy" data-refl="1637">
15
15
  <h4>Hierarchy (<a href="../hierarchy.html#EffectFailOptions">View Summary</a>)</h4>
16
16
  <ul class="tsd-hierarchy">
17
17
  <li class="tsd-hierarchy-item"><a href="EffectStatusOptions.html" class="tsd-signature-type tsd-kind-interface">EffectStatusOptions</a>
package/docs/api/interfaces/EffectStatusOptions.html CHANGED
@@ -11,7 +11,7 @@
11
11
  <li><a href="" aria-current="page">EffectStatusOptions</a></li></ul>
12
12
  <h1>Interface EffectStatusOptions</h1></div>
13
13
  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">EffectStatusOptions</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">&lt;</span><span class="tsd-signature-type">ArrayBufferLike</span><span class="tsd-signature-symbol">&gt;</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/><span class="tsd-signature-symbol">}</span></div>
14
- <section class="tsd-panel tsd-hierarchy" data-refl="1631">
14
+ <section class="tsd-panel tsd-hierarchy" data-refl="1653">
15
15
  <h4>Hierarchy (<a href="../hierarchy.html#EffectStatusOptions">View Summary</a>)</h4>
16
16
  <ul class="tsd-hierarchy">
17
17
  <li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">EffectStatusOptions</span>
package/docs/api/interfaces/ExtendLeaseOptions.html CHANGED
@@ -12,7 +12,7 @@
12
12
  <h1>Interface ExtendLeaseOptions</h1></div>
13
13
  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ExtendLeaseOptions</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="#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="#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="#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="#returnokonsuccess">returnOkOnSuccess</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</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#L251">src/client-options.ts:251</a></li></ul></aside>
15
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L256">src/client-options.ts:256</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>
@@ -34,32 +34,34 @@
34
34
  <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>
35
35
  <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">
36
36
  <ul>
37
- <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>
37
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L258">src/client-options.ts:258</a></li></ul></aside></section>
38
38
  <section class="tsd-panel tsd-member">
39
39
  <h3 class="tsd-anchor-link" id="leasems"><span>lease<wbr/>Ms</span><a href="#leasems" 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>
40
40
  <div class="tsd-signature"><span class="tsd-kind-property">leaseMs</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
41
41
  <ul>
42
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L254">src/client-options.ts:254</a></li></ul></aside></section>
42
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L259">src/client-options.ts:259</a></li></ul></aside></section>
43
43
  <section class="tsd-panel tsd-member">
44
44
  <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>
45
45
  <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">
46
46
  <ul>
47
- <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>
47
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L257">src/client-options.ts:257</a></li></ul></aside></section>
48
48
  <section class="tsd-panel tsd-member">
49
49
  <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>
50
- <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">
50
+ <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>
51
+ <div class="tsd-comment tsd-typography"><p>See <a href="MutateOptions.html#nowms" class="tsd-kind-property">MutateOptions.nowMs</a>; this is a client timestamp override.</p>
52
+ </div><aside class="tsd-sources">
51
53
  <ul>
52
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L256">src/client-options.ts:256</a></li></ul></aside></section>
54
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L262">src/client-options.ts:262</a></li></ul></aside></section>
53
55
  <section class="tsd-panel tsd-member">
54
56
  <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>
55
57
  <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">
56
58
  <ul>
57
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L255">src/client-options.ts:255</a></li></ul></aside></section>
59
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L260">src/client-options.ts:260</a></li></ul></aside></section>
58
60
  <section class="tsd-panel tsd-member">
59
61
  <h3 class="tsd-anchor-link" id="returnokonsuccess"><code class="tsd-tag">Optional</code><span>return<wbr/>Ok<wbr/>On<wbr/>Success</span><a href="#returnokonsuccess" 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
62
  <div class="tsd-signature"><span class="tsd-kind-property">returnOkOnSuccess</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
61
63
  <ul>
62
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L257">src/client-options.ts:257</a></li></ul></aside></section></section></details></div>
64
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L263">src/client-options.ts:263</a></li></ul></aside></section></section></details></div>
63
65
  <div class="col-sidebar">
64
66
  <div class="page-menu">
65
67
  <div class="tsd-navigation settings">
package/docs/api/interfaces/FailOptions.html CHANGED
@@ -11,14 +11,14 @@
11
11
  <li><a href="" aria-current="page">FailOptions</a></li></ul>
12
12
  <h1>Interface FailOptions</h1></div>
13
13
  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">FailOptions</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="#error">error</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="#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="#ttlms">ttlMs</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="#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="1643">
14
+ <section class="tsd-panel tsd-hierarchy" data-refl="1665">
15
15
  <h4>Hierarchy (<a href="../hierarchy.html#FailOptions">View Summary</a>)</h4>
16
16
  <ul class="tsd-hierarchy">
17
17
  <li class="tsd-hierarchy-item"><a href="LeaseMutationOptions.html" class="tsd-signature-type tsd-kind-interface">LeaseMutationOptions</a>
18
18
  <ul class="tsd-hierarchy">
19
19
  <li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">FailOptions</span></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#L305">src/client-options.ts:305</a></li></ul></aside>
21
+ <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>
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>
@@ -67,25 +67,29 @@
67
67
  <h3 class="tsd-anchor-link" id="error"><code class="tsd-tag">Optional</code><span>error</span><a href="#error" 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>
68
68
  <div class="tsd-signature"><span class="tsd-kind-property">error</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span></div><aside class="tsd-sources">
69
69
  <ul>
70
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L306">src/client-options.ts:306</a></li></ul></aside></section>
70
+ <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>
71
71
  <section class="tsd-panel tsd-member tsd-is-inherited">
72
72
  <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>
73
73
  <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">
74
74
  <p>Inherited from <a href="LeaseMutationOptions.html">LeaseMutationOptions</a>.<a href="LeaseMutationOptions.html#fencingtoken">fencingToken</a></p>
75
75
  <ul>
76
- <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>
76
+ <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>
77
77
  <section class="tsd-panel tsd-member tsd-is-inherited">
78
78
  <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>
79
79
  <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">
80
80
  <p>Inherited from <a href="LeaseMutationOptions.html">LeaseMutationOptions</a>.<a href="LeaseMutationOptions.html#leasetoken">leaseToken</a></p>
81
81
  <ul>
82
- <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>
82
+ <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>
83
83
  <section class="tsd-panel tsd-member tsd-is-inherited">
84
84
  <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>
85
- <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">
85
+ <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>
86
+ <div class="tsd-comment tsd-typography"><p>Explicit client-supplied command timestamp. Omit in production so each
87
+ request samples the current client wall clock; primarily useful for tests.
88
+ This is not the server response time or the client transport deadline.</p>
89
+ </div><aside class="tsd-sources">
86
90
  <p>Inherited from <a href="LeaseMutationOptions.html">LeaseMutationOptions</a>.<a href="LeaseMutationOptions.html#nowms">nowMs</a></p>
87
91
  <ul>
88
- <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>
92
+ <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>
89
93
  <section class="tsd-panel tsd-member tsd-is-inherited">
90
94
  <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>
91
95
  <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">
@@ -109,7 +113,7 @@
109
113
  <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">
110
114
  <p>Inherited from <a href="LeaseMutationOptions.html">LeaseMutationOptions</a>.<a href="LeaseMutationOptions.html#returnrecord">returnRecord</a></p>
111
115
  <ul>
112
- <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>
116
+ <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>
113
117
  <section class="tsd-panel tsd-member tsd-is-inherited">
114
118
  <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>
115
119
  <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">
@@ -120,7 +124,7 @@
120
124
  <h3 class="tsd-anchor-link" id="ttlms"><code class="tsd-tag">Optional</code><span>ttl<wbr/>Ms</span><a href="#ttlms" 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>
121
125
  <div class="tsd-signature"><span class="tsd-kind-property">ttlMs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
122
126
  <ul>
123
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L307">src/client-options.ts:307</a></li></ul></aside></section>
127
+ <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>
124
128
  <section class="tsd-panel tsd-member tsd-is-inherited">
125
129
  <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>
126
130
  <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">
package/docs/api/interfaces/FailOutcome.html CHANGED
@@ -11,14 +11,14 @@
11
11
  <li><a href="" aria-current="page">FailOutcome</a></li></ul>
12
12
  <h1>Interface FailOutcome</h1></div>
13
13
  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">FailOutcome</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="#error">error</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="#kind">kind</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;fail&quot;</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="#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="#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="#ttlms">ttlMs</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="#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="2747">
14
+ <section class="tsd-panel tsd-hierarchy" data-refl="2839">
15
15
  <h4>Hierarchy (<a href="../hierarchy.html#FailOutcome">View Summary</a>)</h4>
16
16
  <ul class="tsd-hierarchy">
17
17
  <li class="tsd-hierarchy-item"><a href="NamedValueMutation.html" class="tsd-signature-type tsd-kind-interface">NamedValueMutation</a>
18
18
  <ul class="tsd-hierarchy">
19
19
  <li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">FailOutcome</span></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/outcomes.ts#L40">src/outcomes.ts:40</a></li></ul></aside>
21
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/outcomes.ts#L64">src/outcomes.ts:64</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>
@@ -46,63 +46,63 @@
46
46
  <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">
47
47
  <p>Inherited from <a href="NamedValueMutation.html">NamedValueMutation</a>.<a href="NamedValueMutation.html#attributesdelete">attributesDelete</a></p>
48
48
  <ul>
49
- <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>
49
+ <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>
50
50
  <section class="tsd-panel tsd-member tsd-is-inherited">
51
51
  <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>
52
52
  <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">
53
53
  <p>Inherited from <a href="NamedValueMutation.html">NamedValueMutation</a>.<a href="NamedValueMutation.html#attributesmerge">attributesMerge</a></p>
54
54
  <ul>
55
- <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>
55
+ <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>
56
56
  <section class="tsd-panel tsd-member tsd-is-inherited">
57
57
  <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>
58
58
  <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">
59
59
  <p>Inherited from <a href="NamedValueMutation.html">NamedValueMutation</a>.<a href="NamedValueMutation.html#dropvalues">dropValues</a></p>
60
60
  <ul>
61
- <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>
61
+ <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>
62
62
  <section class="tsd-panel tsd-member">
63
63
  <h3 class="tsd-anchor-link" id="error"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>error</span><a href="#error" 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">error</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span></div><aside class="tsd-sources">
65
65
  <ul>
66
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/outcomes.ts#L42">src/outcomes.ts:42</a></li></ul></aside></section>
66
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/outcomes.ts#L66">src/outcomes.ts:66</a></li></ul></aside></section>
67
67
  <section class="tsd-panel tsd-member">
68
68
  <h3 class="tsd-anchor-link" id="kind"><code class="tsd-tag">Readonly</code><span>kind</span><a href="#kind" 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">kind</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;fail&quot;</span></div><aside class="tsd-sources">
70
70
  <ul>
71
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/outcomes.ts#L41">src/outcomes.ts:41</a></li></ul></aside></section>
71
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/outcomes.ts#L65">src/outcomes.ts:65</a></li></ul></aside></section>
72
72
  <section class="tsd-panel tsd-member tsd-is-inherited">
73
73
  <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>
74
74
  <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">
75
75
  <p>Inherited from <a href="NamedValueMutation.html">NamedValueMutation</a>.<a href="NamedValueMutation.html#overridevalues">overrideValues</a></p>
76
76
  <ul>
77
- <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>
77
+ <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>
78
78
  <section class="tsd-panel tsd-member">
79
79
  <h3 class="tsd-anchor-link" id="payload"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>payload</span><a href="#payload" 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>
80
80
  <div class="tsd-signature"><span class="tsd-kind-property">payload</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span></div><aside class="tsd-sources">
81
81
  <ul>
82
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/outcomes.ts#L43">src/outcomes.ts:43</a></li></ul></aside></section>
82
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/outcomes.ts#L67">src/outcomes.ts:67</a></li></ul></aside></section>
83
83
  <section class="tsd-panel tsd-member tsd-is-inherited">
84
84
  <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>
85
85
  <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">
86
86
  <p>Inherited from <a href="NamedValueMutation.html">NamedValueMutation</a>.<a href="NamedValueMutation.html#statemeta">stateMeta</a></p>
87
87
  <ul>
88
- <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>
88
+ <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>
89
89
  <section class="tsd-panel tsd-member">
90
90
  <h3 class="tsd-anchor-link" id="ttlms"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>ttl<wbr/>Ms</span><a href="#ttlms" 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>
91
91
  <div class="tsd-signature"><span class="tsd-kind-property">ttlMs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
92
92
  <ul>
93
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/outcomes.ts#L44">src/outcomes.ts:44</a></li></ul></aside></section>
93
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/outcomes.ts#L68">src/outcomes.ts:68</a></li></ul></aside></section>
94
94
  <section class="tsd-panel tsd-member tsd-is-inherited">
95
95
  <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>
96
96
  <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">
97
97
  <p>Inherited from <a href="NamedValueMutation.html">NamedValueMutation</a>.<a href="NamedValueMutation.html#valuerefs">valueRefs</a></p>
98
98
  <ul>
99
- <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>
99
+ <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>
100
100
  <section class="tsd-panel tsd-member tsd-is-inherited">
101
101
  <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>
102
102
  <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">
103
103
  <p>Inherited from <a href="NamedValueMutation.html">NamedValueMutation</a>.<a href="NamedValueMutation.html#values">values</a></p>
104
104
  <ul>
105
- <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>
105
+ <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>
106
106
  <div class="col-sidebar">
107
107
  <div class="page-menu">
108
108
  <div class="tsd-navigation settings">
package/docs/api/interfaces/FerricStoreClientFromUrlOptions.html CHANGED
@@ -11,7 +11,7 @@
11
11
  <li><a href="" aria-current="page">FerricStoreClientFromUrlOptions</a></li></ul>
12
12
  <h1>Interface FerricStoreClientFromUrlOptions</h1></div>
13
13
  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">FerricStoreClientFromUrlOptions</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#autobatch">autoBatch</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">|</span> <a href="AutoBatchOptions.html" class="tsd-signature-type tsd-kind-interface">AutoBatchOptions</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#backpressure">backpressure</a><span class="tsd-signature-symbol">?:</span> <a href="BackpressurePolicy.html" class="tsd-signature-type tsd-kind-interface">BackpressurePolicy</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#codec">codec</a><span class="tsd-signature-symbol">?:</span> <a href="Codec.html" class="tsd-signature-type tsd-kind-interface">Codec</a><span class="tsd-signature-symbol">&lt;</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="#flowmanybatchlimit">flowManyBatchLimit</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="#httpoptions">httpOptions</a><span class="tsd-signature-symbol">?:</span> <a href="HTTPAdapterOptions.html" class="tsd-signature-type tsd-kind-interface">HTTPAdapterOptions</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#legacyclaimhydrationconcurrency">legacyClaimHydrationConcurrency</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="#nativeoptions">nativeOptions</a><span class="tsd-signature-symbol">?:</span> <a href="NativeClientOptions.html" class="tsd-signature-type tsd-kind-interface">NativeClientOptions</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#reconnect">reconnect</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">|</span> <a href="ReconnectOptions.html" class="tsd-signature-type tsd-kind-interface">ReconnectOptions</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
14
- <section class="tsd-panel tsd-hierarchy" data-refl="1659">
14
+ <section class="tsd-panel tsd-hierarchy" data-refl="1681">
15
15
  <h4>Hierarchy (<a href="../hierarchy.html#FerricStoreClientFromUrlOptions">View Summary</a>)</h4>
16
16
  <ul class="tsd-hierarchy">
17
17
  <li class="tsd-hierarchy-item"><a href="FerricStoreClientOptions.html" class="tsd-signature-type tsd-kind-interface">FerricStoreClientOptions</a>
package/docs/api/interfaces/FerricStoreClientOptions.html CHANGED
@@ -11,7 +11,7 @@
11
11
  <li><a href="" aria-current="page">FerricStoreClientOptions</a></li></ul>
12
12
  <h1>Interface FerricStoreClientOptions</h1></div>
13
13
  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">FerricStoreClientOptions</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#autobatch">autoBatch</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">|</span> <a href="AutoBatchOptions.html" class="tsd-signature-type tsd-kind-interface">AutoBatchOptions</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#backpressure">backpressure</a><span class="tsd-signature-symbol">?:</span> <a href="BackpressurePolicy.html" class="tsd-signature-type tsd-kind-interface">BackpressurePolicy</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#codec">codec</a><span class="tsd-signature-symbol">?:</span> <a href="Codec.html" class="tsd-signature-type tsd-kind-interface">Codec</a><span class="tsd-signature-symbol">&lt;</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="#flowmanybatchlimit">flowManyBatchLimit</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="#legacyclaimhydrationconcurrency">legacyClaimHydrationConcurrency</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="1668">
14
+ <section class="tsd-panel tsd-hierarchy" data-refl="1690">
15
15
  <h4>Hierarchy (<a href="../hierarchy.html#FerricStoreClientOptions">View Summary</a>)</h4>
16
16
  <ul class="tsd-hierarchy">
17
17
  <li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">FerricStoreClientOptions</span>
package/docs/api/interfaces/FlowQueryCountResult.html CHANGED
@@ -11,7 +11,7 @@
11
11
  <li><a href="" aria-current="page">FlowQueryCountResult</a></li></ul>
12
12
  <h1>Interface FlowQueryCountResult</h1></div>
13
13
  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">FlowQueryCountResult</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#count">count</a><span class="tsd-signature-symbol">:</span> <a href="../types/FlowQueryInteger.html" class="tsd-signature-type tsd-kind-type-alias">FlowQueryInteger</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#kind">kind</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;count&quot;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#quality">quality</a><span class="tsd-signature-symbol">:</span> <a href="FlowQueryQuality.html" class="tsd-signature-type tsd-kind-interface">FlowQueryQuality</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#raw">raw</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</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">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#usage">usage</a><span class="tsd-signature-symbol">:</span> <a href="FlowQueryUsage.html" class="tsd-signature-type tsd-kind-interface">FlowQueryUsage</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#version">version</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;ferric.flow.query.result/v1&quot;</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
14
- <section class="tsd-panel tsd-hierarchy" data-refl="2066">
14
+ <section class="tsd-panel tsd-hierarchy" data-refl="2110">
15
15
  <h4>Hierarchy</h4>
16
16
  <ul class="tsd-hierarchy">
17
17
  <li class="tsd-hierarchy-item"><span class="tsd-signature-type">FlowQueryResultBase</span>
package/docs/api/interfaces/FlowQueryIndexBuild.html CHANGED
@@ -11,7 +11,7 @@
11
11
  <li><a href="" aria-current="page">FlowQueryIndexBuild</a></li></ul>
12
12
  <h1>Interface FlowQueryIndexBuild</h1></div>
13
13
  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">FlowQueryIndexBuild</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#completedshards">completedShards</a><span class="tsd-signature-symbol">:</span> <a href="../types/FlowQueryInteger.html" class="tsd-signature-type tsd-kind-type-alias">FlowQueryInteger</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#currentphases">currentPhases</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="#phasecounts">phaseCounts</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</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/FlowQueryInteger.html" class="tsd-signature-type tsd-kind-type-alias">FlowQueryInteger</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#raw">raw</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</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">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#scannedrecords">scannedRecords</a><span class="tsd-signature-symbol">:</span> <a href="../types/FlowQueryInteger.html" class="tsd-signature-type tsd-kind-type-alias">FlowQueryInteger</a><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">&quot;catalog_build&quot;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#totalshards">totalShards</a><span class="tsd-signature-symbol">:</span> <a href="../types/FlowQueryInteger.html" class="tsd-signature-type tsd-kind-type-alias">FlowQueryInteger</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#writtenbytes">writtenBytes</a><span class="tsd-signature-symbol">:</span> <a href="../types/FlowQueryInteger.html" class="tsd-signature-type tsd-kind-type-alias">FlowQueryInteger</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#writtenentries">writtenEntries</a><span class="tsd-signature-symbol">:</span> <a href="../types/FlowQueryInteger.html" class="tsd-signature-type tsd-kind-type-alias">FlowQueryInteger</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
14
- <section class="tsd-panel tsd-hierarchy" data-refl="2095">
14
+ <section class="tsd-panel tsd-hierarchy" data-refl="2139">
15
15
  <h4>Hierarchy (<a href="../hierarchy.html#FlowQueryIndexBuild">View Summary</a>)</h4>
16
16
  <ul class="tsd-hierarchy">
17
17
  <li class="tsd-hierarchy-item"><a href="FlowQueryIndexProgress.html" class="tsd-signature-type tsd-kind-interface">FlowQueryIndexProgress</a>
package/docs/api/interfaces/FlowQueryIndexProgress.html CHANGED
@@ -11,7 +11,7 @@
11
11
  <li><a href="" aria-current="page">FlowQueryIndexProgress</a></li></ul>
12
12
  <h1>Interface FlowQueryIndexProgress</h1></div>
13
13
  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">FlowQueryIndexProgress</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#completedshards">completedShards</a><span class="tsd-signature-symbol">:</span> <a href="../types/FlowQueryInteger.html" class="tsd-signature-type tsd-kind-type-alias">FlowQueryInteger</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#currentphases">currentPhases</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="#phasecounts">phaseCounts</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</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/FlowQueryInteger.html" class="tsd-signature-type tsd-kind-type-alias">FlowQueryInteger</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#raw">raw</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</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">&gt;</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">&quot;catalog_build&quot;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#totalshards">totalShards</a><span class="tsd-signature-symbol">:</span> <a href="../types/FlowQueryInteger.html" class="tsd-signature-type tsd-kind-type-alias">FlowQueryInteger</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
14
- <section class="tsd-panel tsd-hierarchy" data-refl="2123">
14
+ <section class="tsd-panel tsd-hierarchy" data-refl="2167">
15
15
  <h4>Hierarchy (<a href="../hierarchy.html#FlowQueryIndexProgress">View Summary</a>)</h4>
16
16
  <ul class="tsd-hierarchy">
17
17
  <li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">FlowQueryIndexProgress</span>
package/docs/api/interfaces/FlowQueryIndexValidation.html CHANGED
@@ -11,7 +11,7 @@
11
11
  <li><a href="" aria-current="page">FlowQueryIndexValidation</a></li></ul>
12
12
  <h1>Interface FlowQueryIndexValidation</h1></div>
13
13
  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">FlowQueryIndexValidation</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#checkedentries">checkedEntries</a><span class="tsd-signature-symbol">:</span> <a href="../types/FlowQueryInteger.html" class="tsd-signature-type tsd-kind-type-alias">FlowQueryInteger</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#checkedrecords">checkedRecords</a><span class="tsd-signature-symbol">:</span> <a href="../types/FlowQueryInteger.html" class="tsd-signature-type tsd-kind-type-alias">FlowQueryInteger</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#completedshards">completedShards</a><span class="tsd-signature-symbol">:</span> <a href="../types/FlowQueryInteger.html" class="tsd-signature-type tsd-kind-type-alias">FlowQueryInteger</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#currentphases">currentPhases</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="#failurereason">failureReason</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="#mismatches">mismatches</a><span class="tsd-signature-symbol">:</span> <a href="../types/FlowQueryInteger.html" class="tsd-signature-type tsd-kind-type-alias">FlowQueryInteger</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#phasecounts">phaseCounts</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</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/FlowQueryInteger.html" class="tsd-signature-type tsd-kind-type-alias">FlowQueryInteger</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#raw">raw</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</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">&gt;</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">&quot;catalog_build&quot;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#status">status</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;pending&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;passed&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;failed&quot;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#totalshards">totalShards</a><span class="tsd-signature-symbol">:</span> <a href="../types/FlowQueryInteger.html" class="tsd-signature-type tsd-kind-type-alias">FlowQueryInteger</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#validatedatms">validatedAtMs</a><span class="tsd-signature-symbol">?:</span> <a href="../types/FlowQueryInteger.html" class="tsd-signature-type tsd-kind-type-alias">FlowQueryInteger</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
14
- <section class="tsd-panel tsd-hierarchy" data-refl="2169">
14
+ <section class="tsd-panel tsd-hierarchy" data-refl="2213">
15
15
  <h4>Hierarchy (<a href="../hierarchy.html#FlowQueryIndexValidation">View Summary</a>)</h4>
16
16
  <ul class="tsd-hierarchy">
17
17
  <li class="tsd-hierarchy-item"><a href="FlowQueryIndexProgress.html" class="tsd-signature-type tsd-kind-interface">FlowQueryIndexProgress</a>
package/docs/api/interfaces/FlowQueryRecordsResult.html CHANGED
@@ -11,7 +11,7 @@
11
11
  <li><a href="" aria-current="page">FlowQueryRecordsResult</a></li></ul>
12
12
  <h1>Interface FlowQueryRecordsResult</h1></div>
13
13
  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">FlowQueryRecordsResult</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#kind">kind</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;records&quot;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#page">page</a><span class="tsd-signature-symbol">:</span> <a href="FlowQueryPage.html" class="tsd-signature-type tsd-kind-interface">FlowQueryPage</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#quality">quality</a><span class="tsd-signature-symbol">:</span> <a href="FlowQueryQuality.html" class="tsd-signature-type tsd-kind-interface">FlowQueryQuality</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#raw">raw</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</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">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#records">records</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">readonly</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</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">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#usage">usage</a><span class="tsd-signature-symbol">:</span> <a href="FlowQueryUsage.html" class="tsd-signature-type tsd-kind-interface">FlowQueryUsage</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#version">version</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;ferric.flow.query.result/v1&quot;</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
14
- <section class="tsd-panel tsd-hierarchy" data-refl="2193">
14
+ <section class="tsd-panel tsd-hierarchy" data-refl="2237">
15
15
  <h4>Hierarchy</h4>
16
16
  <ul class="tsd-hierarchy">
17
17
  <li class="tsd-hierarchy-item"><span class="tsd-signature-type">FlowQueryResultBase</span>