@ferricstore/ferricstore 0.13.1 → 0.13.3
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 +16 -4
- package/dist/index.cjs +8 -2
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +2 -1
- package/dist/index.d.ts +2 -1
- package/dist/index.js +8 -2
- package/dist/index.js.map +1 -1
- package/docs/api/assets/hierarchy.js +1 -1
- package/docs/api/classes/ConnectionClosedError.html +1 -1
- package/docs/api/classes/FerricStoreClient.html +23 -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 +1 -1
- 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/RequestNotSentError.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/hierarchy.html +52 -52
- package/docs/api/index.html +14 -4
- package/docs/api/interfaces/AdminListOptions.html +1 -1
- package/docs/api/interfaces/AdvanceOptions.html +1 -1
- package/docs/api/interfaces/AlreadyAppliedOutcome.html +1 -1
- package/docs/api/interfaces/AppliedStepOutcome.html +1 -1
- package/docs/api/interfaces/CancelOptions.html +1 -1
- package/docs/api/interfaces/CompleteOptions.html +1 -1
- package/docs/api/interfaces/CompleteOutcome.html +1 -1
- 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 +1 -1
- package/docs/api/interfaces/FailOutcome.html +1 -1
- 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/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 +1 -1
- package/docs/api/interfaces/ReadOptions.html +1 -1
- package/docs/api/interfaces/ReclaimOptions.html +1 -1
- package/docs/api/interfaces/RequestContextOptions.html +1 -1
- package/docs/api/interfaces/RetryOptions.html +1 -1
- package/docs/api/interfaces/RetryOutcome.html +1 -1
- package/docs/api/interfaces/SearchOptions.html +1 -1
- package/docs/api/interfaces/StepContinueOptions.html +1 -1
- package/docs/api/interfaces/StepOptions.html +1 -1
- 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 +1 -1
- package/docs/api/media/design.md +10 -0
- package/docs/api/variables/FERRICSTORE_SDK_VERSION.html +1 -1
- package/docs/design.md +10 -0
- package/package.json +2 -2
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
<li><a href="" aria-current="page">FerricStoreClientOptions</a></li></ul>
|
|
12
12
|
<h1>Interface FerricStoreClientOptions</h1></div>
|
|
13
13
|
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">FerricStoreClientOptions</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#autobatch">autoBatch</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">|</span> <a href="AutoBatchOptions.html" class="tsd-signature-type tsd-kind-interface">AutoBatchOptions</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#backpressure">backpressure</a><span class="tsd-signature-symbol">?:</span> <a href="BackpressurePolicy.html" class="tsd-signature-type tsd-kind-interface">BackpressurePolicy</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#codec">codec</a><span class="tsd-signature-symbol">?:</span> <a href="Codec.html" class="tsd-signature-type tsd-kind-interface">Codec</a><span class="tsd-signature-symbol"><</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="#flowmanybatchlimit">flowManyBatchLimit</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#legacyclaimhydrationconcurrency">legacyClaimHydrationConcurrency</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
|
|
14
|
-
<section class="tsd-panel tsd-hierarchy" data-refl="
|
|
14
|
+
<section class="tsd-panel tsd-hierarchy" data-refl="1691">
|
|
15
15
|
<h4>Hierarchy (<a href="../hierarchy.html#FerricStoreClientOptions">View Summary</a>)</h4>
|
|
16
16
|
<ul class="tsd-hierarchy">
|
|
17
17
|
<li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">FerricStoreClientOptions</span>
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
<li><a href="" aria-current="page">FlowQueryCountResult</a></li></ul>
|
|
12
12
|
<h1>Interface FlowQueryCountResult</h1></div>
|
|
13
13
|
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">FlowQueryCountResult</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#count">count</a><span class="tsd-signature-symbol">:</span> <a href="../types/FlowQueryInteger.html" class="tsd-signature-type tsd-kind-type-alias">FlowQueryInteger</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#kind">kind</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"count"</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#quality">quality</a><span class="tsd-signature-symbol">:</span> <a href="FlowQueryQuality.html" class="tsd-signature-type tsd-kind-interface">FlowQueryQuality</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#raw">raw</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</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><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#usage">usage</a><span class="tsd-signature-symbol">:</span> <a href="FlowQueryUsage.html" class="tsd-signature-type tsd-kind-interface">FlowQueryUsage</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#version">version</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ferric.flow.query.result/v1"</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="2111">
|
|
15
15
|
<h4>Hierarchy</h4>
|
|
16
16
|
<ul class="tsd-hierarchy">
|
|
17
17
|
<li class="tsd-hierarchy-item"><span class="tsd-signature-type">FlowQueryResultBase</span>
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
<li><a href="" aria-current="page">FlowQueryIndexBuild</a></li></ul>
|
|
12
12
|
<h1>Interface FlowQueryIndexBuild</h1></div>
|
|
13
13
|
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">FlowQueryIndexBuild</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#completedshards">completedShards</a><span class="tsd-signature-symbol">:</span> <a href="../types/FlowQueryInteger.html" class="tsd-signature-type tsd-kind-type-alias">FlowQueryInteger</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#currentphases">currentPhases</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">readonly</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#phasecounts">phaseCounts</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</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/FlowQueryInteger.html" class="tsd-signature-type tsd-kind-type-alias">FlowQueryInteger</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#raw">raw</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</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><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#scannedrecords">scannedRecords</a><span class="tsd-signature-symbol">:</span> <a href="../types/FlowQueryInteger.html" class="tsd-signature-type tsd-kind-type-alias">FlowQueryInteger</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#scope">scope</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"catalog_build"</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#totalshards">totalShards</a><span class="tsd-signature-symbol">:</span> <a href="../types/FlowQueryInteger.html" class="tsd-signature-type tsd-kind-type-alias">FlowQueryInteger</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#writtenbytes">writtenBytes</a><span class="tsd-signature-symbol">:</span> <a href="../types/FlowQueryInteger.html" class="tsd-signature-type tsd-kind-type-alias">FlowQueryInteger</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#writtenentries">writtenEntries</a><span class="tsd-signature-symbol">:</span> <a href="../types/FlowQueryInteger.html" class="tsd-signature-type tsd-kind-type-alias">FlowQueryInteger</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
|
|
14
|
-
<section class="tsd-panel tsd-hierarchy" data-refl="
|
|
14
|
+
<section class="tsd-panel tsd-hierarchy" data-refl="2140">
|
|
15
15
|
<h4>Hierarchy (<a href="../hierarchy.html#FlowQueryIndexBuild">View Summary</a>)</h4>
|
|
16
16
|
<ul class="tsd-hierarchy">
|
|
17
17
|
<li class="tsd-hierarchy-item"><a href="FlowQueryIndexProgress.html" class="tsd-signature-type tsd-kind-interface">FlowQueryIndexProgress</a>
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
<li><a href="" aria-current="page">FlowQueryIndexProgress</a></li></ul>
|
|
12
12
|
<h1>Interface FlowQueryIndexProgress</h1></div>
|
|
13
13
|
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">FlowQueryIndexProgress</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#completedshards">completedShards</a><span class="tsd-signature-symbol">:</span> <a href="../types/FlowQueryInteger.html" class="tsd-signature-type tsd-kind-type-alias">FlowQueryInteger</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#currentphases">currentPhases</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">readonly</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#phasecounts">phaseCounts</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</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/FlowQueryInteger.html" class="tsd-signature-type tsd-kind-type-alias">FlowQueryInteger</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#raw">raw</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</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><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#scope">scope</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"catalog_build"</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#totalshards">totalShards</a><span class="tsd-signature-symbol">:</span> <a href="../types/FlowQueryInteger.html" class="tsd-signature-type tsd-kind-type-alias">FlowQueryInteger</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
|
|
14
|
-
<section class="tsd-panel tsd-hierarchy" data-refl="
|
|
14
|
+
<section class="tsd-panel tsd-hierarchy" data-refl="2168">
|
|
15
15
|
<h4>Hierarchy (<a href="../hierarchy.html#FlowQueryIndexProgress">View Summary</a>)</h4>
|
|
16
16
|
<ul class="tsd-hierarchy">
|
|
17
17
|
<li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">FlowQueryIndexProgress</span>
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
<li><a href="" aria-current="page">FlowQueryIndexValidation</a></li></ul>
|
|
12
12
|
<h1>Interface FlowQueryIndexValidation</h1></div>
|
|
13
13
|
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">FlowQueryIndexValidation</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#checkedentries">checkedEntries</a><span class="tsd-signature-symbol">:</span> <a href="../types/FlowQueryInteger.html" class="tsd-signature-type tsd-kind-type-alias">FlowQueryInteger</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#checkedrecords">checkedRecords</a><span class="tsd-signature-symbol">:</span> <a href="../types/FlowQueryInteger.html" class="tsd-signature-type tsd-kind-type-alias">FlowQueryInteger</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#completedshards">completedShards</a><span class="tsd-signature-symbol">:</span> <a href="../types/FlowQueryInteger.html" class="tsd-signature-type tsd-kind-type-alias">FlowQueryInteger</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#currentphases">currentPhases</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">readonly</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#failurereason">failureReason</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#mismatches">mismatches</a><span class="tsd-signature-symbol">:</span> <a href="../types/FlowQueryInteger.html" class="tsd-signature-type tsd-kind-type-alias">FlowQueryInteger</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#phasecounts">phaseCounts</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</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/FlowQueryInteger.html" class="tsd-signature-type tsd-kind-type-alias">FlowQueryInteger</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#raw">raw</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</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><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#scope">scope</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"catalog_build"</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#status">status</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"pending"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"passed"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"failed"</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#totalshards">totalShards</a><span class="tsd-signature-symbol">:</span> <a href="../types/FlowQueryInteger.html" class="tsd-signature-type tsd-kind-type-alias">FlowQueryInteger</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#validatedatms">validatedAtMs</a><span class="tsd-signature-symbol">?:</span> <a href="../types/FlowQueryInteger.html" class="tsd-signature-type tsd-kind-type-alias">FlowQueryInteger</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
|
|
14
|
-
<section class="tsd-panel tsd-hierarchy" data-refl="
|
|
14
|
+
<section class="tsd-panel tsd-hierarchy" data-refl="2214">
|
|
15
15
|
<h4>Hierarchy (<a href="../hierarchy.html#FlowQueryIndexValidation">View Summary</a>)</h4>
|
|
16
16
|
<ul class="tsd-hierarchy">
|
|
17
17
|
<li class="tsd-hierarchy-item"><a href="FlowQueryIndexProgress.html" class="tsd-signature-type tsd-kind-interface">FlowQueryIndexProgress</a>
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
<li><a href="" aria-current="page">FlowQueryRecordsResult</a></li></ul>
|
|
12
12
|
<h1>Interface FlowQueryRecordsResult</h1></div>
|
|
13
13
|
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">FlowQueryRecordsResult</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#kind">kind</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"records"</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#page">page</a><span class="tsd-signature-symbol">:</span> <a href="FlowQueryPage.html" class="tsd-signature-type tsd-kind-interface">FlowQueryPage</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#quality">quality</a><span class="tsd-signature-symbol">:</span> <a href="FlowQueryQuality.html" class="tsd-signature-type tsd-kind-interface">FlowQueryQuality</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#raw">raw</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</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><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#records">records</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">readonly</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</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><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#usage">usage</a><span class="tsd-signature-symbol">:</span> <a href="FlowQueryUsage.html" class="tsd-signature-type tsd-kind-interface">FlowQueryUsage</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#version">version</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ferric.flow.query.result/v1"</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="2238">
|
|
15
15
|
<h4>Hierarchy</h4>
|
|
16
16
|
<ul class="tsd-hierarchy">
|
|
17
17
|
<li class="tsd-hierarchy-item"><span class="tsd-signature-type">FlowQueryResultBase</span>
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
<li><a href="" aria-current="page">InvocationCreateOptions</a></li></ul>
|
|
12
12
|
<h1>Interface InvocationCreateOptions</h1></div>
|
|
13
13
|
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">InvocationCreateOptions</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#context">context</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="#idempotencykey">idempotencyKey</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="#requestcontext">requestContext</a><span class="tsd-signature-symbol">?:</span> <a href="RequestContext.html" class="tsd-signature-type tsd-kind-interface">RequestContext</a><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="1745">
|
|
15
15
|
<h4>Hierarchy (<a href="../hierarchy.html#InvocationCreateOptions">View Summary</a>)</h4>
|
|
16
16
|
<ul class="tsd-hierarchy">
|
|
17
17
|
<li class="tsd-hierarchy-item"><a href="RequestContextOptions.html" class="tsd-signature-type tsd-kind-interface">RequestContextOptions</a>
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
<li><a href="" aria-current="page">LeaseMutationOptions</a></li></ul>
|
|
12
12
|
<h1>Interface LeaseMutationOptions</h1></div>
|
|
13
13
|
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">LeaseMutationOptions</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="#leasetoken">leaseToken</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#nowms">nowMs</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#overridevalues">overrideValues</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#partitionkey">partitionKey</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#payload">payload</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#returnrecord">returnRecord</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#statemeta">stateMeta</a><span class="tsd-signature-symbol">?:</span> <a href="../types/StateMeta.html" class="tsd-signature-type tsd-kind-type-alias">StateMeta</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#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="1768">
|
|
15
15
|
<h4>Hierarchy (<a href="../hierarchy.html#LeaseMutationOptions">View Summary</a>)</h4>
|
|
16
16
|
<ul class="tsd-hierarchy">
|
|
17
17
|
<li class="tsd-hierarchy-item"><a href="MutateOptions.html" class="tsd-signature-type tsd-kind-interface">MutateOptions</a>
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
<li><a href="" aria-current="page">LimitListOptions</a></li></ul>
|
|
12
12
|
<h1>Interface LimitListOptions</h1></div>
|
|
13
13
|
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">LimitListOptions</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#limit">limit</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#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="#scope">scope</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
|
|
14
|
-
<section class="tsd-panel tsd-hierarchy" data-refl="
|
|
14
|
+
<section class="tsd-panel tsd-hierarchy" data-refl="1759">
|
|
15
15
|
<h4>Hierarchy (<a href="../hierarchy.html#LimitListOptions">View Summary</a>)</h4>
|
|
16
16
|
<ul class="tsd-hierarchy">
|
|
17
17
|
<li class="tsd-hierarchy-item"><a href="AdminListOptions.html" class="tsd-signature-type tsd-kind-interface">AdminListOptions</a>
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
<li><a href="" aria-current="page">MutateOptions</a></li></ul>
|
|
12
12
|
<h1>Interface MutateOptions</h1></div>
|
|
13
13
|
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">MutateOptions</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="#nowms">nowMs</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#overridevalues">overrideValues</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#partitionkey">partitionKey</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#payload">payload</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#returnrecord">returnRecord</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#statemeta">stateMeta</a><span class="tsd-signature-symbol">?:</span> <a href="../types/StateMeta.html" class="tsd-signature-type tsd-kind-type-alias">StateMeta</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#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="1783">
|
|
15
15
|
<h4>Hierarchy (<a href="../hierarchy.html#MutateOptions">View Summary</a>)</h4>
|
|
16
16
|
<ul class="tsd-hierarchy">
|
|
17
17
|
<li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">MutateOptions</span>
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
<li><a href="" aria-current="page">NamedValueMutation</a></li></ul>
|
|
12
12
|
<h1>Interface NamedValueMutation</h1></div>
|
|
13
13
|
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">NamedValueMutation</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="#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="#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="2852">
|
|
15
15
|
<h4>Hierarchy (<a href="../hierarchy.html#NamedValueMutation">View Summary</a>)</h4>
|
|
16
16
|
<ul class="tsd-hierarchy">
|
|
17
17
|
<li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">NamedValueMutation</span>
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
<li><a href="" aria-current="page">ReadOptions</a></li></ul>
|
|
12
12
|
<h1>Interface ReadOptions</h1></div>
|
|
13
13
|
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ReadOptions</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="#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="1795">
|
|
15
15
|
<h4>Hierarchy (<a href="../hierarchy.html#ReadOptions">View Summary</a>)</h4>
|
|
16
16
|
<ul class="tsd-hierarchy">
|
|
17
17
|
<li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">ReadOptions</span>
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
<li><a href="" aria-current="page">ReclaimOptions</a></li></ul>
|
|
12
12
|
<h1>Interface ReclaimOptions</h1></div>
|
|
13
13
|
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ReclaimOptions</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#includeattributes">includeAttributes</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="#jobonly">jobOnly</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="#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="#limit">limit</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#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="#partitionkeys">partitionKeys</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">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#payloadmaxbytes">payloadMaxBytes</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="#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="#state">state</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"running"</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#valuemaxbytes">valueMaxBytes</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="#values">values</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="#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="1806">
|
|
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><br/> <a href="ClaimDueOptions.html" class="tsd-signature-type tsd-kind-interface">ClaimDueOptions</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"state"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"states"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"blockMs"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"reclaimExpired"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"reclaimRatio"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"includeState"</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">></span>
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
<li><a href="" aria-current="page">RequestContextOptions</a></li></ul>
|
|
12
12
|
<h1>Interface RequestContextOptions</h1></div>
|
|
13
13
|
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">RequestContextOptions</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#requestcontext">requestContext</a><span class="tsd-signature-symbol">?:</span> <a href="RequestContext.html" class="tsd-signature-type tsd-kind-interface">RequestContext</a><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="1825">
|
|
15
15
|
<h4>Hierarchy (<a href="../hierarchy.html#RequestContextOptions">View Summary</a>)</h4>
|
|
16
16
|
<ul class="tsd-hierarchy">
|
|
17
17
|
<li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">RequestContextOptions</span>
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
<li><a href="" aria-current="page">RetryOptions</a></li></ul>
|
|
12
12
|
<h1>Interface RetryOptions</h1></div>
|
|
13
13
|
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">RetryOptions</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="#fencingtoken">fencingToken</a><span class="tsd-signature-symbol">:</span> <a href="../types/FencingToken.html" class="tsd-signature-type tsd-kind-type-alias">FencingToken</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#leasetoken">leaseToken</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#nowms">nowMs</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#overridevalues">overrideValues</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#partitionkey">partitionKey</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#payload">payload</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#returnrecord">returnRecord</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#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="1827">
|
|
15
15
|
<h4>Hierarchy (<a href="../hierarchy.html#RetryOptions">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>
|
|
@@ -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="2861">
|
|
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>
|
|
@@ -11,7 +11,7 @@
|
|
|
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="1934">
|
|
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>
|
|
@@ -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="1987">
|
|
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>
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
<h4>Type Parameters</h4>
|
|
19
19
|
<ul class="tsd-type-parameter-list">
|
|
20
20
|
<li><span id="tresult"><span class="tsd-kind-type-parameter">TResult</span></span></li></ul></section>
|
|
21
|
-
<section class="tsd-panel tsd-hierarchy" data-refl="
|
|
21
|
+
<section class="tsd-panel tsd-hierarchy" data-refl="1965">
|
|
22
22
|
<h4>Hierarchy (<a href="../hierarchy.html#StepOptions">View Summary</a>)</h4>
|
|
23
23
|
<ul class="tsd-hierarchy">
|
|
24
24
|
<li class="tsd-hierarchy-item"><a href="AdvanceOptions.html" class="tsd-signature-type tsd-kind-interface">AdvanceOptions</a>
|
|
@@ -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="3310">
|
|
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="3312">
|
|
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="2006">
|
|
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>
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
<li><a href="" aria-current="page">TransitionOutcome</a></li></ul>
|
|
12
12
|
<h1>Interface TransitionOutcome</h1></div>
|
|
13
13
|
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">TransitionOutcome</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#attributesdelete">attributesDelete</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#attributesmerge">attributesMerge</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <a href="../types/CommandArgument.html" class="tsd-signature-type tsd-kind-type-alias">CommandArgument</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#dropvalues">dropValues</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#kind">kind</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"transition"</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="#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="#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="2873">
|
|
15
15
|
<h4>Hierarchy (<a href="../hierarchy.html#TransitionOutcome">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>
|
package/docs/api/media/design.md
CHANGED
|
@@ -52,6 +52,16 @@ committed result without rerunning the closure; a closure whose result was not
|
|
|
52
52
|
committed may run again, so external providers still require stable
|
|
53
53
|
idempotency keys.
|
|
54
54
|
|
|
55
|
+
A timer, signal, approval, or scheduled state is persisted before the current
|
|
56
|
+
claim is released. Waiting therefore does not consume worker concurrency. Once
|
|
57
|
+
the condition becomes runnable, any available worker can claim a fresh lease
|
|
58
|
+
and continue from the durable state; completed durable steps replay their
|
|
59
|
+
stored results instead of running again.
|
|
60
|
+
|
|
61
|
+
`stepContinue()` is retained only as a deprecated low-level migration API.
|
|
62
|
+
Applications should use chainable `advance()` for state-only transitions and
|
|
63
|
+
`step()` for a journaled closure plus transition.
|
|
64
|
+
|
|
55
65
|
The SDK does not use a global executor or thread pool for step closures. It
|
|
56
66
|
awaits the value returned by the caller or worker-owned callback. CPU-bound
|
|
57
67
|
closures therefore need the application's normal Node.js worker-thread or
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
<ul class="tsd-breadcrumb" aria-label="Breadcrumb">
|
|
11
11
|
<li><a href="" aria-current="page">FERRICSTORE_SDK_VERSION</a></li></ul>
|
|
12
12
|
<h1>Variable FERRICSTORE_SDK_VERSION<code class="tsd-tag">Const</code></h1></div>
|
|
13
|
-
<div class="tsd-signature"><span class="tsd-kind-variable">FERRICSTORE_SDK_VERSION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"0.13.
|
|
13
|
+
<div class="tsd-signature"><span class="tsd-kind-variable">FERRICSTORE_SDK_VERSION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"0.13.3"</span></div>
|
|
14
14
|
<div class="tsd-comment tsd-typography"><p>TypeScript SDK package version.</p>
|
|
15
15
|
</div><aside class="tsd-sources">
|
|
16
16
|
<ul>
|
package/docs/design.md
CHANGED
|
@@ -52,6 +52,16 @@ committed result without rerunning the closure; a closure whose result was not
|
|
|
52
52
|
committed may run again, so external providers still require stable
|
|
53
53
|
idempotency keys.
|
|
54
54
|
|
|
55
|
+
A timer, signal, approval, or scheduled state is persisted before the current
|
|
56
|
+
claim is released. Waiting therefore does not consume worker concurrency. Once
|
|
57
|
+
the condition becomes runnable, any available worker can claim a fresh lease
|
|
58
|
+
and continue from the durable state; completed durable steps replay their
|
|
59
|
+
stored results instead of running again.
|
|
60
|
+
|
|
61
|
+
`stepContinue()` is retained only as a deprecated low-level migration API.
|
|
62
|
+
Applications should use chainable `advance()` for state-only transitions and
|
|
63
|
+
`step()` for a journaled closure plus transition.
|
|
64
|
+
|
|
55
65
|
The SDK does not use a global executor or thread pool for step closures. It
|
|
56
66
|
awaits the value returned by the caller or worker-owned callback. CPU-bound
|
|
57
67
|
closures therefore need the application's normal Node.js worker-thread or
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ferricstore/ferricstore",
|
|
3
|
-
"version": "0.13.
|
|
3
|
+
"version": "0.13.3",
|
|
4
4
|
"description": "TypeScript SDK for FerricStore and FerricFlow",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "Apache-2.0",
|
|
@@ -91,7 +91,7 @@
|
|
|
91
91
|
"pack:dry-run": "npm pack --dry-run",
|
|
92
92
|
"test": "vitest run tests/*.test.ts",
|
|
93
93
|
"test:exports": "node scripts/check-package-exports.mjs",
|
|
94
|
-
"test:integration": "vitest run tests/integration",
|
|
94
|
+
"test:integration": "vitest run tests/integration --no-file-parallelism",
|
|
95
95
|
"test:integration:http": "scripts/run-http-integration.sh",
|
|
96
96
|
"test:integration:isolated": "node scripts/run-isolated-integration.mjs",
|
|
97
97
|
"test:integration:deployment": "vitest run tests/integration/deployment.test.ts",
|