@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
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
<ul class="tsd-hierarchy">
|
|
19
19
|
<li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">RetryOptions</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#L329">src/client-options.ts:329</a></li></ul></aside>
|
|
22
22
|
<section class="tsd-panel-group tsd-index-group">
|
|
23
23
|
<section class="tsd-panel tsd-index-panel">
|
|
24
24
|
<details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
@@ -67,25 +67,29 @@
|
|
|
67
67
|
<h3 class="tsd-anchor-link" id="error"><code class="tsd-tag">Optional</code><span>error</span><a href="#error" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
68
68
|
<div class="tsd-signature"><span class="tsd-kind-property">error</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span></div><aside class="tsd-sources">
|
|
69
69
|
<ul>
|
|
70
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
70
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L330">src/client-options.ts:330</a></li></ul></aside></section>
|
|
71
71
|
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
72
72
|
<h3 class="tsd-anchor-link" id="fencingtoken"><span>fencing<wbr/>Token</span><a href="#fencingtoken" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
73
73
|
<div class="tsd-signature"><span class="tsd-kind-property">fencingToken</span><span class="tsd-signature-symbol">:</span> <a href="../types/FencingToken.html" class="tsd-signature-type tsd-kind-type-alias">FencingToken</a></div><aside class="tsd-sources">
|
|
74
74
|
<p>Inherited from <a href="LeaseMutationOptions.html">LeaseMutationOptions</a>.<a href="LeaseMutationOptions.html#fencingtoken">fencingToken</a></p>
|
|
75
75
|
<ul>
|
|
76
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
76
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L253">src/client-options.ts:253</a></li></ul></aside></section>
|
|
77
77
|
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
78
78
|
<h3 class="tsd-anchor-link" id="leasetoken"><span>lease<wbr/>Token</span><a href="#leasetoken" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
79
79
|
<div class="tsd-signature"><span class="tsd-kind-property">leaseToken</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Buffer</span></div><aside class="tsd-sources">
|
|
80
80
|
<p>Inherited from <a href="LeaseMutationOptions.html">LeaseMutationOptions</a>.<a href="LeaseMutationOptions.html#leasetoken">leaseToken</a></p>
|
|
81
81
|
<ul>
|
|
82
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
82
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L252">src/client-options.ts:252</a></li></ul></aside></section>
|
|
83
83
|
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
84
84
|
<h3 class="tsd-anchor-link" id="nowms"><code class="tsd-tag">Optional</code><span>now<wbr/>Ms</span><a href="#nowms" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
85
|
-
<div class="tsd-signature"><span class="tsd-kind-property">nowMs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div
|
|
85
|
+
<div class="tsd-signature"><span class="tsd-kind-property">nowMs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
|
|
86
|
+
<div class="tsd-comment tsd-typography"><p>Explicit client-supplied command timestamp. Omit in production so each
|
|
87
|
+
request samples the current client wall clock; primarily useful for tests.
|
|
88
|
+
This is not the server response time or the client transport deadline.</p>
|
|
89
|
+
</div><aside class="tsd-sources">
|
|
86
90
|
<p>Inherited from <a href="LeaseMutationOptions.html">LeaseMutationOptions</a>.<a href="LeaseMutationOptions.html#nowms">nowMs</a></p>
|
|
87
91
|
<ul>
|
|
88
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
92
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L247">src/client-options.ts:247</a></li></ul></aside></section>
|
|
89
93
|
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
90
94
|
<h3 class="tsd-anchor-link" id="overridevalues"><code class="tsd-tag">Optional</code><span>override<wbr/>Values</span><a href="#overridevalues" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
91
95
|
<div class="tsd-signature"><span class="tsd-kind-property">overrideValues</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
|
|
@@ -109,12 +113,12 @@
|
|
|
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">
|
|
114
118
|
<h3 class="tsd-anchor-link" id="runatms"><code class="tsd-tag">Optional</code><span>run<wbr/>At<wbr/>Ms</span><a href="#runatms" 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">runAtMs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
|
|
116
120
|
<ul>
|
|
117
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
121
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L331">src/client-options.ts:331</a></li></ul></aside></section>
|
|
118
122
|
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
119
123
|
<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>
|
|
120
124
|
<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">
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
<li><a href="" aria-current="page">RetryOutcome</a></li></ul>
|
|
12
12
|
<h1>Interface RetryOutcome</h1></div>
|
|
13
13
|
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">RetryOutcome</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="#error">error</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#kind">kind</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"retry"</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="#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="#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="2860">
|
|
15
15
|
<h4>Hierarchy (<a href="../hierarchy.html#RetryOutcome">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>
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
<h1>Interface RunStepsItem</h1></div>
|
|
13
13
|
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">RunStepsItem</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#id">id</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="#partitionkey">partitionKey</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources">
|
|
14
14
|
<ul>
|
|
15
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
15
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L306">src/client-options.ts:306</a></li></ul></aside>
|
|
16
16
|
<section class="tsd-panel-group tsd-index-group">
|
|
17
17
|
<section class="tsd-panel tsd-index-panel">
|
|
18
18
|
<details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
@@ -30,12 +30,12 @@
|
|
|
30
30
|
<h3 class="tsd-anchor-link" id="id"><span>id</span><a href="#id" 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>
|
|
31
31
|
<div class="tsd-signature"><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
32
32
|
<ul>
|
|
33
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
33
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L307">src/client-options.ts:307</a></li></ul></aside></section>
|
|
34
34
|
<section class="tsd-panel tsd-member">
|
|
35
35
|
<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>
|
|
36
36
|
<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">
|
|
37
37
|
<ul>
|
|
38
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
38
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L308">src/client-options.ts:308</a></li></ul></aside></section></section></details></div>
|
|
39
39
|
<div class="col-sidebar">
|
|
40
40
|
<div class="page-menu">
|
|
41
41
|
<div class="tsd-navigation settings">
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
<h1>Interface RunStepsManyOptions</h1></div>
|
|
13
13
|
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">RunStepsManyOptions</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#leasems">leaseMs</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#nowms">nowMs</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#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="#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="#retentionttlms">retentionTtlMs</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="#states">states</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-keyword">readonly</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#steps">steps</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="#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="#worker">worker</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources">
|
|
14
14
|
<ul>
|
|
15
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
15
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L311">src/client-options.ts:311</a></li></ul></aside>
|
|
16
16
|
<section class="tsd-panel-group tsd-index-group">
|
|
17
17
|
<section class="tsd-panel tsd-index-panel">
|
|
18
18
|
<details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
@@ -38,52 +38,52 @@
|
|
|
38
38
|
<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>
|
|
39
39
|
<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">
|
|
40
40
|
<ul>
|
|
41
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
41
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L316">src/client-options.ts:316</a></li></ul></aside></section>
|
|
42
42
|
<section class="tsd-panel tsd-member">
|
|
43
43
|
<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>
|
|
44
44
|
<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">
|
|
45
45
|
<ul>
|
|
46
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
46
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L317">src/client-options.ts:317</a></li></ul></aside></section>
|
|
47
47
|
<section class="tsd-panel tsd-member">
|
|
48
48
|
<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>
|
|
49
49
|
<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">
|
|
50
50
|
<ul>
|
|
51
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
51
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L320">src/client-options.ts:320</a></li></ul></aside></section>
|
|
52
52
|
<section class="tsd-panel tsd-member">
|
|
53
53
|
<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>
|
|
54
54
|
<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">
|
|
55
55
|
<ul>
|
|
56
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
56
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L318">src/client-options.ts:318</a></li></ul></aside></section>
|
|
57
57
|
<section class="tsd-panel tsd-member">
|
|
58
58
|
<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>
|
|
59
59
|
<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">
|
|
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#L319">src/client-options.ts:319</a></li></ul></aside></section>
|
|
62
62
|
<section class="tsd-panel tsd-member">
|
|
63
63
|
<h3 class="tsd-anchor-link" id="retentionttlms"><code class="tsd-tag">Optional</code><span>retention<wbr/>Ttl<wbr/>Ms</span><a href="#retentionttlms" 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">retentionTtlMs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
|
|
65
65
|
<ul>
|
|
66
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
66
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L321">src/client-options.ts:321</a></li></ul></aside></section>
|
|
67
67
|
<section class="tsd-panel tsd-member">
|
|
68
68
|
<h3 class="tsd-anchor-link" id="states"><code class="tsd-tag">Optional</code><span>states</span><a href="#states" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
69
69
|
<div class="tsd-signature"><span class="tsd-kind-property">states</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-keyword">readonly</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
|
|
70
70
|
<ul>
|
|
71
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
71
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L313">src/client-options.ts:313</a></li></ul></aside></section>
|
|
72
72
|
<section class="tsd-panel tsd-member">
|
|
73
73
|
<h3 class="tsd-anchor-link" id="steps"><code class="tsd-tag">Optional</code><span>steps</span><a href="#steps" 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">steps</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
|
|
75
75
|
<ul>
|
|
76
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
76
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L314">src/client-options.ts:314</a></li></ul></aside></section>
|
|
77
77
|
<section class="tsd-panel tsd-member">
|
|
78
78
|
<h3 class="tsd-anchor-link" id="type"><span>type</span><a href="#type" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
79
79
|
<div class="tsd-signature"><span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
80
80
|
<ul>
|
|
81
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
81
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L312">src/client-options.ts:312</a></li></ul></aside></section>
|
|
82
82
|
<section class="tsd-panel tsd-member">
|
|
83
83
|
<h3 class="tsd-anchor-link" id="worker"><span>worker</span><a href="#worker" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
84
84
|
<div class="tsd-signature"><span class="tsd-kind-property">worker</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
85
85
|
<ul>
|
|
86
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
86
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L315">src/client-options.ts:315</a></li></ul></aside></section></section></details></div>
|
|
87
87
|
<div class="col-sidebar">
|
|
88
88
|
<div class="page-menu">
|
|
89
89
|
<div class="tsd-navigation settings">
|
|
@@ -18,7 +18,7 @@
|
|
|
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#L380">src/client-options.ts:380</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#L381">src/client-options.ts:381</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#L356">src/client-options.ts:356</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#L348">src/client-options.ts:348</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#L349">src/client-options.ts:349</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#L355">src/client-options.ts:355</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#L347">src/client-options.ts:347</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#L352">src/client-options.ts:352</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#L353">src/client-options.ts:353</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#L382">src/client-options.ts:382</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#L354">src/client-options.ts:354</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#L350">src/client-options.ts:350</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">
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
<ul class="tsd-hierarchy">
|
|
19
19
|
<li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">StepContinueOptions</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#L273">src/client-options.ts:273</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>
|
|
@@ -71,29 +71,33 @@
|
|
|
71
71
|
<div class="tsd-signature"><span class="tsd-kind-property">fencingToken</span><span class="tsd-signature-symbol">:</span> <a href="../types/FencingToken.html" class="tsd-signature-type tsd-kind-type-alias">FencingToken</a></div><aside class="tsd-sources">
|
|
72
72
|
<p>Inherited from <a href="LeaseMutationOptions.html">LeaseMutationOptions</a>.<a href="LeaseMutationOptions.html#fencingtoken">fencingToken</a></p>
|
|
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#L253">src/client-options.ts:253</a></li></ul></aside></section>
|
|
75
75
|
<section class="tsd-panel tsd-member">
|
|
76
76
|
<h3 class="tsd-anchor-link" id="fromstate"><span>from<wbr/>State</span><a href="#fromstate" 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
77
|
<div class="tsd-signature"><span class="tsd-kind-property">fromState</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
78
78
|
<ul>
|
|
79
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
79
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L274">src/client-options.ts:274</a></li></ul></aside></section>
|
|
80
80
|
<section class="tsd-panel tsd-member">
|
|
81
81
|
<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>
|
|
82
82
|
<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">
|
|
83
83
|
<ul>
|
|
84
|
-
<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#L276">src/client-options.ts:276</a></li></ul></aside></section>
|
|
85
85
|
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
86
86
|
<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>
|
|
87
87
|
<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">
|
|
88
88
|
<p>Inherited from <a href="LeaseMutationOptions.html">LeaseMutationOptions</a>.<a href="LeaseMutationOptions.html#leasetoken">leaseToken</a></p>
|
|
89
89
|
<ul>
|
|
90
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
90
|
+
<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>
|
|
91
91
|
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
92
92
|
<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>
|
|
93
|
-
<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
|
|
93
|
+
<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>
|
|
94
|
+
<div class="tsd-comment tsd-typography"><p>Explicit client-supplied command timestamp. Omit in production so each
|
|
95
|
+
request samples the current client wall clock; primarily useful for tests.
|
|
96
|
+
This is not the server response time or the client transport deadline.</p>
|
|
97
|
+
</div><aside class="tsd-sources">
|
|
94
98
|
<p>Inherited from <a href="MutateOptions.html">MutateOptions</a>.<a href="MutateOptions.html#nowms">nowMs</a></p>
|
|
95
99
|
<ul>
|
|
96
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
100
|
+
<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>
|
|
97
101
|
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
98
102
|
<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>
|
|
99
103
|
<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">
|
|
@@ -116,7 +120,7 @@
|
|
|
116
120
|
<h3 class="tsd-anchor-link" id="returnjob"><code class="tsd-tag">Optional</code><span>return<wbr/>Job</span><a href="#returnjob" 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">returnJob</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
|
|
118
122
|
<ul>
|
|
119
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
123
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L278">src/client-options.ts:278</a></li></ul></aside></section>
|
|
120
124
|
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
121
125
|
<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>
|
|
122
126
|
<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">
|
|
@@ -127,14 +131,14 @@
|
|
|
127
131
|
<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>
|
|
128
132
|
<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">
|
|
129
133
|
<ul>
|
|
130
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
134
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L275">src/client-options.ts:275</a></li></ul></aside></section>
|
|
131
135
|
<section class="tsd-panel tsd-member">
|
|
132
136
|
<h3 class="tsd-anchor-link" id="type"><code class="tsd-tag">Optional</code><span>type</span><a href="#type" 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>
|
|
133
137
|
<div class="tsd-signature"><span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
134
138
|
<div class="tsd-comment tsd-typography"><p>Flow type to retain when returnJob requests a compact response.</p>
|
|
135
139
|
</div><aside class="tsd-sources">
|
|
136
140
|
<ul>
|
|
137
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
141
|
+
<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>
|
|
138
142
|
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
139
143
|
<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>
|
|
140
144
|
<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">
|
|
@@ -151,7 +155,7 @@
|
|
|
151
155
|
<h3 class="tsd-anchor-link" id="worker"><code class="tsd-tag">Optional</code><span>worker</span><a href="#worker" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
152
156
|
<div class="tsd-signature"><span class="tsd-kind-property">worker</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
153
157
|
<ul>
|
|
154
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
158
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L277">src/client-options.ts:277</a></li></ul></aside></section></section></details></div>
|
|
155
159
|
<div class="col-sidebar">
|
|
156
160
|
<div class="page-menu">
|
|
157
161
|
<div class="tsd-navigation settings">
|
|
@@ -25,7 +25,7 @@
|
|
|
25
25
|
<ul class="tsd-hierarchy">
|
|
26
26
|
<li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">StepOptions</span></li></ul></li></ul></section><aside class="tsd-sources">
|
|
27
27
|
<ul>
|
|
28
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
28
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L290">src/client-options.ts:290</a></li></ul></aside>
|
|
29
29
|
<section class="tsd-panel-group tsd-index-group">
|
|
30
30
|
<section class="tsd-panel tsd-index-panel">
|
|
31
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>
|
|
@@ -74,20 +74,24 @@
|
|
|
74
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
75
|
<p>Inherited from <a href="AdvanceOptions.html">AdvanceOptions</a>.<a href="AdvanceOptions.html#leasems">leaseMs</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#L286">src/client-options.ts:286</a></li></ul></aside></section>
|
|
78
78
|
<section class="tsd-panel tsd-member">
|
|
79
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
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
81
|
<div class="tsd-comment tsd-typography"><p>Stable operation identity. Keep this unchanged across retries.</p>
|
|
82
82
|
</div><aside class="tsd-sources">
|
|
83
83
|
<ul>
|
|
84
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
84
|
+
<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>
|
|
85
85
|
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
86
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
|
|
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>
|
|
88
|
+
<div class="tsd-comment tsd-typography"><p>Explicit client-supplied command timestamp. Omit in production so each
|
|
89
|
+
request samples the current client wall clock; primarily useful for tests.
|
|
90
|
+
This is not the server response time or the client transport deadline.</p>
|
|
91
|
+
</div><aside class="tsd-sources">
|
|
88
92
|
<p>Inherited from <a href="MutateOptions.html">MutateOptions</a>.<a href="MutateOptions.html#nowms">nowMs</a></p>
|
|
89
93
|
<ul>
|
|
90
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
94
|
+
<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>
|
|
91
95
|
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
92
96
|
<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
97
|
<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">
|
|
@@ -108,9 +112,12 @@
|
|
|
108
112
|
<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
113
|
<section class="tsd-panel tsd-member">
|
|
110
114
|
<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
|
|
115
|
+
<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>
|
|
116
|
+
<div class="tsd-comment tsd-typography"><p>Runs directly in the caller or worker's JavaScript execution context. The
|
|
117
|
+
SDK awaits its result and does not submit it to a global thread pool.</p>
|
|
118
|
+
</div><aside class="tsd-sources">
|
|
112
119
|
<ul>
|
|
113
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
120
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L297">src/client-options.ts:297</a></li></ul></aside></section>
|
|
114
121
|
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
115
122
|
<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
123
|
<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">
|
|
@@ -122,7 +129,7 @@
|
|
|
122
129
|
<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
130
|
<p>Inherited from <a href="AdvanceOptions.html">AdvanceOptions</a>.<a href="AdvanceOptions.html#tostate">toState</a></p>
|
|
124
131
|
<ul>
|
|
125
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
132
|
+
<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>
|
|
126
133
|
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
127
134
|
<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
135
|
<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">
|
|
@@ -19,7 +19,7 @@
|
|
|
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><aside class="tsd-sources">
|
|
21
21
|
<ul>
|
|
22
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
22
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L301">src/client-options.ts:301</a></li></ul></aside>
|
|
23
23
|
<section class="tsd-panel-group tsd-index-group">
|
|
24
24
|
<section class="tsd-panel tsd-index-panel">
|
|
25
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>
|
|
@@ -37,12 +37,12 @@
|
|
|
37
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
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
39
|
<ul>
|
|
40
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
40
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L302">src/client-options.ts:302</a></li></ul></aside></section>
|
|
41
41
|
<section class="tsd-panel tsd-member">
|
|
42
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
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
44
|
<ul>
|
|
45
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#
|
|
45
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/client-options.ts#L303">src/client-options.ts:303</a></li></ul></aside></section></section></details></div>
|
|
46
46
|
<div class="col-sidebar">
|
|
47
47
|
<div class="page-menu">
|
|
48
48
|
<div class="tsd-navigation settings">
|
|
@@ -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="3309">
|
|
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="3311">
|
|
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>
|