@ferricstore/ferricstore 0.12.2 → 0.13.0
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 +2 -2
- package/dist/index.cjs +591 -133
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +61 -7
- package/dist/index.d.ts +61 -7
- package/dist/index.js +586 -129
- 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/{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/navigation.js +1 -1
- package/docs/api/assets/search.js +1 -1
- package/docs/api/classes/ConnectionClosedError.html +1 -1
- package/docs/api/classes/FerricStoreClient.html +68 -23
- package/docs/api/classes/FerricStoreError.html +1 -1
- package/docs/api/classes/FlowAlreadyExistsError.html +1 -1
- package/docs/api/classes/FlowBatchError.html +1 -1
- package/docs/api/classes/FlowNotFoundError.html +1 -1
- package/docs/api/classes/FlowQueryError.html +1 -1
- package/docs/api/classes/FlowWrongStateError.html +1 -1
- package/docs/api/classes/HTTPTransportError.html +1 -1
- package/docs/api/classes/InvalidCommandError.html +1 -1
- package/docs/api/classes/LeaseRenewalError.html +3 -3
- package/docs/api/classes/LockHeldError.html +1 -1
- package/docs/api/classes/LockNotOwnedError.html +1 -1
- package/docs/api/classes/OverloadedError.html +1 -1
- package/docs/api/classes/QueueCompletionError.html +1 -1
- package/docs/api/classes/RequestTimeoutError.html +1 -1
- package/docs/api/classes/RerouteError.html +1 -1
- package/docs/api/classes/StaleLeaseError.html +1 -1
- package/docs/api/classes/StalePolicyGenerationError.html +1 -1
- package/docs/api/classes/Workflow.html +19 -19
- package/docs/api/classes/WorkflowClient.html +4 -4
- package/docs/api/classes/WorkflowContext.html +74 -36
- package/docs/api/classes/WorkflowFlowCommands.html +26 -22
- package/docs/api/classes/WorkflowWorker.html +6 -6
- 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/retry.html +1 -1
- package/docs/api/functions/transition.html +1 -1
- package/docs/api/hierarchy.html +55 -47
- package/docs/api/index.html +2 -2
- package/docs/api/interfaces/AdminListOptions.html +1 -1
- package/docs/api/interfaces/AdvanceOptions.html +141 -0
- package/docs/api/interfaces/AlreadyAppliedOutcome.html +69 -0
- package/docs/api/interfaces/AppliedStepOutcome.html +87 -0
- package/docs/api/interfaces/CancelOptions.html +6 -6
- package/docs/api/interfaces/CompleteOptions.html +4 -4
- 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/FailOptions.html +4 -4
- 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 +1 -1
- package/docs/api/interfaces/LimitListOptions.html +1 -1
- package/docs/api/interfaces/MutateOptions.html +1 -1
- 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 +4 -4
- 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 +1 -1
- package/docs/api/interfaces/StepOptions.html +159 -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 +1 -1
- package/docs/api/interfaces/TransitionOutcome.html +14 -14
- package/docs/api/modules.html +6 -6
- 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/SearchStateMeta.html +1 -1
- package/docs/api/types/WorkflowStepResult.html +38 -0
- package/package.json +1 -1
|
@@ -11,14 +11,14 @@
|
|
|
11
11
|
<li><a href="" aria-current="page">SearchOptions</a></li></ul>
|
|
12
12
|
<h1>Interface SearchOptions</h1></div>
|
|
13
13
|
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">SearchOptions</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#attributes">attributes</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</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="#consistentprojection">consistentProjection</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#count">count</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#fromms">fromMs</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#includecold">includeCold</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#partitionkey">partitionKey</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#rev">rev</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#state">state</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#statemeta">stateMeta</a><span class="tsd-signature-symbol">?:</span> <a href="../types/SearchStateMeta.html" class="tsd-signature-type tsd-kind-type-alias">SearchStateMeta</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#terminalonly">terminalOnly</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#toms">toMs</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
|
|
14
|
-
<section class="tsd-panel tsd-hierarchy" data-refl="
|
|
14
|
+
<section class="tsd-panel tsd-hierarchy" data-refl="1933">
|
|
15
15
|
<h4>Hierarchy (<a href="../hierarchy.html#SearchOptions">View Summary</a>)</h4>
|
|
16
16
|
<ul class="tsd-hierarchy">
|
|
17
17
|
<li class="tsd-hierarchy-item"><a href="ReadOptions.html" class="tsd-signature-type tsd-kind-interface">ReadOptions</a>
|
|
18
18
|
<ul class="tsd-hierarchy">
|
|
19
19
|
<li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">SearchOptions</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#L370">src/client-options.ts:370</a></li></ul></aside>
|
|
22
22
|
<section class="tsd-panel-group tsd-index-group">
|
|
23
23
|
<section class="tsd-panel tsd-index-panel">
|
|
24
24
|
<details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
@@ -46,37 +46,37 @@
|
|
|
46
46
|
<div class="tsd-signature"><span class="tsd-kind-property">attributes</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</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">
|
|
47
47
|
<p>Overrides <a href="ReadOptions.html">ReadOptions</a>.<a href="ReadOptions.html#attributes">attributes</a></p>
|
|
48
48
|
<ul>
|
|
49
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
49
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L371">src/client-options.ts:371</a></li></ul></aside></section>
|
|
50
50
|
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
51
51
|
<h3 class="tsd-anchor-link" id="consistentprojection"><code class="tsd-tag">Optional</code><span>consistent<wbr/>Projection</span><a href="#consistentprojection" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
52
52
|
<div class="tsd-signature"><span class="tsd-kind-property">consistentProjection</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
|
|
53
53
|
<p>Inherited from <a href="ReadOptions.html">ReadOptions</a>.<a href="ReadOptions.html#consistentprojection">consistentProjection</a></p>
|
|
54
54
|
<ul>
|
|
55
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
55
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L346">src/client-options.ts:346</a></li></ul></aside></section>
|
|
56
56
|
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
57
57
|
<h3 class="tsd-anchor-link" id="count"><code class="tsd-tag">Optional</code><span>count</span><a href="#count" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
58
58
|
<div class="tsd-signature"><span class="tsd-kind-property">count</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
|
|
59
59
|
<p>Inherited from <a href="ReadOptions.html">ReadOptions</a>.<a href="ReadOptions.html#count">count</a></p>
|
|
60
60
|
<ul>
|
|
61
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
61
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L338">src/client-options.ts:338</a></li></ul></aside></section>
|
|
62
62
|
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
63
63
|
<h3 class="tsd-anchor-link" id="fromms"><code class="tsd-tag">Optional</code><span>from<wbr/>Ms</span><a href="#fromms" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
64
64
|
<div class="tsd-signature"><span class="tsd-kind-property">fromMs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
|
|
65
65
|
<p>Inherited from <a href="ReadOptions.html">ReadOptions</a>.<a href="ReadOptions.html#fromms">fromMs</a></p>
|
|
66
66
|
<ul>
|
|
67
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
67
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L339">src/client-options.ts:339</a></li></ul></aside></section>
|
|
68
68
|
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
69
69
|
<h3 class="tsd-anchor-link" id="includecold"><code class="tsd-tag">Optional</code><span>include<wbr/>Cold</span><a href="#includecold" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
70
70
|
<div class="tsd-signature"><span class="tsd-kind-property">includeCold</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
|
|
71
71
|
<p>Inherited from <a href="ReadOptions.html">ReadOptions</a>.<a href="ReadOptions.html#includecold">includeCold</a></p>
|
|
72
72
|
<ul>
|
|
73
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
73
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L345">src/client-options.ts:345</a></li></ul></aside></section>
|
|
74
74
|
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
75
75
|
<h3 class="tsd-anchor-link" id="partitionkey"><span>partition<wbr/>Key</span><a href="#partitionkey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
76
76
|
<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">
|
|
77
77
|
<p>Inherited from <a href="ReadOptions.html">ReadOptions</a>.<a href="ReadOptions.html#partitionkey">partitionKey</a></p>
|
|
78
78
|
<ul>
|
|
79
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
79
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L337">src/client-options.ts:337</a></li></ul></aside></section>
|
|
80
80
|
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
81
81
|
<h3 class="tsd-anchor-link" id="rev"><code class="tsd-tag">Optional</code><span>rev</span><a href="#rev" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
82
82
|
<div class="tsd-signature"><span class="tsd-kind-property">rev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
@@ -84,30 +84,30 @@
|
|
|
84
84
|
</div><aside class="tsd-sources">
|
|
85
85
|
<p>Inherited from <a href="ReadOptions.html">ReadOptions</a>.<a href="ReadOptions.html#rev">rev</a></p>
|
|
86
86
|
<ul>
|
|
87
|
-
<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#L342">src/client-options.ts:342</a></li></ul></aside></section>
|
|
88
88
|
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
89
89
|
<h3 class="tsd-anchor-link" id="state"><code class="tsd-tag">Optional</code><span>state</span><a href="#state" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
90
90
|
<div class="tsd-signature"><span class="tsd-kind-property">state</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
91
91
|
<p>Inherited from <a href="ReadOptions.html">ReadOptions</a>.<a href="ReadOptions.html#state">state</a></p>
|
|
92
92
|
<ul>
|
|
93
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
93
|
+
<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>
|
|
94
94
|
<section class="tsd-panel tsd-member">
|
|
95
95
|
<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>
|
|
96
96
|
<div class="tsd-signature"><span class="tsd-kind-property">stateMeta</span><span class="tsd-signature-symbol">?:</span> <a href="../types/SearchStateMeta.html" class="tsd-signature-type tsd-kind-type-alias">SearchStateMeta</a></div><aside class="tsd-sources">
|
|
97
97
|
<ul>
|
|
98
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
98
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L372">src/client-options.ts:372</a></li></ul></aside></section>
|
|
99
99
|
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
100
100
|
<h3 class="tsd-anchor-link" id="terminalonly"><code class="tsd-tag">Optional</code><span>terminal<wbr/>Only</span><a href="#terminalonly" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
101
101
|
<div class="tsd-signature"><span class="tsd-kind-property">terminalOnly</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
|
|
102
102
|
<p>Inherited from <a href="ReadOptions.html">ReadOptions</a>.<a href="ReadOptions.html#terminalonly">terminalOnly</a></p>
|
|
103
103
|
<ul>
|
|
104
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
104
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L344">src/client-options.ts:344</a></li></ul></aside></section>
|
|
105
105
|
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
106
106
|
<h3 class="tsd-anchor-link" id="toms"><code class="tsd-tag">Optional</code><span>to<wbr/>Ms</span><a href="#toms" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
107
107
|
<div class="tsd-signature"><span class="tsd-kind-property">toMs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
|
|
108
108
|
<p>Inherited from <a href="ReadOptions.html">ReadOptions</a>.<a href="ReadOptions.html#toms">toMs</a></p>
|
|
109
109
|
<ul>
|
|
110
|
-
<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#L340">src/client-options.ts:340</a></li></ul></aside></section></section></details></div>
|
|
111
111
|
<div class="col-sidebar">
|
|
112
112
|
<div class="page-menu">
|
|
113
113
|
<div class="tsd-navigation settings">
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
<li><a href="" aria-current="page">StepContinueOptions</a></li></ul>
|
|
12
12
|
<h1>Interface StepContinueOptions</h1></div>
|
|
13
13
|
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">StepContinueOptions</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="#fencingtoken">fencingToken</a><span class="tsd-signature-symbol">:</span> <a href="../types/FencingToken.html" class="tsd-signature-type tsd-kind-type-alias">FencingToken</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#fromstate">fromState</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="#leasems">leaseMs</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#leasetoken">leaseToken</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#nowms">nowMs</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#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="#returnjob">returnJob</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#statemeta">stateMeta</a><span class="tsd-signature-symbol">?:</span> <a href="../types/StateMeta.html" class="tsd-signature-type tsd-kind-type-alias">StateMeta</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#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="#type">type</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/> <a class="tsd-kind-property" href="#worker">worker</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
|
|
14
|
-
<section class="tsd-panel tsd-hierarchy" data-refl="
|
|
14
|
+
<section class="tsd-panel tsd-hierarchy" data-refl="1986">
|
|
15
15
|
<h4>Hierarchy</h4>
|
|
16
16
|
<ul class="tsd-hierarchy">
|
|
17
17
|
<li class="tsd-hierarchy-item"><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><a href="LeaseMutationOptions.html" class="tsd-signature-type tsd-kind-interface">LeaseMutationOptions</a><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">"returnRecord"</span><span class="tsd-signature-symbol">></span>
|
|
@@ -0,0 +1,159 @@
|
|
|
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>StepOptions | @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">StepOptions</a></li></ul>
|
|
12
|
+
<h1>Interface StepOptions<TResult></h1></div>
|
|
13
|
+
<section class="tsd-panel tsd-comment">
|
|
14
|
+
<div class="tsd-comment tsd-typography"><p>Options for a closure whose result is journaled with its state transition.</p>
|
|
15
|
+
</div></section>
|
|
16
|
+
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">StepOptions</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#tresult">TResult</a><span class="tsd-signature-symbol">></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="#name">name</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="#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="#run">run</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#tresult">TResult</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">PromiseLike</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#tresult">TResult</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#statemeta">stateMeta</a><span class="tsd-signature-symbol">?:</span> <a href="../types/StateMeta.html" class="tsd-signature-type tsd-kind-type-alias">StateMeta</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#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">
|
|
18
|
+
<h4>Type Parameters</h4>
|
|
19
|
+
<ul class="tsd-type-parameter-list">
|
|
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="1964">
|
|
22
|
+
<h4>Hierarchy (<a href="../hierarchy.html#StepOptions">View Summary</a>)</h4>
|
|
23
|
+
<ul class="tsd-hierarchy">
|
|
24
|
+
<li class="tsd-hierarchy-item"><a href="AdvanceOptions.html" class="tsd-signature-type tsd-kind-interface">AdvanceOptions</a>
|
|
25
|
+
<ul class="tsd-hierarchy">
|
|
26
|
+
<li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">StepOptions</span></li></ul></li></ul></section><aside class="tsd-sources">
|
|
27
|
+
<ul>
|
|
28
|
+
<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>
|
|
29
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
30
|
+
<section class="tsd-panel tsd-index-panel">
|
|
31
|
+
<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>
|
|
32
|
+
<h5 class="tsd-index-heading uppercase">Index</h5></summary>
|
|
33
|
+
<div class="tsd-accordion-details">
|
|
34
|
+
<section class="tsd-index-section">
|
|
35
|
+
<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>
|
|
36
|
+
<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>
|
|
37
|
+
<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>
|
|
38
|
+
<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>
|
|
39
|
+
<a href="#leasems" 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>lease<wbr/>Ms?</span></a>
|
|
40
|
+
<a href="#name" 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>name</span></a>
|
|
41
|
+
<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>
|
|
42
|
+
<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>
|
|
43
|
+
<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>
|
|
44
|
+
<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>
|
|
45
|
+
<a href="#run" 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>run</span></a>
|
|
46
|
+
<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>
|
|
47
|
+
<a href="#tostate" 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>to<wbr/>State</span></a>
|
|
48
|
+
<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>
|
|
49
|
+
<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>
|
|
50
|
+
</div></section></div></details></section></section>
|
|
51
|
+
<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>
|
|
52
|
+
<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>
|
|
53
|
+
<section>
|
|
54
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
55
|
+
<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>
|
|
56
|
+
<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">
|
|
57
|
+
<p>Inherited from <a href="MutateOptions.html">MutateOptions</a>.<a href="MutateOptions.html#attributesdelete">attributesDelete</a></p>
|
|
58
|
+
<ul>
|
|
59
|
+
<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>
|
|
60
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
61
|
+
<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>
|
|
62
|
+
<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">
|
|
63
|
+
<p>Inherited from <a href="MutateOptions.html">MutateOptions</a>.<a href="MutateOptions.html#attributesmerge">attributesMerge</a></p>
|
|
64
|
+
<ul>
|
|
65
|
+
<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>
|
|
66
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
67
|
+
<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>
|
|
68
|
+
<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">
|
|
69
|
+
<p>Inherited from <a href="MutateOptions.html">MutateOptions</a>.<a href="MutateOptions.html#dropvalues">dropValues</a></p>
|
|
70
|
+
<ul>
|
|
71
|
+
<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>
|
|
72
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
73
|
+
<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>
|
|
74
|
+
<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">
|
|
75
|
+
<p>Inherited from <a href="AdvanceOptions.html">AdvanceOptions</a>.<a href="AdvanceOptions.html#leasems">leaseMs</a></p>
|
|
76
|
+
<ul>
|
|
77
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L280">src/client-options.ts:280</a></li></ul></aside></section>
|
|
78
|
+
<section class="tsd-panel tsd-member">
|
|
79
|
+
<h3 class="tsd-anchor-link" id="name"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
80
|
+
<div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
81
|
+
<div class="tsd-comment tsd-typography"><p>Stable operation identity. Keep this unchanged across retries.</p>
|
|
82
|
+
</div><aside class="tsd-sources">
|
|
83
|
+
<ul>
|
|
84
|
+
<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>
|
|
85
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
86
|
+
<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>
|
|
87
|
+
<div class="tsd-signature"><span class="tsd-kind-property">nowMs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
|
|
88
|
+
<p>Inherited from <a href="MutateOptions.html">MutateOptions</a>.<a href="MutateOptions.html#nowms">nowMs</a></p>
|
|
89
|
+
<ul>
|
|
90
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L242">src/client-options.ts:242</a></li></ul></aside></section>
|
|
91
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
92
|
+
<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>
|
|
93
|
+
<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
|
+
<p>Inherited from <a href="MutateOptions.html">MutateOptions</a>.<a href="MutateOptions.html#overridevalues">overrideValues</a></p>
|
|
95
|
+
<ul>
|
|
96
|
+
<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>
|
|
97
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
98
|
+
<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>
|
|
99
|
+
<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">
|
|
100
|
+
<p>Inherited from <a href="MutateOptions.html">MutateOptions</a>.<a href="MutateOptions.html#partitionkey">partitionKey</a></p>
|
|
101
|
+
<ul>
|
|
102
|
+
<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>
|
|
103
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
104
|
+
<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>
|
|
105
|
+
<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">
|
|
106
|
+
<p>Inherited from <a href="MutateOptions.html">MutateOptions</a>.<a href="MutateOptions.html#payload">payload</a></p>
|
|
107
|
+
<ul>
|
|
108
|
+
<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>
|
|
109
|
+
<section class="tsd-panel tsd-member">
|
|
110
|
+
<h3 class="tsd-anchor-link" id="run"><span>run</span><a href="#run" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
111
|
+
<div class="tsd-signature"><span class="tsd-kind-property">run</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#tresult">TResult</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">PromiseLike</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#tresult">TResult</a><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources">
|
|
112
|
+
<ul>
|
|
113
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L287">src/client-options.ts:287</a></li></ul></aside></section>
|
|
114
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
115
|
+
<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>
|
|
116
|
+
<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">
|
|
117
|
+
<p>Inherited from <a href="MutateOptions.html">MutateOptions</a>.<a href="MutateOptions.html#statemeta">stateMeta</a></p>
|
|
118
|
+
<ul>
|
|
119
|
+
<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>
|
|
120
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
121
|
+
<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>
|
|
122
|
+
<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">
|
|
123
|
+
<p>Inherited from <a href="AdvanceOptions.html">AdvanceOptions</a>.<a href="AdvanceOptions.html#tostate">toState</a></p>
|
|
124
|
+
<ul>
|
|
125
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L279">src/client-options.ts:279</a></li></ul></aside></section>
|
|
126
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
127
|
+
<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>
|
|
128
|
+
<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">
|
|
129
|
+
<p>Inherited from <a href="MutateOptions.html">MutateOptions</a>.<a href="MutateOptions.html#valuerefs">valueRefs</a></p>
|
|
130
|
+
<ul>
|
|
131
|
+
<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>
|
|
132
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
133
|
+
<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>
|
|
134
|
+
<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">
|
|
135
|
+
<p>Inherited from <a href="MutateOptions.html">MutateOptions</a>.<a href="MutateOptions.html#values">values</a></p>
|
|
136
|
+
<ul>
|
|
137
|
+
<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>
|
|
138
|
+
<div class="col-sidebar">
|
|
139
|
+
<div class="page-menu">
|
|
140
|
+
<div class="tsd-navigation settings">
|
|
141
|
+
<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>
|
|
142
|
+
<h3>Settings</h3></summary>
|
|
143
|
+
<div class="tsd-accordion-details">
|
|
144
|
+
<div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
|
|
145
|
+
<ul id="tsd-filter-options">
|
|
146
|
+
<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>
|
|
147
|
+
<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>
|
|
148
|
+
<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>
|
|
149
|
+
<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>
|
|
150
|
+
<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>
|
|
151
|
+
<h3>On This Page</h3></summary>
|
|
152
|
+
<div class="tsd-accordion-details">
|
|
153
|
+
<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>
|
|
154
|
+
<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" 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>lease<wbr/>Ms</span></a><a href="#name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#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="#run"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>run</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" 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>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>
|
|
155
|
+
<div class="site-menu">
|
|
156
|
+
<nav class="tsd-navigation"><a href="../modules.html">@ferricstore/ferricstore</a>
|
|
157
|
+
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
158
|
+
<li>Loading...</li></ul></nav></div></div></div><footer></footer>
|
|
159
|
+
<div class="overlay"></div></body></html>
|
|
@@ -0,0 +1,67 @@
|
|
|
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>StepResult | @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">StepResult</a></li></ul>
|
|
12
|
+
<h1>Interface StepResult<TResult></h1></div>
|
|
13
|
+
<section class="tsd-panel tsd-comment">
|
|
14
|
+
<div class="tsd-comment tsd-typography"><p>The renewed claim and durable result returned by a durable <code>step()</code> call.</p>
|
|
15
|
+
</div></section>
|
|
16
|
+
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">StepResult</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#tresult">TResult</a><span class="tsd-signature-symbol">></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="#result">result</a><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#tresult">TResult</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
|
|
17
|
+
<section class="tsd-panel">
|
|
18
|
+
<h4>Type Parameters</h4>
|
|
19
|
+
<ul class="tsd-type-parameter-list">
|
|
20
|
+
<li><span id="tresult"><span class="tsd-kind-type-parameter">TResult</span></span></li></ul></section><aside class="tsd-sources">
|
|
21
|
+
<ul>
|
|
22
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L291">src/client-options.ts:291</a></li></ul></aside>
|
|
23
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
24
|
+
<section class="tsd-panel tsd-index-panel">
|
|
25
|
+
<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>
|
|
26
|
+
<h5 class="tsd-index-heading uppercase">Index</h5></summary>
|
|
27
|
+
<div class="tsd-accordion-details">
|
|
28
|
+
<section class="tsd-index-section">
|
|
29
|
+
<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>
|
|
30
|
+
<div class="tsd-index-list"><a href="#job" 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>job</span></a>
|
|
31
|
+
<a href="#result" 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>result</span></a>
|
|
32
|
+
</div></section></div></details></section></section>
|
|
33
|
+
<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>
|
|
34
|
+
<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>
|
|
35
|
+
<section>
|
|
36
|
+
<section class="tsd-panel tsd-member">
|
|
37
|
+
<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>
|
|
38
|
+
<div class="tsd-signature"><span class="tsd-kind-property">job</span><span class="tsd-signature-symbol">:</span> <a href="ClaimedItem.html" class="tsd-signature-type tsd-kind-interface">ClaimedItem</a></div><aside class="tsd-sources">
|
|
39
|
+
<ul>
|
|
40
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L292">src/client-options.ts:292</a></li></ul></aside></section>
|
|
41
|
+
<section class="tsd-panel tsd-member">
|
|
42
|
+
<h3 class="tsd-anchor-link" id="result"><code class="tsd-tag">Readonly</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>
|
|
43
|
+
<div class="tsd-signature"><span class="tsd-kind-property">result</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#tresult">TResult</a></div><aside class="tsd-sources">
|
|
44
|
+
<ul>
|
|
45
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L293">src/client-options.ts:293</a></li></ul></aside></section></section></details></div>
|
|
46
|
+
<div class="col-sidebar">
|
|
47
|
+
<div class="page-menu">
|
|
48
|
+
<div class="tsd-navigation settings">
|
|
49
|
+
<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>
|
|
50
|
+
<h3>Settings</h3></summary>
|
|
51
|
+
<div class="tsd-accordion-details">
|
|
52
|
+
<div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
|
|
53
|
+
<ul id="tsd-filter-options">
|
|
54
|
+
<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>
|
|
55
|
+
<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>
|
|
56
|
+
<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>
|
|
57
|
+
<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>
|
|
58
|
+
<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>
|
|
59
|
+
<h3>On This Page</h3></summary>
|
|
60
|
+
<div class="tsd-accordion-details">
|
|
61
|
+
<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>
|
|
62
|
+
<div><a href="#job"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>job</span></a><a href="#result"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>result</span></a></div></details></div></details></div>
|
|
63
|
+
<div class="site-menu">
|
|
64
|
+
<nav class="tsd-navigation"><a href="../modules.html">@ferricstore/ferricstore</a>
|
|
65
|
+
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
66
|
+
<li>Loading...</li></ul></nav></div></div></div><footer></footer>
|
|
67
|
+
<div class="overlay"></div></body></html>
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
<li><a href="" aria-current="page">TDigestCreateOptions</a></li></ul>
|
|
12
12
|
<h1>Interface TDigestCreateOptions</h1></div>
|
|
13
13
|
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">TDigestCreateOptions</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#compression">compression</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
|
|
14
|
-
<section class="tsd-panel tsd-hierarchy" data-refl="
|
|
14
|
+
<section class="tsd-panel tsd-hierarchy" data-refl="3280">
|
|
15
15
|
<h4>Hierarchy (<a href="../hierarchy.html#TDigestCreateOptions">View Summary</a>)</h4>
|
|
16
16
|
<ul class="tsd-hierarchy">
|
|
17
17
|
<li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">TDigestCreateOptions</span>
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
<li><a href="" aria-current="page">TDigestMergeOptions</a></li></ul>
|
|
12
12
|
<h1>Interface TDigestMergeOptions</h1></div>
|
|
13
13
|
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">TDigestMergeOptions</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#compression">compression</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="#override">override</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
|
|
14
|
-
<section class="tsd-panel tsd-hierarchy" data-refl="
|
|
14
|
+
<section class="tsd-panel tsd-hierarchy" data-refl="3282">
|
|
15
15
|
<h4>Hierarchy (<a href="../hierarchy.html#TDigestMergeOptions">View Summary</a>)</h4>
|
|
16
16
|
<ul class="tsd-hierarchy">
|
|
17
17
|
<li class="tsd-hierarchy-item"><a href="TDigestCreateOptions.html" class="tsd-signature-type tsd-kind-interface">TDigestCreateOptions</a>
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
<li><a href="" aria-current="page">TransitionOptions</a></li></ul>
|
|
12
12
|
<h1>Interface TransitionOptions</h1></div>
|
|
13
13
|
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">TransitionOptions</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="#fencingtoken">fencingToken</a><span class="tsd-signature-symbol">:</span> <a href="../types/FencingToken.html" class="tsd-signature-type tsd-kind-type-alias">FencingToken</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#fromstate">fromState</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="#leasetoken">leaseToken</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#nowms">nowMs</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#overridevalues">overrideValues</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#partitionkey">partitionKey</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#payload">payload</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#priority">priority</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#returnrecord">returnRecord</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#runatms">runAtMs</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="#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>
|
|
14
|
-
<section class="tsd-panel tsd-hierarchy" data-refl="
|
|
14
|
+
<section class="tsd-panel tsd-hierarchy" data-refl="2005">
|
|
15
15
|
<h4>Hierarchy (<a href="../hierarchy.html#TransitionOptions">View Summary</a>)</h4>
|
|
16
16
|
<ul class="tsd-hierarchy">
|
|
17
17
|
<li class="tsd-hierarchy-item"><a href="LeaseMutationOptions.html" class="tsd-signature-type tsd-kind-interface">LeaseMutationOptions</a>
|