@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.
- package/README.md +45 -3
- package/dist/index.cjs +804 -198
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +87 -9
- package/dist/index.d.ts +87 -9
- package/dist/index.js +798 -194
- package/dist/index.js.map +1 -1
- package/dist/langgraph.cjs.map +1 -1
- package/dist/langgraph.d.cts +1 -1
- package/dist/langgraph.d.ts +1 -1
- package/dist/langgraph.js.map +1 -1
- package/dist/openai-agents.cjs.map +1 -1
- package/dist/openai-agents.js.map +1 -1
- package/dist/{outcomes-DmBwnq0Y.d.cts → outcomes-CcX956h4.d.cts} +20 -1
- package/dist/{outcomes-BbFDp3AH.d.ts → outcomes-DLJYTrX8.d.ts} +20 -1
- package/docs/api/assets/hierarchy.js +1 -1
- package/docs/api/assets/highlight.css +9 -2
- package/docs/api/assets/navigation.js +1 -1
- package/docs/api/assets/search.js +1 -1
- package/docs/api/classes/ConnectionClosedError.html +5 -5
- package/docs/api/classes/FerricStoreClient.html +68 -23
- package/docs/api/classes/FerricStoreError.html +2 -1
- package/docs/api/classes/FlowAlreadyExistsError.html +3 -3
- package/docs/api/classes/FlowBatchError.html +1 -1
- package/docs/api/classes/FlowNotFoundError.html +3 -3
- package/docs/api/classes/FlowQueryError.html +1 -1
- package/docs/api/classes/FlowWrongStateError.html +3 -3
- package/docs/api/classes/HTTPTransportError.html +14 -8
- package/docs/api/classes/InvalidCommandError.html +3 -3
- package/docs/api/classes/LeaseRenewalError.html +3 -3
- package/docs/api/classes/LockHeldError.html +3 -3
- package/docs/api/classes/LockNotOwnedError.html +3 -3
- package/docs/api/classes/NativeAdapter.html +3 -3
- package/docs/api/classes/OverloadedError.html +5 -5
- package/docs/api/classes/QueueCompletionError.html +1 -1
- package/docs/api/classes/RequestNotSentError.html +225 -0
- package/docs/api/classes/RequestTimeoutError.html +6 -6
- package/docs/api/classes/RerouteError.html +3 -3
- package/docs/api/classes/StaleLeaseError.html +3 -3
- package/docs/api/classes/StalePolicyGenerationError.html +3 -3
- package/docs/api/classes/Workflow.html +19 -19
- package/docs/api/classes/WorkflowClient.html +4 -4
- package/docs/api/classes/WorkflowContext.html +73 -37
- package/docs/api/classes/WorkflowFlowCommands.html +26 -22
- package/docs/api/classes/WorkflowWorker.html +6 -6
- package/docs/api/functions/classifyServerError.html +1 -1
- package/docs/api/functions/complete.html +1 -1
- package/docs/api/functions/fail.html +1 -1
- package/docs/api/functions/isAlreadyAppliedOutcome.html +41 -0
- package/docs/api/functions/isOutcome.html +1 -1
- package/docs/api/functions/mapException.html +1 -1
- package/docs/api/functions/retry.html +1 -1
- package/docs/api/functions/transition.html +1 -1
- package/docs/api/hierarchy.html +56 -47
- package/docs/api/index.html +32 -4
- package/docs/api/interfaces/AdminListOptions.html +1 -1
- package/docs/api/interfaces/AdvanceOptions.html +145 -0
- package/docs/api/interfaces/AlreadyAppliedOutcome.html +69 -0
- package/docs/api/interfaces/AppliedStepOutcome.html +87 -0
- package/docs/api/interfaces/CancelOptions.html +13 -9
- package/docs/api/interfaces/CompleteOptions.html +13 -9
- package/docs/api/interfaces/CompleteOutcome.html +13 -13
- package/docs/api/interfaces/CreateManyOptions.html +1 -1
- package/docs/api/interfaces/EffectCompensateOptions.html +1 -1
- package/docs/api/interfaces/EffectConfirmOptions.html +1 -1
- package/docs/api/interfaces/EffectFailOptions.html +1 -1
- package/docs/api/interfaces/EffectStatusOptions.html +1 -1
- package/docs/api/interfaces/ExtendLeaseOptions.html +10 -8
- package/docs/api/interfaces/FailOptions.html +13 -9
- package/docs/api/interfaces/FailOutcome.html +13 -13
- package/docs/api/interfaces/FerricStoreClientFromUrlOptions.html +1 -1
- package/docs/api/interfaces/FerricStoreClientOptions.html +1 -1
- package/docs/api/interfaces/FlowQueryCountResult.html +1 -1
- package/docs/api/interfaces/FlowQueryIndexBuild.html +1 -1
- package/docs/api/interfaces/FlowQueryIndexProgress.html +1 -1
- package/docs/api/interfaces/FlowQueryIndexValidation.html +1 -1
- package/docs/api/interfaces/FlowQueryRecordsResult.html +1 -1
- package/docs/api/interfaces/HistoryOptions.html +16 -16
- package/docs/api/interfaces/InvocationCreateOptions.html +1 -1
- package/docs/api/interfaces/LeaseMutationOptions.html +11 -7
- package/docs/api/interfaces/LimitListOptions.html +1 -1
- package/docs/api/interfaces/MutateOptions.html +8 -4
- package/docs/api/interfaces/NamedValueMutation.html +9 -9
- package/docs/api/interfaces/ReadOptions.html +12 -12
- package/docs/api/interfaces/ReclaimOptions.html +1 -1
- package/docs/api/interfaces/ReplayedStepResult.html +73 -0
- package/docs/api/interfaces/RequestContextOptions.html +1 -1
- package/docs/api/interfaces/RetryOptions.html +13 -9
- package/docs/api/interfaces/RetryOutcome.html +13 -13
- package/docs/api/interfaces/RunStepsItem.html +3 -3
- package/docs/api/interfaces/RunStepsManyOptions.html +11 -11
- package/docs/api/interfaces/SearchOptions.html +13 -13
- package/docs/api/interfaces/StepContinueOptions.html +16 -12
- package/docs/api/interfaces/StepOptions.html +166 -0
- package/docs/api/interfaces/StepResult.html +67 -0
- package/docs/api/interfaces/TDigestCreateOptions.html +1 -1
- package/docs/api/interfaces/TDigestMergeOptions.html +1 -1
- package/docs/api/interfaces/TransitionOptions.html +15 -11
- package/docs/api/interfaces/TransitionOutcome.html +14 -14
- package/docs/api/media/design.md +12 -1
- package/docs/api/modules.html +8 -8
- package/docs/api/types/ConnectionRequestDisposition.html +1 -1
- package/docs/api/types/ManagementPairs.html +1 -1
- package/docs/api/types/Outcome.html +1 -1
- package/docs/api/types/RequestDisposition.html +1 -1
- package/docs/api/types/SearchStateMeta.html +1 -1
- package/docs/api/types/WorkflowStepResult.html +38 -0
- package/docs/api/variables/FERRICSTORE_SDK_VERSION.html +1 -1
- package/docs/design.md +12 -1
- package/package.json +1 -1
package/docs/api/hierarchy.html
CHANGED
|
@@ -10,14 +10,22 @@
|
|
|
10
10
|
<h1>@ferricstore/ferricstore</h1></div>
|
|
11
11
|
<h2>Hierarchy Summary</h2>
|
|
12
12
|
<ul class="tsd-full-hierarchy">
|
|
13
|
-
<li data-refl="
|
|
13
|
+
<li data-refl="1454" id="AdminListOptions"><a href="interfaces/AdminListOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>AdminListOptions</a>
|
|
14
14
|
<ul>
|
|
15
|
-
<li data-refl="
|
|
15
|
+
<li data-refl="1758" id="LimitListOptions"><a href="interfaces/LimitListOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>LimitListOptions</a></li></ul></li></ul>
|
|
16
16
|
<ul class="tsd-full-hierarchy">
|
|
17
|
-
<li data-refl="
|
|
17
|
+
<li data-refl="1458" id="AdvanceOptions"><a href="interfaces/AdvanceOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>AdvanceOptions</a>
|
|
18
18
|
<ul>
|
|
19
|
-
<li data-refl="
|
|
20
|
-
<
|
|
19
|
+
<li data-refl="1964" id="StepOptions"><a href="interfaces/StepOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>StepOptions</a></li></ul></li></ul>
|
|
20
|
+
<ul class="tsd-full-hierarchy">
|
|
21
|
+
<li data-refl="2811" id="AlreadyAppliedOutcome"><a href="interfaces/AlreadyAppliedOutcome.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>AlreadyAppliedOutcome</a>
|
|
22
|
+
<ul>
|
|
23
|
+
<li data-refl="2814" id="AppliedStepOutcome"><a href="interfaces/AppliedStepOutcome.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>AppliedStepOutcome</a></li></ul></li></ul>
|
|
24
|
+
<ul class="tsd-full-hierarchy">
|
|
25
|
+
<li data-refl="2043" id="Codec"><a href="interfaces/Codec.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>Codec</a>
|
|
26
|
+
<ul>
|
|
27
|
+
<li data-refl="2023" id="JsonCodec"><a href="classes/JsonCodec.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>JsonCodec</a></li>
|
|
28
|
+
<li data-refl="2034" id="RawCodec"><a href="classes/RawCodec.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>RawCodec</a></li></ul></li></ul>
|
|
21
29
|
<ul class="tsd-full-hierarchy">
|
|
22
30
|
<li data-refl="155" id="CommandExecutor"><a href="interfaces/CommandExecutor.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>CommandExecutor</a>
|
|
23
31
|
<ul>
|
|
@@ -26,55 +34,56 @@
|
|
|
26
34
|
<li data-refl="300" id="ReconnectingExecutor"><a href="classes/ReconnectingExecutor.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>ReconnectingExecutor</a></li>
|
|
27
35
|
<li data-refl="387" id="TopologyNativeAdapterPool"><a href="classes/TopologyNativeAdapterPool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>TopologyNativeAdapterPool</a></li></ul></li></ul>
|
|
28
36
|
<ul class="tsd-full-hierarchy">
|
|
29
|
-
<li data-refl="
|
|
37
|
+
<li data-refl="1653" id="EffectStatusOptions"><a href="interfaces/EffectStatusOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>EffectStatusOptions</a>
|
|
30
38
|
<ul>
|
|
31
|
-
<li data-refl="
|
|
32
|
-
<li data-refl="
|
|
33
|
-
<li data-refl="
|
|
39
|
+
<li data-refl="1623" id="EffectCompensateOptions"><a href="interfaces/EffectCompensateOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>EffectCompensateOptions</a></li>
|
|
40
|
+
<li data-refl="1630" id="EffectConfirmOptions"><a href="interfaces/EffectConfirmOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>EffectConfirmOptions</a></li>
|
|
41
|
+
<li data-refl="1637" id="EffectFailOptions"><a href="interfaces/EffectFailOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>EffectFailOptions</a></li></ul></li></ul>
|
|
34
42
|
<ul class="tsd-full-hierarchy">
|
|
35
|
-
<li data-refl="
|
|
43
|
+
<li data-refl="1690" id="FerricStoreClientOptions"><a href="interfaces/FerricStoreClientOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>FerricStoreClientOptions</a>
|
|
36
44
|
<ul>
|
|
37
|
-
<li data-refl="
|
|
45
|
+
<li data-refl="1681" id="FerricStoreClientFromUrlOptions"><a href="interfaces/FerricStoreClientFromUrlOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>FerricStoreClientFromUrlOptions</a></li></ul></li></ul>
|
|
38
46
|
<ul class="tsd-full-hierarchy">
|
|
39
|
-
<li data-refl="
|
|
47
|
+
<li data-refl="2371" id="FerricStoreError"><a href="classes/FerricStoreError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>FerricStoreError</a>
|
|
40
48
|
<ul>
|
|
41
49
|
<li data-refl="497" id="ClaimHydrationError"><a href="classes/ClaimHydrationError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>ClaimHydrationError</a></li>
|
|
42
|
-
<li data-refl="
|
|
43
|
-
<li data-refl="
|
|
44
|
-
<li data-refl="
|
|
45
|
-
<li data-refl="
|
|
46
|
-
<li data-refl="
|
|
47
|
-
<li data-refl="
|
|
48
|
-
<li data-refl="
|
|
49
|
-
<li data-refl="
|
|
50
|
-
<li data-refl="
|
|
51
|
-
<li data-refl="
|
|
52
|
-
<li data-refl="
|
|
53
|
-
<li data-refl="
|
|
54
|
-
<li data-refl="
|
|
55
|
-
<li data-refl="
|
|
56
|
-
<li data-refl="
|
|
50
|
+
<li data-refl="1427" id="FlowBatchError"><a href="classes/FlowBatchError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>FlowBatchError</a></li>
|
|
51
|
+
<li data-refl="2051" id="FlowQueryError"><a href="classes/FlowQueryError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>FlowQueryError</a></li>
|
|
52
|
+
<li data-refl="2343" id="ConnectionClosedError"><a href="classes/ConnectionClosedError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>ConnectionClosedError</a></li>
|
|
53
|
+
<li data-refl="2400" id="HTTPTransportError"><a href="classes/HTTPTransportError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>HTTPTransportError</a></li>
|
|
54
|
+
<li data-refl="2434" id="FlowAlreadyExistsError"><a href="classes/FlowAlreadyExistsError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>FlowAlreadyExistsError</a></li>
|
|
55
|
+
<li data-refl="2463" id="FlowNotFoundError"><a href="classes/FlowNotFoundError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>FlowNotFoundError</a></li>
|
|
56
|
+
<li data-refl="2492" id="FlowWrongStateError"><a href="classes/FlowWrongStateError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>FlowWrongStateError</a></li>
|
|
57
|
+
<li data-refl="2521" id="InvalidCommandError"><a href="classes/InvalidCommandError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>InvalidCommandError</a></li>
|
|
58
|
+
<li data-refl="2550" id="LockHeldError"><a href="classes/LockHeldError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>LockHeldError</a></li>
|
|
59
|
+
<li data-refl="2579" id="LockNotOwnedError"><a href="classes/LockNotOwnedError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>LockNotOwnedError</a></li>
|
|
60
|
+
<li data-refl="2608" id="OverloadedError"><a href="classes/OverloadedError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>OverloadedError</a></li>
|
|
61
|
+
<li data-refl="2639" id="RequestNotSentError"><a href="classes/RequestNotSentError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>RequestNotSentError</a></li>
|
|
62
|
+
<li data-refl="2666" id="RequestTimeoutError"><a href="classes/RequestTimeoutError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>RequestTimeoutError</a></li>
|
|
63
|
+
<li data-refl="2695" id="RerouteError"><a href="classes/RerouteError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>RerouteError</a></li>
|
|
64
|
+
<li data-refl="2724" id="StaleLeaseError"><a href="classes/StaleLeaseError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>StaleLeaseError</a></li>
|
|
65
|
+
<li data-refl="2753" id="StalePolicyGenerationError"><a href="classes/StalePolicyGenerationError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>StalePolicyGenerationError</a></li></ul></li></ul>
|
|
57
66
|
<ul class="tsd-full-hierarchy">
|
|
58
|
-
<li data-refl="
|
|
67
|
+
<li data-refl="2167" id="FlowQueryIndexProgress"><a href="interfaces/FlowQueryIndexProgress.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>FlowQueryIndexProgress</a>
|
|
59
68
|
<ul>
|
|
60
|
-
<li data-refl="
|
|
61
|
-
<li data-refl="
|
|
69
|
+
<li data-refl="2139" id="FlowQueryIndexBuild"><a href="interfaces/FlowQueryIndexBuild.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>FlowQueryIndexBuild</a></li>
|
|
70
|
+
<li data-refl="2213" id="FlowQueryIndexValidation"><a href="interfaces/FlowQueryIndexValidation.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>FlowQueryIndexValidation</a></li></ul></li></ul>
|
|
62
71
|
<ul class="tsd-full-hierarchy">
|
|
63
|
-
<li data-refl="
|
|
72
|
+
<li data-refl="1782" id="MutateOptions"><a href="interfaces/MutateOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>MutateOptions</a>
|
|
64
73
|
<ul>
|
|
65
|
-
<li data-refl="
|
|
74
|
+
<li data-refl="1767" id="LeaseMutationOptions"><a href="interfaces/LeaseMutationOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>LeaseMutationOptions</a>
|
|
66
75
|
<ul>
|
|
67
|
-
<li data-refl="
|
|
68
|
-
<li data-refl="
|
|
69
|
-
<li data-refl="
|
|
70
|
-
<li data-refl="
|
|
76
|
+
<li data-refl="1568" id="CompleteOptions"><a href="interfaces/CompleteOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>CompleteOptions</a></li>
|
|
77
|
+
<li data-refl="1665" id="FailOptions"><a href="interfaces/FailOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>FailOptions</a></li>
|
|
78
|
+
<li data-refl="1826" id="RetryOptions"><a href="interfaces/RetryOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>RetryOptions</a></li>
|
|
79
|
+
<li data-refl="2005" id="TransitionOptions"><a href="interfaces/TransitionOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>TransitionOptions</a></li></ul></li></ul></li></ul>
|
|
71
80
|
<ul class="tsd-full-hierarchy">
|
|
72
|
-
<li data-refl="
|
|
81
|
+
<li data-refl="2851" id="NamedValueMutation"><a href="interfaces/NamedValueMutation.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>NamedValueMutation</a>
|
|
73
82
|
<ul>
|
|
74
|
-
<li data-refl="
|
|
75
|
-
<li data-refl="
|
|
76
|
-
<li data-refl="
|
|
77
|
-
<li data-refl="
|
|
83
|
+
<li data-refl="2827" id="CompleteOutcome"><a href="interfaces/CompleteOutcome.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>CompleteOutcome</a></li>
|
|
84
|
+
<li data-refl="2839" id="FailOutcome"><a href="interfaces/FailOutcome.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>FailOutcome</a></li>
|
|
85
|
+
<li data-refl="2860" id="RetryOutcome"><a href="interfaces/RetryOutcome.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>RetryOutcome</a></li>
|
|
86
|
+
<li data-refl="2872" id="TransitionOutcome"><a href="interfaces/TransitionOutcome.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>TransitionOutcome</a></li></ul></li></ul>
|
|
78
87
|
<ul class="tsd-full-hierarchy">
|
|
79
88
|
<li data-refl="182" id="NativeAdapterOptions"><a href="interfaces/NativeAdapterOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>NativeAdapterOptions</a>
|
|
80
89
|
<ul>
|
|
@@ -82,17 +91,17 @@
|
|
|
82
91
|
<ul>
|
|
83
92
|
<li data-refl="206" id="NativeClientOptions"><a href="interfaces/NativeClientOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>NativeClientOptions</a></li></ul></li></ul></li></ul>
|
|
84
93
|
<ul class="tsd-full-hierarchy">
|
|
85
|
-
<li data-refl="
|
|
94
|
+
<li data-refl="1794" id="ReadOptions"><a href="interfaces/ReadOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>ReadOptions</a>
|
|
86
95
|
<ul>
|
|
87
|
-
<li data-refl="
|
|
96
|
+
<li data-refl="1933" id="SearchOptions"><a href="interfaces/SearchOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>SearchOptions</a></li></ul></li></ul>
|
|
88
97
|
<ul class="tsd-full-hierarchy">
|
|
89
|
-
<li data-refl="
|
|
98
|
+
<li data-refl="1824" id="RequestContextOptions"><a href="interfaces/RequestContextOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>RequestContextOptions</a>
|
|
90
99
|
<ul>
|
|
91
|
-
<li data-refl="
|
|
100
|
+
<li data-refl="1744" id="InvocationCreateOptions"><a href="interfaces/InvocationCreateOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>InvocationCreateOptions</a></li></ul></li></ul>
|
|
92
101
|
<ul class="tsd-full-hierarchy">
|
|
93
|
-
<li data-refl="
|
|
102
|
+
<li data-refl="3309" id="TDigestCreateOptions"><a href="interfaces/TDigestCreateOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>TDigestCreateOptions</a>
|
|
94
103
|
<ul>
|
|
95
|
-
<li data-refl="
|
|
104
|
+
<li data-refl="3311" id="TDigestMergeOptions"><a href="interfaces/TDigestMergeOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>TDigestMergeOptions</a></li></ul></li></ul></div>
|
|
96
105
|
<div class="col-sidebar">
|
|
97
106
|
<div class="page-menu">
|
|
98
107
|
<div class="tsd-navigation settings">
|
package/docs/api/index.html
CHANGED
|
@@ -31,7 +31,7 @@ The generated
|
|
|
31
31
|
<a href="https://unpkg.com/@ferricstore/ferricstore/docs/agent-api/modules.html">agent framework API reference</a>
|
|
32
32
|
covers every public adapter class and option.</p>
|
|
33
33
|
<h2 id="compatibility" class="tsd-anchor-link">Compatibility<a href="#compatibility" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2>
|
|
34
|
-
<p>TypeScript SDK <code>0.
|
|
34
|
+
<p>TypeScript SDK <code>0.13.1</code> requires FerricStore server <code>0.11.4</code> or newer. With
|
|
35
35
|
FerricStore 0.11.11 it negotiates compact Stream mode 34 for homogeneous auto-ID
|
|
36
36
|
<code>XADD</code> pipelines and compact Pub/Sub mode 35 for homogeneous <code>PUBLISH</code>
|
|
37
37
|
pipelines. Native wire protocol v1 and the generic fallback are unchanged.
|
|
@@ -47,7 +47,7 @@ a server version table.</p>
|
|
|
47
47
|
</code><button type="button">Copy</button></pre>
|
|
48
48
|
|
|
49
49
|
<h2 id="run-ferricstore-locally" class="tsd-anchor-link">Run FerricStore Locally<a href="#run-ferricstore-locally" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2>
|
|
50
|
-
<pre><code class="bash"><span class="hl-0">docker</span><span class="hl-1"> </span><span class="hl-2">run</span><span class="hl-1"> </span><span class="hl-6">-p</span><span class="hl-1"> </span><span class="hl-2">6388:6388</span><span class="hl-1"> </span><span class="hl-8">\</span><br/><span class="hl-1"> </span><span class="hl-6">-e</span><span class="hl-1"> </span><span class="hl-2">FERRICSTORE_PROTECTED_MODE=</span><span class="hl-6">false</span><span class="hl-1"> </span><span class="hl-8">\</span><br/><span class="hl-1"> </span><span class="hl-6">-v</span><span class="hl-1"> </span><span class="hl-2">ferricstore_data:/data</span><span class="hl-1"> </span><span class="hl-8">\</span><br/><span class="hl-1"> </span><span class="hl-2">quay.io/ferricstore/ferricstore:0.11.
|
|
50
|
+
<pre><code class="bash"><span class="hl-0">docker</span><span class="hl-1"> </span><span class="hl-2">run</span><span class="hl-1"> </span><span class="hl-6">-p</span><span class="hl-1"> </span><span class="hl-2">6388:6388</span><span class="hl-1"> </span><span class="hl-8">\</span><br/><span class="hl-1"> </span><span class="hl-6">-e</span><span class="hl-1"> </span><span class="hl-2">FERRICSTORE_PROTECTED_MODE=</span><span class="hl-6">false</span><span class="hl-1"> </span><span class="hl-8">\</span><br/><span class="hl-1"> </span><span class="hl-6">-v</span><span class="hl-1"> </span><span class="hl-2">ferricstore_data:/data</span><span class="hl-1"> </span><span class="hl-8">\</span><br/><span class="hl-1"> </span><span class="hl-2">quay.io/ferricstore/ferricstore:0.11.14@sha256:f7d29befefa15bce4b3755bf786cf7620c814f13bbd336c0d9955581b323b60e</span>
|
|
51
51
|
</code><button type="button">Copy</button></pre>
|
|
52
52
|
|
|
53
53
|
<h2 id="query-durable-runs" class="tsd-anchor-link">Query durable runs<a href="#query-durable-runs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2>
|
|
@@ -97,7 +97,7 @@ trust. Use <code>ferric://</code> or <code>ferrics://</code> whenever connection
|
|
|
97
97
|
required.</p>
|
|
98
98
|
<p>Run the complete HTTP-compatible integration surface through a real TLS
|
|
99
99
|
listener with ACL authentication using:</p>
|
|
100
|
-
<pre><code class="bash"><span class="hl-5">FERRICSTORE_IMAGE</span><span class="hl-1">=</span><span class="hl-2">quay.io/ferricstore/ferricstore:0.11.
|
|
100
|
+
<pre><code class="bash"><span class="hl-5">FERRICSTORE_IMAGE</span><span class="hl-1">=</span><span class="hl-2">quay.io/ferricstore/ferricstore:0.11.14@sha256:f7d29befefa15bce4b3755bf786cf7620c814f13bbd336c0d9955581b323b60e</span><span class="hl-1"> </span><span class="hl-0">\</span><br/><span class="hl-1"> </span><span class="hl-2">npm</span><span class="hl-1"> </span><span class="hl-2">run</span><span class="hl-1"> </span><span class="hl-2">test:integration:http</span>
|
|
101
101
|
</code><button type="button">Copy</button></pre>
|
|
102
102
|
|
|
103
103
|
<p>The runner creates a private CA, verifies that unauthenticated access and a
|
|
@@ -151,6 +151,11 @@ unclassified failures are treated conservatively as possibly sent.
|
|
|
151
151
|
timeouts while waiting for a local flow-control or write-queue slot are
|
|
152
152
|
<code>"unsent"</code>, while a request whose frame entered the socket is
|
|
153
153
|
<code>"possibly_sent"</code>. Do not automatically retry a possibly-sent mutation.
|
|
154
|
+
HTTP <code>408</code> responses, truncated responses, stream resets, and other failures
|
|
155
|
+
after dispatch are also treated as uncertain even if an intermediary labels
|
|
156
|
+
them retry-safe. Local HTTP validation, encoding, size-limit, closed-client,
|
|
157
|
+
and unsupported-command failures are marked <code>"unsent"</code> and perform no network
|
|
158
|
+
exchange.
|
|
154
159
|
<code>autoReconnect</code> accepts <code>maxRetries</code>, <code>baseDelayMs</code>, <code>maxDelayMs</code>, and
|
|
155
160
|
<code>jitterPct</code>; backoff is applied only after a reconnect attempt itself fails.</p>
|
|
156
161
|
<p>Topology-aware clients retry one routed command or one physical fused pipeline
|
|
@@ -218,6 +223,29 @@ socket writes still go directly to <code>socket.write</code> without entering th
|
|
|
218
223
|
<li><code>fail({ error })</code></li>
|
|
219
224
|
</ul>
|
|
220
225
|
<p>FerricFlow does not replay TypeScript handler code. Workers claim a durable state, run normal code, then write the next state through the FerricFlow API.</p>
|
|
226
|
+
<p>For chainable state changes, pass the current claim directly to <code>advance()</code>.
|
|
227
|
+
It reads the workflow identity, logical state, lease token, and fencing token
|
|
228
|
+
from the claim and returns the renewed claim:</p>
|
|
229
|
+
<pre><code class="ts"><span class="hl-5">job</span><span class="hl-1"> = </span><span class="hl-4">await</span><span class="hl-1"> </span><span class="hl-5">flow</span><span class="hl-1">.</span><span class="hl-0">advance</span><span class="hl-1">(</span><span class="hl-5">job</span><span class="hl-1">, { </span><span class="hl-5">toState:</span><span class="hl-1"> </span><span class="hl-2">"schedule_warning"</span><span class="hl-1"> });</span>
|
|
230
|
+
</code><button type="button">Copy</button></pre>
|
|
231
|
+
|
|
232
|
+
<p>Use <code>step()</code> when a closure result must be journaled with the transition:</p>
|
|
233
|
+
<pre><code class="ts"><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">stepped</span><span class="hl-1"> = </span><span class="hl-4">await</span><span class="hl-1"> </span><span class="hl-5">flow</span><span class="hl-1">.</span><span class="hl-0">step</span><span class="hl-1">(</span><span class="hl-5">job</span><span class="hl-1">, {</span><br/><span class="hl-1"> </span><span class="hl-5">name:</span><span class="hl-1"> </span><span class="hl-2">"charge-customer:v1"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">run</span><span class="hl-5">:</span><span class="hl-1"> </span><span class="hl-6">async</span><span class="hl-1"> () </span><span class="hl-6">=></span><span class="hl-1"> </span><span class="hl-4">await</span><span class="hl-1"> </span><span class="hl-5">stripe</span><span class="hl-1">.</span><span class="hl-5">charges</span><span class="hl-1">.</span><span class="hl-0">create</span><span class="hl-1">(</span><br/><span class="hl-1"> { </span><span class="hl-5">amount:</span><span class="hl-1"> </span><span class="hl-9">150</span><span class="hl-1">, </span><span class="hl-5">currency:</span><span class="hl-1"> </span><span class="hl-2">"usd"</span><span class="hl-1">, </span><span class="hl-5">customer:</span><span class="hl-1"> </span><span class="hl-5">customerId</span><span class="hl-1"> },</span><br/><span class="hl-1"> { </span><span class="hl-5">idempotencyKey:</span><span class="hl-1"> </span><span class="hl-2">`</span><span class="hl-6">${</span><span class="hl-5">job</span><span class="hl-10">.</span><span class="hl-5">id</span><span class="hl-6">}</span><span class="hl-2">:charge-customer:v1`</span><span class="hl-1"> }</span><br/><span class="hl-1"> ),</span><br/><span class="hl-1"> </span><span class="hl-5">toState:</span><span class="hl-1"> </span><span class="hl-2">"schedule_warning"</span><br/><span class="hl-1">});</span><br/><span class="hl-5">job</span><span class="hl-1"> = </span><span class="hl-5">stepped</span><span class="hl-1">.</span><span class="hl-5">job</span><span class="hl-1">;</span>
|
|
234
|
+
</code><button type="button">Copy</button></pre>
|
|
235
|
+
|
|
236
|
+
<p>The step name must remain stable across retries. A committed result is returned
|
|
237
|
+
without running the closure again. A worker can still stop after an external
|
|
238
|
+
effect succeeds but before FerricStore commits the result, so external systems
|
|
239
|
+
still need the same stable provider idempotency key. The closure runs in the
|
|
240
|
+
calling worker's JavaScript execution context; the SDK does not move it to a
|
|
241
|
+
global thread pool.</p>
|
|
242
|
+
<p><code>nowMs</code> is an explicit client timestamp sent with a command. When omitted, the
|
|
243
|
+
SDK samples the client wall clock separately for each request. It is intended
|
|
244
|
+
mainly for deterministic tests and is not a server-response timestamp or a
|
|
245
|
+
transport timeout. <code>timeoutMs</code>, by contrast, is the client-side request
|
|
246
|
+
deadline. For a command that intentionally blocks on the server, its declared
|
|
247
|
+
server wait is added to that client deadline; an unbounded server wait has no
|
|
248
|
+
response timer.</p>
|
|
221
249
|
<p>Per-job <code>run()</code> workers cap every claim to currently available concurrency. They continuously refill slots by default, so if five of ten jobs finish and their terminal writes are acknowledged, one client-side <code>claim(limit: 5)</code> can start five replacements while the other five continue. Queue completions produced in the same event-loop turn remain batched. A slot stays occupied through its <code>complete</code>, <code>retry</code>, or <code>fail</code> acknowledgement; the worker never exceeds its local concurrency limit.</p>
|
|
222
250
|
<p>Full-record claims across multiple states are returned by the claim command itself, including requested payloads and named values. <code>FLOW.GET</code> hydration is retained only for compatibility with a server that unexpectedly returns legacy compact tuples. That fallback preserves result order and is bounded to 16 concurrent reads by default; set <code>legacyClaimHydrationConcurrency</code> on the client to tune it. If a fallback read fails, <code>ClaimHydrationError.claimed</code> contains every already-leased job, while <code>hydratedItems</code> contains the indexed records that finished successfully; <code>failedIndex</code> and <code>cause</code> identify the first observed failure. Set <code>jobOnly: true</code> when compact claim metadata is sufficient; compact state metadata is decoded directly from the claim response without per-job <code>FLOW.GET</code> calls.</p>
|
|
223
251
|
<p>Use <code>refillStrategy: "wave"</code> to wait for the entire current claim to settle before claiming again. <code>refillDelayMs</code> adds a small coalescing window before a continuous refill; the default <code>0</code> still coalesces completions for one event-loop turn. Batchable queue completions and same-route replacement claims share one ordered native pipeline by default; set <code>fuseCompleteClaim: false</code> to keep them as separate requests. <code>runOnce()</code> and batch-handler APIs remain finite and wave-oriented. These controls are local to one worker instance or pod: two pods configured with <code>concurrency: 10</code> can execute up to twenty jobs collectively.</p>
|
|
@@ -339,7 +367,7 @@ apply mutations.</p>
|
|
|
339
367
|
<h2 id="auto-batching" class="tsd-anchor-link">Auto-Batching<a href="#auto-batching" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2>
|
|
340
368
|
<p>The default client is latency-first: each SDK call sends its own native request.</p>
|
|
341
369
|
<p>For high-throughput services that issue many independent calls concurrently, enable SDK auto-batching:</p>
|
|
342
|
-
<pre><code class="ts"><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">client</span><span class="hl-1"> = </span><span class="hl-4">await</span><span class="hl-1"> </span><span class="hl-5">FerricStoreClient</span><span class="hl-1">.</span><span class="hl-0">fromUrl</span><span class="hl-1">(</span><span class="hl-2">"ferric://127.0.0.1:6388"</span><span class="hl-1">, {</span><br/><span class="hl-1"> </span><span class="hl-5">autoBatch:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-5">enabled:</span><span class="hl-1"> </span><span class="hl-6">true</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">maxCommands:</span><span class="hl-1"> </span><span class="hl-9">512</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">maxDelayMs:</span><span class="hl-1"> </span><span class="hl-9">0</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-4">await</span><span class="hl-1"> </span><span class="hl-
|
|
370
|
+
<pre><code class="ts"><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">client</span><span class="hl-1"> = </span><span class="hl-4">await</span><span class="hl-1"> </span><span class="hl-5">FerricStoreClient</span><span class="hl-1">.</span><span class="hl-0">fromUrl</span><span class="hl-1">(</span><span class="hl-2">"ferric://127.0.0.1:6388"</span><span class="hl-1">, {</span><br/><span class="hl-1"> </span><span class="hl-5">autoBatch:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-5">enabled:</span><span class="hl-1"> </span><span class="hl-6">true</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">maxCommands:</span><span class="hl-1"> </span><span class="hl-9">512</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">maxDelayMs:</span><span class="hl-1"> </span><span class="hl-9">0</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-4">await</span><span class="hl-1"> </span><span class="hl-11">Promise</span><span class="hl-1">.</span><span class="hl-0">all</span><span class="hl-1">([</span><br/><span class="hl-1"> </span><span class="hl-5">client</span><span class="hl-1">.</span><span class="hl-5">kv</span><span class="hl-1">.</span><span class="hl-0">set</span><span class="hl-1">(</span><span class="hl-2">"a"</span><span class="hl-1">, </span><span class="hl-2">"1"</span><span class="hl-1">),</span><br/><span class="hl-1"> </span><span class="hl-5">client</span><span class="hl-1">.</span><span class="hl-5">kv</span><span class="hl-1">.</span><span class="hl-0">set</span><span class="hl-1">(</span><span class="hl-2">"b"</span><span class="hl-1">, </span><span class="hl-2">"2"</span><span class="hl-1">),</span><br/><span class="hl-1"> </span><span class="hl-5">client</span><span class="hl-1">.</span><span class="hl-5">hash</span><span class="hl-1">.</span><span class="hl-0">hset</span><span class="hl-1">(</span><span class="hl-2">"user:1"</span><span class="hl-1">, { </span><span class="hl-5">email:</span><span class="hl-1"> </span><span class="hl-2">"ada@example.com"</span><span class="hl-1"> })</span><br/><span class="hl-1">]);</span>
|
|
343
371
|
</code><button type="button">Copy</button></pre>
|
|
344
372
|
|
|
345
373
|
<p>Auto-batching groups eligible concurrent commands into native <code>PIPELINE</code> frames and resolves each original promise independently. Across frames and individual-request fallbacks, same-key write dependencies retain invocation order, while read-only and disjoint-key work remains concurrent. Commands whose direct native representation uses a custom binary body are safely wrapped as typed <code>COMMAND_EXEC</code> pipeline items, preserving one pipeline request instead of issuing each command separately. Blocking/session and control commands such as <code>FLOW.CLAIM_DUE</code>, <code>BLPOP</code>, <code>XREAD</code>, <code>AUTH</code>, <code>PING</code>, <code>OPTIONS</code>, and <code>QUIT</code> bypass auto-batching. Explicit pipelines issue unsupported or connection-blocking items individually; blocking fallbacks and state-changing controls are sequenced with dependent data commands. Other fallbacks remain concurrent unless <code>client.pipeline(commands, { ordered: true })</code> is requested. Individual fallbacks continuously refill a bounded pool instead of starting every request at once; the default limit is 64 and <code>fallbackConcurrency</code> on the pipeline options can tune it per call. Native pipeline paths are unchanged. Reconnecting and topology executors reject connection-local mutations before dispatch, and an uncertain native pipeline is never replayed automatically.</p>
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
<li><a href="" aria-current="page">AdminListOptions</a></li></ul>
|
|
12
12
|
<h1>Interface AdminListOptions</h1></div>
|
|
13
13
|
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">AdminListOptions</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="#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="
|
|
14
|
+
<section class="tsd-panel tsd-hierarchy" data-refl="1454">
|
|
15
15
|
<h4>Hierarchy (<a href="../hierarchy.html#AdminListOptions">View Summary</a>)</h4>
|
|
16
16
|
<ul class="tsd-hierarchy">
|
|
17
17
|
<li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">AdminListOptions</span>
|
|
@@ -0,0 +1,145 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AdvanceOptions | @ferricstore/ferricstore</title><meta name="description" content="Documentation for @ferricstore/ferricstore"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar">
|
|
2
|
+
<div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@ferricstore/ferricstore</a>
|
|
3
|
+
<div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/>
|
|
4
|
+
<ul role="listbox" id="tsd-search-results"></ul>
|
|
5
|
+
<div id="tsd-search-status" aria-live="polite" aria-atomic="true">
|
|
6
|
+
<div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header>
|
|
7
|
+
<div class="container container-main">
|
|
8
|
+
<div class="col-content">
|
|
9
|
+
<div class="tsd-page-title">
|
|
10
|
+
<ul class="tsd-breadcrumb" aria-label="Breadcrumb">
|
|
11
|
+
<li><a href="" aria-current="page">AdvanceOptions</a></li></ul>
|
|
12
|
+
<h1>Interface AdvanceOptions</h1></div>
|
|
13
|
+
<section class="tsd-panel tsd-comment">
|
|
14
|
+
<div class="tsd-comment tsd-typography"><p>Options for advancing an already-claimed Flow to its next logical state.</p>
|
|
15
|
+
</div></section>
|
|
16
|
+
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">AdvanceOptions</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"><</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">></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="#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="#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="#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="#tostate">toState</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="#valuerefs">valueRefs</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></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"><</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">></span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
|
|
17
|
+
<section class="tsd-panel tsd-hierarchy" data-refl="1458">
|
|
18
|
+
<h4>Hierarchy (<a href="../hierarchy.html#AdvanceOptions">View Summary</a>)</h4>
|
|
19
|
+
<ul class="tsd-hierarchy">
|
|
20
|
+
<li class="tsd-hierarchy-item"><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><a href="MutateOptions.html" class="tsd-signature-type tsd-kind-interface">MutateOptions</a><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">"returnRecord"</span><span class="tsd-signature-symbol">></span>
|
|
21
|
+
<ul class="tsd-hierarchy">
|
|
22
|
+
<li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">AdvanceOptions</span>
|
|
23
|
+
<ul class="tsd-hierarchy">
|
|
24
|
+
<li class="tsd-hierarchy-item"><a href="StepOptions.html" class="tsd-signature-type tsd-kind-interface">StepOptions</a></li></ul></li></ul></li></ul></section><aside class="tsd-sources">
|
|
25
|
+
<ul>
|
|
26
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L284">src/client-options.ts:284</a></li></ul></aside>
|
|
27
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
28
|
+
<section class="tsd-panel tsd-index-panel">
|
|
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>
|
|
30
|
+
<h5 class="tsd-index-heading uppercase">Index</h5></summary>
|
|
31
|
+
<div class="tsd-accordion-details">
|
|
32
|
+
<section class="tsd-index-section">
|
|
33
|
+
<h3 class="tsd-index-heading tsd-anchor-link" id="properties">Properties<a href="#properties" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
34
|
+
<div class="tsd-index-list"><a href="#attributesdelete" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>attributes<wbr/>Delete?</span></a>
|
|
35
|
+
<a href="#attributesmerge" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>attributes<wbr/>Merge?</span></a>
|
|
36
|
+
<a href="#dropvalues" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>drop<wbr/>Values?</span></a>
|
|
37
|
+
<a href="#leasems" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>lease<wbr/>Ms?</span></a>
|
|
38
|
+
<a href="#nowms" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>now<wbr/>Ms?</span></a>
|
|
39
|
+
<a href="#overridevalues" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>override<wbr/>Values?</span></a>
|
|
40
|
+
<a href="#partitionkey" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>partition<wbr/>Key?</span></a>
|
|
41
|
+
<a href="#payload" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>payload?</span></a>
|
|
42
|
+
<a href="#statemeta" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>state<wbr/>Meta?</span></a>
|
|
43
|
+
<a href="#tostate" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>to<wbr/>State</span></a>
|
|
44
|
+
<a href="#valuerefs" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>value<wbr/>Refs?</span></a>
|
|
45
|
+
<a href="#values" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>values?</span></a>
|
|
46
|
+
</div></section></div></details></section></section>
|
|
47
|
+
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
48
|
+
<h2 class="tsd-anchor-link" id="properties-1">Properties<a href="#properties-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
|
|
49
|
+
<section>
|
|
50
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
51
|
+
<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>
|
|
52
|
+
<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">
|
|
53
|
+
<p>Inherited from <a href="MutateOptions.html">MutateOptions</a>.<a href="MutateOptions.html#attributesdelete">attributesDelete</a></p>
|
|
54
|
+
<ul>
|
|
55
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L240">src/client-options.ts:240</a></li></ul></aside></section>
|
|
56
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
57
|
+
<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>
|
|
58
|
+
<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"><</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">></span></div><aside class="tsd-sources">
|
|
59
|
+
<p>Inherited from <a href="MutateOptions.html">MutateOptions</a>.<a href="MutateOptions.html#attributesmerge">attributesMerge</a></p>
|
|
60
|
+
<ul>
|
|
61
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L239">src/client-options.ts:239</a></li></ul></aside></section>
|
|
62
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
63
|
+
<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>
|
|
64
|
+
<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">
|
|
65
|
+
<p>Inherited from <a href="MutateOptions.html">MutateOptions</a>.<a href="MutateOptions.html#dropvalues">dropValues</a></p>
|
|
66
|
+
<ul>
|
|
67
|
+
<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>
|
|
68
|
+
<section class="tsd-panel tsd-member">
|
|
69
|
+
<h3 class="tsd-anchor-link" id="leasems"><code class="tsd-tag">Optional</code><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>
|
|
70
|
+
<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">
|
|
71
|
+
<ul>
|
|
72
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L286">src/client-options.ts:286</a></li></ul></aside></section>
|
|
73
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
74
|
+
<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>
|
|
75
|
+
<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>
|
|
76
|
+
<div class="tsd-comment tsd-typography"><p>Explicit client-supplied command timestamp. Omit in production so each
|
|
77
|
+
request samples the current client wall clock; primarily useful for tests.
|
|
78
|
+
This is not the server response time or the client transport deadline.</p>
|
|
79
|
+
</div><aside class="tsd-sources">
|
|
80
|
+
<p>Inherited from <a href="MutateOptions.html">MutateOptions</a>.<a href="MutateOptions.html#nowms">nowMs</a></p>
|
|
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>
|
|
83
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
84
|
+
<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>
|
|
85
|
+
<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">
|
|
86
|
+
<p>Inherited from <a href="MutateOptions.html">MutateOptions</a>.<a href="MutateOptions.html#overridevalues">overrideValues</a></p>
|
|
87
|
+
<ul>
|
|
88
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L238">src/client-options.ts:238</a></li></ul></aside></section>
|
|
89
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
90
|
+
<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>
|
|
91
|
+
<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">
|
|
92
|
+
<p>Inherited from <a href="MutateOptions.html">MutateOptions</a>.<a href="MutateOptions.html#partitionkey">partitionKey</a></p>
|
|
93
|
+
<ul>
|
|
94
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L233">src/client-options.ts:233</a></li></ul></aside></section>
|
|
95
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
96
|
+
<h3 class="tsd-anchor-link" id="payload"><code class="tsd-tag">Optional</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>
|
|
97
|
+
<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">
|
|
98
|
+
<p>Inherited from <a href="MutateOptions.html">MutateOptions</a>.<a href="MutateOptions.html#payload">payload</a></p>
|
|
99
|
+
<ul>
|
|
100
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L234">src/client-options.ts:234</a></li></ul></aside></section>
|
|
101
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
102
|
+
<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>
|
|
103
|
+
<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">
|
|
104
|
+
<p>Inherited from <a href="MutateOptions.html">MutateOptions</a>.<a href="MutateOptions.html#statemeta">stateMeta</a></p>
|
|
105
|
+
<ul>
|
|
106
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L241">src/client-options.ts:241</a></li></ul></aside></section>
|
|
107
|
+
<section class="tsd-panel tsd-member">
|
|
108
|
+
<h3 class="tsd-anchor-link" id="tostate"><span>to<wbr/>State</span><a href="#tostate" 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
|
+
<div class="tsd-signature"><span class="tsd-kind-property">toState</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
110
|
+
<ul>
|
|
111
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L285">src/client-options.ts:285</a></li></ul></aside></section>
|
|
112
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
113
|
+
<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>
|
|
114
|
+
<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"><</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">></span></div><aside class="tsd-sources">
|
|
115
|
+
<p>Inherited from <a href="MutateOptions.html">MutateOptions</a>.<a href="MutateOptions.html#valuerefs">valueRefs</a></p>
|
|
116
|
+
<ul>
|
|
117
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L236">src/client-options.ts:236</a></li></ul></aside></section>
|
|
118
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
119
|
+
<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>
|
|
120
|
+
<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"><</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">></span></div><aside class="tsd-sources">
|
|
121
|
+
<p>Inherited from <a href="MutateOptions.html">MutateOptions</a>.<a href="MutateOptions.html#values">values</a></p>
|
|
122
|
+
<ul>
|
|
123
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L235">src/client-options.ts:235</a></li></ul></aside></section></section></details></div>
|
|
124
|
+
<div class="col-sidebar">
|
|
125
|
+
<div class="page-menu">
|
|
126
|
+
<div class="tsd-navigation settings">
|
|
127
|
+
<details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
128
|
+
<h3>Settings</h3></summary>
|
|
129
|
+
<div class="tsd-accordion-details">
|
|
130
|
+
<div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
|
|
131
|
+
<ul id="tsd-filter-options">
|
|
132
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
|
|
133
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
|
|
134
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div>
|
|
135
|
+
<div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
|
136
|
+
<details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
137
|
+
<h3>On This Page</h3></summary>
|
|
138
|
+
<div class="tsd-accordion-details">
|
|
139
|
+
<details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary>
|
|
140
|
+
<div><a href="#attributesdelete" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>attributes<wbr/>Delete</span></a><a href="#attributesmerge" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>attributes<wbr/>Merge</span></a><a href="#dropvalues" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>drop<wbr/>Values</span></a><a href="#leasems"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>lease<wbr/>Ms</span></a><a href="#nowms" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>now<wbr/>Ms</span></a><a href="#overridevalues" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>override<wbr/>Values</span></a><a href="#partitionkey" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>partition<wbr/>Key</span></a><a href="#payload" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>payload</span></a><a href="#statemeta" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>state<wbr/>Meta</span></a><a href="#tostate"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>to<wbr/>State</span></a><a href="#valuerefs" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>value<wbr/>Refs</span></a><a href="#values" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>values</span></a></div></details></div></details></div>
|
|
141
|
+
<div class="site-menu">
|
|
142
|
+
<nav class="tsd-navigation"><a href="../modules.html">@ferricstore/ferricstore</a>
|
|
143
|
+
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
144
|
+
<li>Loading...</li></ul></nav></div></div></div><footer></footer>
|
|
145
|
+
<div class="overlay"></div></body></html>
|