@ferricstore/ferricstore 0.13.0 → 0.13.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +53 -1
- package/dist/index.cjs +230 -82
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +30 -6
- package/dist/index.d.ts +30 -6
- package/dist/index.js +229 -82
- package/dist/index.js.map +1 -1
- package/dist/langgraph.cjs.map +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/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 +4 -4
- package/docs/api/classes/FerricStoreClient.html +13 -13
- package/docs/api/classes/FerricStoreError.html +1 -0
- package/docs/api/classes/FlowAlreadyExistsError.html +3 -3
- package/docs/api/classes/FlowNotFoundError.html +3 -3
- package/docs/api/classes/FlowWrongStateError.html +3 -3
- package/docs/api/classes/HTTPTransportError.html +13 -7
- package/docs/api/classes/InvalidCommandError.html +3 -3
- package/docs/api/classes/LeaseRenewalError.html +1 -1
- 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/WorkflowContext.html +7 -9
- package/docs/api/functions/classifyServerError.html +1 -1
- package/docs/api/functions/mapException.html +1 -1
- package/docs/api/hierarchy.html +21 -20
- package/docs/api/index.html +38 -2
- package/docs/api/interfaces/AdvanceOptions.html +9 -5
- package/docs/api/interfaces/AlreadyAppliedOutcome.html +1 -1
- package/docs/api/interfaces/AppliedStepOutcome.html +1 -1
- package/docs/api/interfaces/CancelOptions.html +12 -8
- package/docs/api/interfaces/CompleteOptions.html +12 -8
- package/docs/api/interfaces/CompleteOutcome.html +1 -1
- package/docs/api/interfaces/ExtendLeaseOptions.html +10 -8
- package/docs/api/interfaces/FailOptions.html +12 -8
- package/docs/api/interfaces/FailOutcome.html +1 -1
- package/docs/api/interfaces/HistoryOptions.html +16 -16
- package/docs/api/interfaces/LeaseMutationOptions.html +10 -6
- package/docs/api/interfaces/MutateOptions.html +7 -3
- package/docs/api/interfaces/NamedValueMutation.html +1 -1
- package/docs/api/interfaces/ReadOptions.html +11 -11
- package/docs/api/interfaces/RetryOptions.html +12 -8
- package/docs/api/interfaces/RetryOutcome.html +1 -1
- package/docs/api/interfaces/RunStepsItem.html +3 -3
- package/docs/api/interfaces/RunStepsManyOptions.html +11 -11
- package/docs/api/interfaces/SearchOptions.html +12 -12
- package/docs/api/interfaces/StepContinueOptions.html +15 -11
- package/docs/api/interfaces/StepOptions.html +15 -8
- package/docs/api/interfaces/StepResult.html +3 -3
- package/docs/api/interfaces/TDigestCreateOptions.html +1 -1
- package/docs/api/interfaces/TDigestMergeOptions.html +1 -1
- package/docs/api/interfaces/TransitionOptions.html +14 -10
- package/docs/api/interfaces/TransitionOutcome.html +1 -1
- package/docs/api/media/design.md +22 -1
- package/docs/api/modules.html +2 -2
- package/docs/api/types/ConnectionRequestDisposition.html +1 -1
- package/docs/api/types/ManagementPairs.html +1 -1
- package/docs/api/types/RequestDisposition.html +1 -1
- package/docs/api/types/SearchStateMeta.html +1 -1
- package/docs/api/variables/FERRICSTORE_SDK_VERSION.html +1 -1
- package/docs/design.md +22 -1
- package/package.json +1 -1
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
<li><a href="" aria-current="page">WorkflowContext</a></li></ul>
|
|
12
12
|
<h1>Class WorkflowContext</h1></div><aside class="tsd-sources">
|
|
13
13
|
<ul>
|
|
14
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#
|
|
14
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L30">src/workflow-context.ts:30</a></li></ul></aside>
|
|
15
15
|
<section class="tsd-panel-group tsd-index-group">
|
|
16
16
|
<section class="tsd-panel tsd-index-panel">
|
|
17
17
|
<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>
|
|
@@ -62,19 +62,17 @@
|
|
|
62
62
|
<h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
63
63
|
<ul class="tsd-signatures">
|
|
64
64
|
<li class="">
|
|
65
|
-
<div class="tsd-signature tsd-anchor-link" id="constructorworkflowcontext"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">WorkflowContext</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">workflow</span><span class="tsd-signature-symbol">:</span> <a href="Workflow.html" class="tsd-signature-type tsd-kind-class">Workflow</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">job</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/FlowRecord.html" class="tsd-signature-type tsd-kind-interface">FlowRecord</a><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> <a href="../interfaces/ClaimedItem.html" class="tsd-signature-type tsd-kind-interface">ClaimedItem</a><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-kind-parameter">stateName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br
|
|
65
|
+
<div class="tsd-signature tsd-anchor-link" id="constructorworkflowcontext"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">WorkflowContext</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">workflow</span><span class="tsd-signature-symbol">:</span> <a href="Workflow.html" class="tsd-signature-type tsd-kind-class">Workflow</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">job</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/FlowRecord.html" class="tsd-signature-type tsd-kind-interface">FlowRecord</a><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> <a href="../interfaces/ClaimedItem.html" class="tsd-signature-type tsd-kind-interface">ClaimedItem</a><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-kind-parameter">stateName</span><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><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">WorkflowContext</a><a href="#constructorworkflowcontext" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
66
66
|
<div class="tsd-description">
|
|
67
67
|
<div class="tsd-parameters">
|
|
68
68
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
69
69
|
<ul class="tsd-parameter-list">
|
|
70
70
|
<li><span><span class="tsd-kind-parameter">workflow</span>: <a href="Workflow.html" class="tsd-signature-type tsd-kind-class">Workflow</a></span></li>
|
|
71
71
|
<li><span><span class="tsd-kind-parameter">job</span>: <a href="../interfaces/FlowRecord.html" class="tsd-signature-type tsd-kind-interface">FlowRecord</a><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> <a href="../interfaces/ClaimedItem.html" class="tsd-signature-type tsd-kind-interface">ClaimedItem</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></span></li>
|
|
72
|
-
<li><span><span class="tsd-kind-parameter">stateName</span>: <span class="tsd-signature-type">string</span></span></li>
|
|
73
|
-
<li><span><span class="tsd-kind-parameter">leaseJob</span>: <a href="../interfaces/ClaimedItem.html" class="tsd-signature-type tsd-kind-interface">ClaimedItem</a><span class="tsd-signature-symbol"> = job</span></span></li>
|
|
74
|
-
<li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">mutationCoordinator</span>: <span class="tsd-signature-type">WorkflowMutationCoordinator</span></span></li></ul></div>
|
|
72
|
+
<li><span><span class="tsd-kind-parameter">stateName</span>: <span class="tsd-signature-type">string</span></span></li></ul></div>
|
|
75
73
|
<h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">WorkflowContext</a></h4><aside class="tsd-sources">
|
|
76
74
|
<ul>
|
|
77
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#
|
|
75
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L42">src/workflow-context.ts:42</a></li></ul></aside></div></li></ul></section></section></details>
|
|
78
76
|
<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>
|
|
79
77
|
<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>
|
|
80
78
|
<section>
|
|
@@ -82,17 +80,17 @@
|
|
|
82
80
|
<h3 class="tsd-anchor-link" id="flow"><code class="tsd-tag">Readonly</code><span>flow</span><a href="#flow" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
83
81
|
<div class="tsd-signature"><span class="tsd-kind-property">flow</span><span class="tsd-signature-symbol">:</span> <a href="WorkflowFlowCommands.html" class="tsd-signature-type tsd-kind-class">WorkflowFlowCommands</a></div><aside class="tsd-sources">
|
|
84
82
|
<ul>
|
|
85
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#
|
|
83
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L33">src/workflow-context.ts:33</a></li></ul></aside></section>
|
|
86
84
|
<section class="tsd-panel tsd-member">
|
|
87
85
|
<h3 class="tsd-anchor-link" id="job"><code class="tsd-tag">Readonly</code><span>job</span><a href="#job" 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>
|
|
88
86
|
<div class="tsd-signature"><span class="tsd-kind-property">job</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/FlowRecord.html" class="tsd-signature-type tsd-kind-interface">FlowRecord</a><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> <a href="../interfaces/ClaimedItem.html" class="tsd-signature-type tsd-kind-interface">ClaimedItem</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources">
|
|
89
87
|
<ul>
|
|
90
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#
|
|
88
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L32">src/workflow-context.ts:32</a></li></ul></aside></section>
|
|
91
89
|
<section class="tsd-panel tsd-member">
|
|
92
90
|
<h3 class="tsd-anchor-link" id="workflow"><code class="tsd-tag">Readonly</code><span>workflow</span><a href="#workflow" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
93
91
|
<div class="tsd-signature"><span class="tsd-kind-property">workflow</span><span class="tsd-signature-symbol">:</span> <a href="Workflow.html" class="tsd-signature-type tsd-kind-class">Workflow</a></div><aside class="tsd-sources">
|
|
94
92
|
<ul>
|
|
95
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#
|
|
93
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L31">src/workflow-context.ts:31</a></li></ul></aside></section></section></details>
|
|
96
94
|
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
97
95
|
<h2 class="tsd-anchor-link" id="accessors-1">Accessors<a href="#accessors-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>
|
|
98
96
|
<section>
|
|
@@ -24,7 +24,7 @@
|
|
|
24
24
|
<li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">status</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span></span></li></ul></div>
|
|
25
25
|
<h4 class="tsd-returns-title">Returns <a href="../classes/FerricStoreError.html" class="tsd-signature-type tsd-kind-class">FerricStoreError</a></h4><aside class="tsd-sources">
|
|
26
26
|
<ul>
|
|
27
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#
|
|
27
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L176">src/errors.ts:176</a></li></ul></aside></div></li></ul></section></div>
|
|
28
28
|
<div class="col-sidebar">
|
|
29
29
|
<div class="page-menu">
|
|
30
30
|
<div class="tsd-navigation settings">
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
<li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">unknown</span></span></li></ul></div>
|
|
22
22
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">unknown</span></h4><aside class="tsd-sources">
|
|
23
23
|
<ul>
|
|
24
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#
|
|
24
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L246">src/errors.ts:246</a></li></ul></aside></div></li></ul></section></div>
|
|
25
25
|
<div class="col-sidebar">
|
|
26
26
|
<div class="page-menu">
|
|
27
27
|
<div class="tsd-navigation settings">
|
package/docs/api/hierarchy.html
CHANGED
|
@@ -18,9 +18,9 @@
|
|
|
18
18
|
<ul>
|
|
19
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
20
|
<ul class="tsd-full-hierarchy">
|
|
21
|
-
<li data-refl="
|
|
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
22
|
<ul>
|
|
23
|
-
<li data-refl="
|
|
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
24
|
<ul class="tsd-full-hierarchy">
|
|
25
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
26
|
<ul>
|
|
@@ -51,17 +51,18 @@
|
|
|
51
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
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
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="
|
|
55
|
-
<li data-refl="
|
|
56
|
-
<li data-refl="
|
|
57
|
-
<li data-refl="
|
|
58
|
-
<li data-refl="
|
|
59
|
-
<li data-refl="
|
|
60
|
-
<li data-refl="
|
|
61
|
-
<li data-refl="
|
|
62
|
-
<li data-refl="2666" id="
|
|
63
|
-
<li data-refl="2695" id="
|
|
64
|
-
<li data-refl="2724" id="
|
|
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>
|
|
65
66
|
<ul class="tsd-full-hierarchy">
|
|
66
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>
|
|
67
68
|
<ul>
|
|
@@ -77,12 +78,12 @@
|
|
|
77
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>
|
|
78
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>
|
|
79
80
|
<ul class="tsd-full-hierarchy">
|
|
80
|
-
<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>
|
|
81
82
|
<ul>
|
|
82
|
-
<li data-refl="
|
|
83
|
-
<li data-refl="
|
|
84
|
-
<li data-refl="
|
|
85
|
-
<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>
|
|
86
87
|
<ul class="tsd-full-hierarchy">
|
|
87
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>
|
|
88
89
|
<ul>
|
|
@@ -98,9 +99,9 @@
|
|
|
98
99
|
<ul>
|
|
99
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>
|
|
100
101
|
<ul class="tsd-full-hierarchy">
|
|
101
|
-
<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>
|
|
102
103
|
<ul>
|
|
103
|
-
<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>
|
|
104
105
|
<div class="col-sidebar">
|
|
105
106
|
<div class="page-menu">
|
|
106
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.2</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.
|
|
@@ -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,37 @@ 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>A waiting workflow does not occupy a worker. Persist a timer, signal, approval,
|
|
243
|
+
or scheduled state and return the waiting transition so the current claim is
|
|
244
|
+
released. When the wait condition is satisfied, any available worker can acquire
|
|
245
|
+
a fresh lease and continue from the stored state. If no worker is
|
|
246
|
+
running, the workflow remains durable until one becomes available.</p>
|
|
247
|
+
<p><code>stepContinue()</code> remains available only as a deprecated low-level migration API.
|
|
248
|
+
Use <code>advance(job, { toState })</code> for a state-only transition and
|
|
249
|
+
<code>step(job, { name, run, toState })</code> when the closure result must be journaled.</p>
|
|
250
|
+
<p><code>nowMs</code> is an explicit client timestamp sent with a command. When omitted, the
|
|
251
|
+
SDK samples the client wall clock separately for each request. It is intended
|
|
252
|
+
mainly for deterministic tests and is not a server-response timestamp or a
|
|
253
|
+
transport timeout. <code>timeoutMs</code>, by contrast, is the client-side request
|
|
254
|
+
deadline. For a command that intentionally blocks on the server, its declared
|
|
255
|
+
server wait is added to that client deadline; an unbounded server wait has no
|
|
256
|
+
response timer.</p>
|
|
221
257
|
<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
258
|
<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
259
|
<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 +375,7 @@ apply mutations.</p>
|
|
|
339
375
|
<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
376
|
<p>The default client is latency-first: each SDK call sends its own native request.</p>
|
|
341
377
|
<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-
|
|
378
|
+
<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
379
|
</code><button type="button">Copy</button></pre>
|
|
344
380
|
|
|
345
381
|
<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>
|
|
@@ -23,7 +23,7 @@
|
|
|
23
23
|
<ul class="tsd-hierarchy">
|
|
24
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
25
|
<ul>
|
|
26
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
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
27
|
<section class="tsd-panel-group tsd-index-group">
|
|
28
28
|
<section class="tsd-panel tsd-index-panel">
|
|
29
29
|
<details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
@@ -69,13 +69,17 @@
|
|
|
69
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
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
71
|
<ul>
|
|
72
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
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
73
|
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
74
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
|
|
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">
|
|
76
80
|
<p>Inherited from <a href="MutateOptions.html">MutateOptions</a>.<a href="MutateOptions.html#nowms">nowMs</a></p>
|
|
77
81
|
<ul>
|
|
78
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
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>
|
|
79
83
|
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
80
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>
|
|
81
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">
|
|
@@ -104,7 +108,7 @@
|
|
|
104
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>
|
|
105
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">
|
|
106
110
|
<ul>
|
|
107
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
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>
|
|
108
112
|
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
109
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>
|
|
110
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">
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
<div class="tsd-comment tsd-typography"><p>A workflow handler mutation already committed with this refreshed claim.</p>
|
|
15
15
|
</div></section>
|
|
16
16
|
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">AlreadyAppliedOutcome</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#job">job</a><span class="tsd-signature-symbol">:</span> <a href="ClaimedItem.html" class="tsd-signature-type tsd-kind-interface">ClaimedItem</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">"already_applied"</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
|
|
17
|
-
<section class="tsd-panel tsd-hierarchy" data-refl="
|
|
17
|
+
<section class="tsd-panel tsd-hierarchy" data-refl="2811">
|
|
18
18
|
<h4>Hierarchy (<a href="../hierarchy.html#AlreadyAppliedOutcome">View Summary</a>)</h4>
|
|
19
19
|
<ul class="tsd-hierarchy">
|
|
20
20
|
<li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">AlreadyAppliedOutcome</span>
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
<h4>Type Parameters</h4>
|
|
19
19
|
<ul class="tsd-type-parameter-list">
|
|
20
20
|
<li><span id="tresult"><span class="tsd-kind-type-parameter">TResult</span></span></li></ul></section>
|
|
21
|
-
<section class="tsd-panel tsd-hierarchy" data-refl="
|
|
21
|
+
<section class="tsd-panel tsd-hierarchy" data-refl="2814">
|
|
22
22
|
<h4>Hierarchy (<a href="../hierarchy.html#AppliedStepOutcome">View Summary</a>)</h4>
|
|
23
23
|
<ul class="tsd-hierarchy">
|
|
24
24
|
<li class="tsd-hierarchy-item"><a href="AlreadyAppliedOutcome.html" class="tsd-signature-type tsd-kind-interface">AlreadyAppliedOutcome</a>
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
<ul class="tsd-hierarchy">
|
|
19
19
|
<li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">CancelOptions</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#
|
|
21
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L339">src/client-options.ts:339</a></li></ul></aside>
|
|
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>
|
|
@@ -66,18 +66,22 @@
|
|
|
66
66
|
<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>
|
|
67
67
|
<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">
|
|
68
68
|
<ul>
|
|
69
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
69
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L340">src/client-options.ts:340</a></li></ul></aside></section>
|
|
70
70
|
<section class="tsd-panel tsd-member">
|
|
71
71
|
<h3 class="tsd-anchor-link" id="leasetoken"><code class="tsd-tag">Optional</code><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>
|
|
72
72
|
<div class="tsd-signature"><span class="tsd-kind-property">leaseToken</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBufferLike</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources">
|
|
73
73
|
<ul>
|
|
74
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
74
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L341">src/client-options.ts:341</a></li></ul></aside></section>
|
|
75
75
|
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
76
76
|
<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>
|
|
77
|
-
<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
|
|
77
|
+
<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>
|
|
78
|
+
<div class="tsd-comment tsd-typography"><p>Explicit client-supplied command timestamp. Omit in production so each
|
|
79
|
+
request samples the current client wall clock; primarily useful for tests.
|
|
80
|
+
This is not the server response time or the client transport deadline.</p>
|
|
81
|
+
</div><aside class="tsd-sources">
|
|
78
82
|
<p>Inherited from <a href="MutateOptions.html">MutateOptions</a>.<a href="MutateOptions.html#nowms">nowMs</a></p>
|
|
79
83
|
<ul>
|
|
80
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
84
|
+
<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>
|
|
81
85
|
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
82
86
|
<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>
|
|
83
87
|
<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">
|
|
@@ -94,13 +98,13 @@
|
|
|
94
98
|
<h3 class="tsd-anchor-link" id="reason"><code class="tsd-tag">Optional</code><span>reason</span><a href="#reason" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
95
99
|
<div class="tsd-signature"><span class="tsd-kind-property">reason</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span></div><aside class="tsd-sources">
|
|
96
100
|
<ul>
|
|
97
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
101
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L342">src/client-options.ts:342</a></li></ul></aside></section>
|
|
98
102
|
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
99
103
|
<h3 class="tsd-anchor-link" id="returnrecord"><code class="tsd-tag">Optional</code><span>return<wbr/>Record</span><a href="#returnrecord" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
100
104
|
<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">
|
|
101
105
|
<p>Inherited from <a href="MutateOptions.html">MutateOptions</a>.<a href="MutateOptions.html#returnrecord">returnRecord</a></p>
|
|
102
106
|
<ul>
|
|
103
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
107
|
+
<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>
|
|
104
108
|
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
105
109
|
<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>
|
|
106
110
|
<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">
|
|
@@ -111,7 +115,7 @@
|
|
|
111
115
|
<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>
|
|
112
116
|
<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">
|
|
113
117
|
<ul>
|
|
114
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
118
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L343">src/client-options.ts:343</a></li></ul></aside></section>
|
|
115
119
|
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
116
120
|
<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>
|
|
117
121
|
<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">
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
<ul class="tsd-hierarchy">
|
|
19
19
|
<li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">CompleteOptions</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#
|
|
21
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L324">src/client-options.ts:324</a></li></ul></aside>
|
|
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>
|
|
@@ -68,19 +68,23 @@
|
|
|
68
68
|
<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">
|
|
69
69
|
<p>Inherited from <a href="LeaseMutationOptions.html">LeaseMutationOptions</a>.<a href="LeaseMutationOptions.html#fencingtoken">fencingToken</a></p>
|
|
70
70
|
<ul>
|
|
71
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
71
|
+
<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>
|
|
72
72
|
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
73
73
|
<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>
|
|
74
74
|
<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">
|
|
75
75
|
<p>Inherited from <a href="LeaseMutationOptions.html">LeaseMutationOptions</a>.<a href="LeaseMutationOptions.html#leasetoken">leaseToken</a></p>
|
|
76
76
|
<ul>
|
|
77
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
77
|
+
<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>
|
|
78
78
|
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
79
79
|
<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>
|
|
80
|
-
<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
|
|
80
|
+
<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>
|
|
81
|
+
<div class="tsd-comment tsd-typography"><p>Explicit client-supplied command timestamp. Omit in production so each
|
|
82
|
+
request samples the current client wall clock; primarily useful for tests.
|
|
83
|
+
This is not the server response time or the client transport deadline.</p>
|
|
84
|
+
</div><aside class="tsd-sources">
|
|
81
85
|
<p>Inherited from <a href="LeaseMutationOptions.html">LeaseMutationOptions</a>.<a href="LeaseMutationOptions.html#nowms">nowMs</a></p>
|
|
82
86
|
<ul>
|
|
83
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
87
|
+
<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>
|
|
84
88
|
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
85
89
|
<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>
|
|
86
90
|
<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">
|
|
@@ -103,13 +107,13 @@
|
|
|
103
107
|
<h3 class="tsd-anchor-link" id="result"><code class="tsd-tag">Optional</code><span>result</span><a href="#result" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
104
108
|
<div class="tsd-signature"><span class="tsd-kind-property">result</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span></div><aside class="tsd-sources">
|
|
105
109
|
<ul>
|
|
106
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
110
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L325">src/client-options.ts:325</a></li></ul></aside></section>
|
|
107
111
|
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
108
112
|
<h3 class="tsd-anchor-link" id="returnrecord"><code class="tsd-tag">Optional</code><span>return<wbr/>Record</span><a href="#returnrecord" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
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#
|
|
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#
|
|
127
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L326">src/client-options.ts:326</a></li></ul></aside></section>
|
|
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"><</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">
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
<li><a href="" aria-current="page">CompleteOutcome</a></li></ul>
|
|
12
12
|
<h1>Interface CompleteOutcome</h1></div>
|
|
13
13
|
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">CompleteOutcome</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="#kind">kind</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"complete"</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="#result">result</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"><</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>
|
|
14
|
-
<section class="tsd-panel tsd-hierarchy" data-refl="
|
|
14
|
+
<section class="tsd-panel tsd-hierarchy" data-refl="2827">
|
|
15
15
|
<h4>Hierarchy (<a href="../hierarchy.html#CompleteOutcome">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>
|