@ferricstore/ferricstore 0.12.2 → 0.13.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +45 -3
- package/dist/index.cjs +804 -198
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +87 -9
- package/dist/index.d.ts +87 -9
- package/dist/index.js +798 -194
- package/dist/index.js.map +1 -1
- package/dist/langgraph.cjs.map +1 -1
- package/dist/langgraph.d.cts +1 -1
- package/dist/langgraph.d.ts +1 -1
- package/dist/langgraph.js.map +1 -1
- package/dist/openai-agents.cjs.map +1 -1
- package/dist/openai-agents.js.map +1 -1
- package/dist/{outcomes-DmBwnq0Y.d.cts → outcomes-CcX956h4.d.cts} +20 -1
- package/dist/{outcomes-BbFDp3AH.d.ts → outcomes-DLJYTrX8.d.ts} +20 -1
- package/docs/api/assets/hierarchy.js +1 -1
- package/docs/api/assets/highlight.css +9 -2
- package/docs/api/assets/navigation.js +1 -1
- package/docs/api/assets/search.js +1 -1
- package/docs/api/classes/ConnectionClosedError.html +5 -5
- package/docs/api/classes/FerricStoreClient.html +68 -23
- package/docs/api/classes/FerricStoreError.html +2 -1
- package/docs/api/classes/FlowAlreadyExistsError.html +3 -3
- package/docs/api/classes/FlowBatchError.html +1 -1
- package/docs/api/classes/FlowNotFoundError.html +3 -3
- package/docs/api/classes/FlowQueryError.html +1 -1
- package/docs/api/classes/FlowWrongStateError.html +3 -3
- package/docs/api/classes/HTTPTransportError.html +14 -8
- package/docs/api/classes/InvalidCommandError.html +3 -3
- package/docs/api/classes/LeaseRenewalError.html +3 -3
- package/docs/api/classes/LockHeldError.html +3 -3
- package/docs/api/classes/LockNotOwnedError.html +3 -3
- package/docs/api/classes/NativeAdapter.html +3 -3
- package/docs/api/classes/OverloadedError.html +5 -5
- package/docs/api/classes/QueueCompletionError.html +1 -1
- package/docs/api/classes/RequestNotSentError.html +225 -0
- package/docs/api/classes/RequestTimeoutError.html +6 -6
- package/docs/api/classes/RerouteError.html +3 -3
- package/docs/api/classes/StaleLeaseError.html +3 -3
- package/docs/api/classes/StalePolicyGenerationError.html +3 -3
- package/docs/api/classes/Workflow.html +19 -19
- package/docs/api/classes/WorkflowClient.html +4 -4
- package/docs/api/classes/WorkflowContext.html +73 -37
- package/docs/api/classes/WorkflowFlowCommands.html +26 -22
- package/docs/api/classes/WorkflowWorker.html +6 -6
- package/docs/api/functions/classifyServerError.html +1 -1
- package/docs/api/functions/complete.html +1 -1
- package/docs/api/functions/fail.html +1 -1
- package/docs/api/functions/isAlreadyAppliedOutcome.html +41 -0
- package/docs/api/functions/isOutcome.html +1 -1
- package/docs/api/functions/mapException.html +1 -1
- package/docs/api/functions/retry.html +1 -1
- package/docs/api/functions/transition.html +1 -1
- package/docs/api/hierarchy.html +56 -47
- package/docs/api/index.html +32 -4
- package/docs/api/interfaces/AdminListOptions.html +1 -1
- package/docs/api/interfaces/AdvanceOptions.html +145 -0
- package/docs/api/interfaces/AlreadyAppliedOutcome.html +69 -0
- package/docs/api/interfaces/AppliedStepOutcome.html +87 -0
- package/docs/api/interfaces/CancelOptions.html +13 -9
- package/docs/api/interfaces/CompleteOptions.html +13 -9
- package/docs/api/interfaces/CompleteOutcome.html +13 -13
- package/docs/api/interfaces/CreateManyOptions.html +1 -1
- package/docs/api/interfaces/EffectCompensateOptions.html +1 -1
- package/docs/api/interfaces/EffectConfirmOptions.html +1 -1
- package/docs/api/interfaces/EffectFailOptions.html +1 -1
- package/docs/api/interfaces/EffectStatusOptions.html +1 -1
- package/docs/api/interfaces/ExtendLeaseOptions.html +10 -8
- package/docs/api/interfaces/FailOptions.html +13 -9
- package/docs/api/interfaces/FailOutcome.html +13 -13
- package/docs/api/interfaces/FerricStoreClientFromUrlOptions.html +1 -1
- package/docs/api/interfaces/FerricStoreClientOptions.html +1 -1
- package/docs/api/interfaces/FlowQueryCountResult.html +1 -1
- package/docs/api/interfaces/FlowQueryIndexBuild.html +1 -1
- package/docs/api/interfaces/FlowQueryIndexProgress.html +1 -1
- package/docs/api/interfaces/FlowQueryIndexValidation.html +1 -1
- package/docs/api/interfaces/FlowQueryRecordsResult.html +1 -1
- package/docs/api/interfaces/HistoryOptions.html +16 -16
- package/docs/api/interfaces/InvocationCreateOptions.html +1 -1
- package/docs/api/interfaces/LeaseMutationOptions.html +11 -7
- package/docs/api/interfaces/LimitListOptions.html +1 -1
- package/docs/api/interfaces/MutateOptions.html +8 -4
- package/docs/api/interfaces/NamedValueMutation.html +9 -9
- package/docs/api/interfaces/ReadOptions.html +12 -12
- package/docs/api/interfaces/ReclaimOptions.html +1 -1
- package/docs/api/interfaces/ReplayedStepResult.html +73 -0
- package/docs/api/interfaces/RequestContextOptions.html +1 -1
- package/docs/api/interfaces/RetryOptions.html +13 -9
- package/docs/api/interfaces/RetryOutcome.html +13 -13
- package/docs/api/interfaces/RunStepsItem.html +3 -3
- package/docs/api/interfaces/RunStepsManyOptions.html +11 -11
- package/docs/api/interfaces/SearchOptions.html +13 -13
- package/docs/api/interfaces/StepContinueOptions.html +16 -12
- package/docs/api/interfaces/StepOptions.html +166 -0
- package/docs/api/interfaces/StepResult.html +67 -0
- package/docs/api/interfaces/TDigestCreateOptions.html +1 -1
- package/docs/api/interfaces/TDigestMergeOptions.html +1 -1
- package/docs/api/interfaces/TransitionOptions.html +15 -11
- package/docs/api/interfaces/TransitionOutcome.html +14 -14
- package/docs/api/media/design.md +12 -1
- package/docs/api/modules.html +8 -8
- package/docs/api/types/ConnectionRequestDisposition.html +1 -1
- package/docs/api/types/ManagementPairs.html +1 -1
- package/docs/api/types/Outcome.html +1 -1
- package/docs/api/types/RequestDisposition.html +1 -1
- package/docs/api/types/SearchStateMeta.html +1 -1
- package/docs/api/types/WorkflowStepResult.html +38 -0
- package/docs/api/variables/FERRICSTORE_SDK_VERSION.html +1 -1
- package/docs/design.md +12 -1
- package/package.json +1 -1
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
<ul class="tsd-breadcrumb" aria-label="Breadcrumb">
|
|
11
11
|
<li><a href="" aria-current="page">FerricStoreError</a></li></ul>
|
|
12
12
|
<h1>Class FerricStoreError</h1></div>
|
|
13
|
-
<section class="tsd-panel tsd-hierarchy" data-refl="
|
|
13
|
+
<section class="tsd-panel tsd-hierarchy" data-refl="2371">
|
|
14
14
|
<h4>Hierarchy (<a href="../hierarchy.html#FerricStoreError">View Summary</a>)</h4>
|
|
15
15
|
<ul class="tsd-hierarchy">
|
|
16
16
|
<li class="tsd-hierarchy-item"><span class="tsd-signature-type">Error</span>
|
|
@@ -29,6 +29,7 @@
|
|
|
29
29
|
<li class="tsd-hierarchy-item"><a href="LockHeldError.html" class="tsd-signature-type tsd-kind-class">LockHeldError</a></li>
|
|
30
30
|
<li class="tsd-hierarchy-item"><a href="LockNotOwnedError.html" class="tsd-signature-type tsd-kind-class">LockNotOwnedError</a></li>
|
|
31
31
|
<li class="tsd-hierarchy-item"><a href="OverloadedError.html" class="tsd-signature-type tsd-kind-class">OverloadedError</a></li>
|
|
32
|
+
<li class="tsd-hierarchy-item"><a href="RequestNotSentError.html" class="tsd-signature-type tsd-kind-class">RequestNotSentError</a></li>
|
|
32
33
|
<li class="tsd-hierarchy-item"><a href="RequestTimeoutError.html" class="tsd-signature-type tsd-kind-class">RequestTimeoutError</a></li>
|
|
33
34
|
<li class="tsd-hierarchy-item"><a href="RerouteError.html" class="tsd-signature-type tsd-kind-class">RerouteError</a></li>
|
|
34
35
|
<li class="tsd-hierarchy-item"><a href="StaleLeaseError.html" class="tsd-signature-type tsd-kind-class">StaleLeaseError</a></li>
|
|
@@ -10,14 +10,14 @@
|
|
|
10
10
|
<ul class="tsd-breadcrumb" aria-label="Breadcrumb">
|
|
11
11
|
<li><a href="" aria-current="page">FlowAlreadyExistsError</a></li></ul>
|
|
12
12
|
<h1>Class FlowAlreadyExistsError</h1></div>
|
|
13
|
-
<section class="tsd-panel tsd-hierarchy" data-refl="
|
|
13
|
+
<section class="tsd-panel tsd-hierarchy" data-refl="2434">
|
|
14
14
|
<h4>Hierarchy (<a href="../hierarchy.html#FlowAlreadyExistsError">View Summary</a>)</h4>
|
|
15
15
|
<ul class="tsd-hierarchy">
|
|
16
16
|
<li class="tsd-hierarchy-item"><a href="FerricStoreError.html" class="tsd-signature-type tsd-kind-class">FerricStoreError</a>
|
|
17
17
|
<ul class="tsd-hierarchy">
|
|
18
18
|
<li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">FlowAlreadyExistsError</span></li></ul></li></ul></section><aside class="tsd-sources">
|
|
19
19
|
<ul>
|
|
20
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#
|
|
20
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L122">src/errors.ts:122</a></li></ul></aside>
|
|
21
21
|
<section class="tsd-panel-group tsd-index-group">
|
|
22
22
|
<section class="tsd-panel tsd-index-panel">
|
|
23
23
|
<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>
|
|
@@ -77,7 +77,7 @@
|
|
|
77
77
|
<div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"flow_already_exists"</span></div><aside class="tsd-sources">
|
|
78
78
|
<p>Overrides <a href="FerricStoreError.html">FerricStoreError</a>.<a href="FerricStoreError.html#code">code</a></p>
|
|
79
79
|
<ul>
|
|
80
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#
|
|
80
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L123">src/errors.ts:123</a></li></ul></aside></section>
|
|
81
81
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
82
82
|
<h3 class="tsd-anchor-link" id="message"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
83
83
|
<div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
<section class="tsd-panel tsd-comment">
|
|
14
14
|
<div class="tsd-comment tsd-typography"><p>A chunked independent Flow operation failed after zero or more item results were confirmed.</p>
|
|
15
15
|
</div></section>
|
|
16
|
-
<section class="tsd-panel tsd-hierarchy" data-refl="
|
|
16
|
+
<section class="tsd-panel tsd-hierarchy" data-refl="1427">
|
|
17
17
|
<h4>Hierarchy (<a href="../hierarchy.html#FlowBatchError">View Summary</a>)</h4>
|
|
18
18
|
<ul class="tsd-hierarchy">
|
|
19
19
|
<li class="tsd-hierarchy-item"><a href="FerricStoreError.html" class="tsd-signature-type tsd-kind-class">FerricStoreError</a>
|
|
@@ -10,14 +10,14 @@
|
|
|
10
10
|
<ul class="tsd-breadcrumb" aria-label="Breadcrumb">
|
|
11
11
|
<li><a href="" aria-current="page">FlowNotFoundError</a></li></ul>
|
|
12
12
|
<h1>Class FlowNotFoundError</h1></div>
|
|
13
|
-
<section class="tsd-panel tsd-hierarchy" data-refl="
|
|
13
|
+
<section class="tsd-panel tsd-hierarchy" data-refl="2463">
|
|
14
14
|
<h4>Hierarchy (<a href="../hierarchy.html#FlowNotFoundError">View Summary</a>)</h4>
|
|
15
15
|
<ul class="tsd-hierarchy">
|
|
16
16
|
<li class="tsd-hierarchy-item"><a href="FerricStoreError.html" class="tsd-signature-type tsd-kind-class">FerricStoreError</a>
|
|
17
17
|
<ul class="tsd-hierarchy">
|
|
18
18
|
<li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">FlowNotFoundError</span></li></ul></li></ul></section><aside class="tsd-sources">
|
|
19
19
|
<ul>
|
|
20
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#
|
|
20
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L105">src/errors.ts:105</a></li></ul></aside>
|
|
21
21
|
<section class="tsd-panel-group tsd-index-group">
|
|
22
22
|
<section class="tsd-panel tsd-index-panel">
|
|
23
23
|
<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>
|
|
@@ -77,7 +77,7 @@
|
|
|
77
77
|
<div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"flow_not_found"</span></div><aside class="tsd-sources">
|
|
78
78
|
<p>Overrides <a href="FerricStoreError.html">FerricStoreError</a>.<a href="FerricStoreError.html#code">code</a></p>
|
|
79
79
|
<ul>
|
|
80
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#
|
|
80
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L106">src/errors.ts:106</a></li></ul></aside></section>
|
|
81
81
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
82
82
|
<h3 class="tsd-anchor-link" id="message"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
83
83
|
<div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
<ul class="tsd-breadcrumb" aria-label="Breadcrumb">
|
|
11
11
|
<li><a href="" aria-current="page">FlowQueryError</a></li></ul>
|
|
12
12
|
<h1>Class FlowQueryError</h1></div>
|
|
13
|
-
<section class="tsd-panel tsd-hierarchy" data-refl="
|
|
13
|
+
<section class="tsd-panel tsd-hierarchy" data-refl="2051">
|
|
14
14
|
<h4>Hierarchy (<a href="../hierarchy.html#FlowQueryError">View Summary</a>)</h4>
|
|
15
15
|
<ul class="tsd-hierarchy">
|
|
16
16
|
<li class="tsd-hierarchy-item"><a href="FerricStoreError.html" class="tsd-signature-type tsd-kind-class">FerricStoreError</a>
|
|
@@ -10,14 +10,14 @@
|
|
|
10
10
|
<ul class="tsd-breadcrumb" aria-label="Breadcrumb">
|
|
11
11
|
<li><a href="" aria-current="page">FlowWrongStateError</a></li></ul>
|
|
12
12
|
<h1>Class FlowWrongStateError</h1></div>
|
|
13
|
-
<section class="tsd-panel tsd-hierarchy" data-refl="
|
|
13
|
+
<section class="tsd-panel tsd-hierarchy" data-refl="2492">
|
|
14
14
|
<h4>Hierarchy (<a href="../hierarchy.html#FlowWrongStateError">View Summary</a>)</h4>
|
|
15
15
|
<ul class="tsd-hierarchy">
|
|
16
16
|
<li class="tsd-hierarchy-item"><a href="FerricStoreError.html" class="tsd-signature-type tsd-kind-class">FerricStoreError</a>
|
|
17
17
|
<ul class="tsd-hierarchy">
|
|
18
18
|
<li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">FlowWrongStateError</span></li></ul></li></ul></section><aside class="tsd-sources">
|
|
19
19
|
<ul>
|
|
20
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#
|
|
20
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L109">src/errors.ts:109</a></li></ul></aside>
|
|
21
21
|
<section class="tsd-panel-group tsd-index-group">
|
|
22
22
|
<section class="tsd-panel tsd-index-panel">
|
|
23
23
|
<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>
|
|
@@ -77,7 +77,7 @@
|
|
|
77
77
|
<div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"flow_wrong_state"</span></div><aside class="tsd-sources">
|
|
78
78
|
<p>Overrides <a href="FerricStoreError.html">FerricStoreError</a>.<a href="FerricStoreError.html#code">code</a></p>
|
|
79
79
|
<ul>
|
|
80
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#
|
|
80
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L110">src/errors.ts:110</a></li></ul></aside></section>
|
|
81
81
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
82
82
|
<h3 class="tsd-anchor-link" id="message"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
83
83
|
<div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
@@ -10,14 +10,14 @@
|
|
|
10
10
|
<ul class="tsd-breadcrumb" aria-label="Breadcrumb">
|
|
11
11
|
<li><a href="" aria-current="page">HTTPTransportError</a></li></ul>
|
|
12
12
|
<h1>Class HTTPTransportError</h1></div>
|
|
13
|
-
<section class="tsd-panel tsd-hierarchy" data-refl="
|
|
13
|
+
<section class="tsd-panel tsd-hierarchy" data-refl="2400">
|
|
14
14
|
<h4>Hierarchy (<a href="../hierarchy.html#HTTPTransportError">View Summary</a>)</h4>
|
|
15
15
|
<ul class="tsd-hierarchy">
|
|
16
16
|
<li class="tsd-hierarchy-item"><a href="FerricStoreError.html" class="tsd-signature-type tsd-kind-class">FerricStoreError</a>
|
|
17
17
|
<ul class="tsd-hierarchy">
|
|
18
18
|
<li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">HTTPTransportError</span></li></ul></li></ul></section><aside class="tsd-sources">
|
|
19
19
|
<ul>
|
|
20
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#
|
|
20
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L28">src/errors.ts:28</a></li></ul></aside>
|
|
21
21
|
<section class="tsd-panel-group tsd-index-group">
|
|
22
22
|
<section class="tsd-panel tsd-index-panel">
|
|
23
23
|
<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>
|
|
@@ -34,6 +34,7 @@
|
|
|
34
34
|
<a href="#message" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a>
|
|
35
35
|
<a href="#name" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a>
|
|
36
36
|
<a href="#raw" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>raw</span></a>
|
|
37
|
+
<a href="#requestdisposition" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request<wbr/>Disposition</span></a>
|
|
37
38
|
<a href="#retryable" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>retryable</span></a>
|
|
38
39
|
<a href="#retryafterms" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>retry<wbr/>After<wbr/>Ms</span></a>
|
|
39
40
|
<a href="#safetoretry" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>safe<wbr/>To<wbr/>Retry</span></a>
|
|
@@ -53,17 +54,17 @@
|
|
|
53
54
|
<h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
54
55
|
<ul class="tsd-signatures">
|
|
55
56
|
<li class="">
|
|
56
|
-
<div class="tsd-signature tsd-anchor-link" id="constructorhttptransporterror"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">HTTPTransportError</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">raw</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">retryable</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">retryAfterMs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">safeToRetry</span><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> <span class="tsd-signature-symbol">&</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">statusCode</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">HTTPTransportError</a><a href="#constructorhttptransporterror" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
57
|
+
<div class="tsd-signature tsd-anchor-link" id="constructorhttptransporterror"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">HTTPTransportError</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">raw</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">retryable</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">retryAfterMs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">safeToRetry</span><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> <span class="tsd-signature-symbol">&</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">requestDisposition</span><span class="tsd-signature-symbol">?:</span> <a href="../types/RequestDisposition.html" class="tsd-signature-type tsd-kind-type-alias">RequestDisposition</a><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">statusCode</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">HTTPTransportError</a><a href="#constructorhttptransporterror" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
57
58
|
<div class="tsd-description">
|
|
58
59
|
<div class="tsd-parameters">
|
|
59
60
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
60
61
|
<ul class="tsd-parameter-list">
|
|
61
62
|
<li><span><span class="tsd-kind-parameter">message</span>: <span class="tsd-signature-type">string</span></span></li>
|
|
62
|
-
<li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">raw</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">retryable</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">retryAfterMs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">safeToRetry</span><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> <span class="tsd-signature-symbol">&</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">statusCode</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></span></li></ul></div>
|
|
63
|
+
<li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">raw</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">retryable</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">retryAfterMs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">safeToRetry</span><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> <span class="tsd-signature-symbol">&</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">requestDisposition</span><span class="tsd-signature-symbol">?:</span> <a href="../types/RequestDisposition.html" class="tsd-signature-type tsd-kind-type-alias">RequestDisposition</a><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">statusCode</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></span></li></ul></div>
|
|
63
64
|
<h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">HTTPTransportError</a></h4><aside class="tsd-sources">
|
|
64
65
|
<p>Overrides <a href="FerricStoreError.html">FerricStoreError</a>.<a href="FerricStoreError.html#constructor">constructor</a></p>
|
|
65
66
|
<ul>
|
|
66
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#
|
|
67
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L33">src/errors.ts:33</a></li></ul></aside></div></li></ul></section></section></details>
|
|
67
68
|
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
68
69
|
<h2 class="tsd-anchor-link" id="properties-1">Properties<a href="#properties-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
|
|
69
70
|
<section>
|
|
@@ -78,7 +79,7 @@
|
|
|
78
79
|
<div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"http_transport"</span></div><aside class="tsd-sources">
|
|
79
80
|
<p>Overrides <a href="FerricStoreError.html">FerricStoreError</a>.<a href="FerricStoreError.html#code">code</a></p>
|
|
80
81
|
<ul>
|
|
81
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#
|
|
82
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L29">src/errors.ts:29</a></li></ul></aside></section>
|
|
82
83
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
83
84
|
<h3 class="tsd-anchor-link" id="message"><span>message</span><a href="#message" 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
85
|
<div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
@@ -97,6 +98,11 @@
|
|
|
97
98
|
<p>Inherited from <a href="FerricStoreError.html">FerricStoreError</a>.<a href="FerricStoreError.html#raw">raw</a></p>
|
|
98
99
|
<ul>
|
|
99
100
|
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L3">src/errors.ts:3</a></li></ul></aside></section>
|
|
101
|
+
<section class="tsd-panel tsd-member">
|
|
102
|
+
<h3 class="tsd-anchor-link" id="requestdisposition"><code class="tsd-tag">Readonly</code><span>request<wbr/>Disposition</span><a href="#requestdisposition" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
103
|
+
<div class="tsd-signature"><span class="tsd-kind-property">requestDisposition</span><span class="tsd-signature-symbol">:</span> <a href="../types/RequestDisposition.html" class="tsd-signature-type tsd-kind-type-alias">RequestDisposition</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></div><aside class="tsd-sources">
|
|
104
|
+
<ul>
|
|
105
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L30">src/errors.ts:30</a></li></ul></aside></section>
|
|
100
106
|
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
101
107
|
<h3 class="tsd-anchor-link" id="retryable"><code class="tsd-tag">Readonly</code><span>retryable</span><a href="#retryable" 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>
|
|
102
108
|
<div class="tsd-signature"><span class="tsd-kind-property">retryable</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></div><aside class="tsd-sources">
|
|
@@ -125,7 +131,7 @@
|
|
|
125
131
|
<h3 class="tsd-anchor-link" id="statuscode"><code class="tsd-tag">Readonly</code><span>status<wbr/>Code</span><a href="#statuscode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
126
132
|
<div class="tsd-signature"><span class="tsd-kind-property">statusCode</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></div><aside class="tsd-sources">
|
|
127
133
|
<ul>
|
|
128
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#
|
|
134
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L31">src/errors.ts:31</a></li></ul></aside></section>
|
|
129
135
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
130
136
|
<h3 class="tsd-anchor-link" id="stacktracelimit"><code class="tsd-tag">Static</code><span>stack<wbr/>Trace<wbr/>Limit</span><a href="#stacktracelimit" 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>
|
|
131
137
|
<div class="tsd-signature"><span class="tsd-kind-property">stackTraceLimit</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
@@ -212,7 +218,7 @@ details of error generation from the user. For instance:</p>
|
|
|
212
218
|
<details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary>
|
|
213
219
|
<div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details>
|
|
214
220
|
<details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary>
|
|
215
|
-
<div><a href="#cause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause</span></a><a href="#code"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#raw" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>raw</span></a><a href="#retryable" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>retryable</span></a><a href="#retryafterms" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>retry<wbr/>After<wbr/>Ms</span></a><a href="#safetoretry" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>safe<wbr/>To<wbr/>Retry</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#statuscode"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status<wbr/>Code</span></a><a href="#stacktracelimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a></div></details>
|
|
221
|
+
<div><a href="#cause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause</span></a><a href="#code"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#raw" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>raw</span></a><a href="#requestdisposition"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request<wbr/>Disposition</span></a><a href="#retryable" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>retryable</span></a><a href="#retryafterms" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>retry<wbr/>After<wbr/>Ms</span></a><a href="#safetoretry" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>safe<wbr/>To<wbr/>Retry</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#statuscode"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status<wbr/>Code</span></a><a href="#stacktracelimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a></div></details>
|
|
216
222
|
<details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary>
|
|
217
223
|
<div><a href="#capturestacktrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a><a href="#preparestacktrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a></div></details></div></details></div>
|
|
218
224
|
<div class="site-menu">
|
|
@@ -10,14 +10,14 @@
|
|
|
10
10
|
<ul class="tsd-breadcrumb" aria-label="Breadcrumb">
|
|
11
11
|
<li><a href="" aria-current="page">InvalidCommandError</a></li></ul>
|
|
12
12
|
<h1>Class InvalidCommandError</h1></div>
|
|
13
|
-
<section class="tsd-panel tsd-hierarchy" data-refl="
|
|
13
|
+
<section class="tsd-panel tsd-hierarchy" data-refl="2521">
|
|
14
14
|
<h4>Hierarchy (<a href="../hierarchy.html#InvalidCommandError">View Summary</a>)</h4>
|
|
15
15
|
<ul class="tsd-hierarchy">
|
|
16
16
|
<li class="tsd-hierarchy-item"><a href="FerricStoreError.html" class="tsd-signature-type tsd-kind-class">FerricStoreError</a>
|
|
17
17
|
<ul class="tsd-hierarchy">
|
|
18
18
|
<li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">InvalidCommandError</span></li></ul></li></ul></section><aside class="tsd-sources">
|
|
19
19
|
<ul>
|
|
20
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#
|
|
20
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L134">src/errors.ts:134</a></li></ul></aside>
|
|
21
21
|
<section class="tsd-panel-group tsd-index-group">
|
|
22
22
|
<section class="tsd-panel tsd-index-panel">
|
|
23
23
|
<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>
|
|
@@ -77,7 +77,7 @@
|
|
|
77
77
|
<div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"invalid_command"</span></div><aside class="tsd-sources">
|
|
78
78
|
<p>Overrides <a href="FerricStoreError.html">FerricStoreError</a>.<a href="FerricStoreError.html#code">code</a></p>
|
|
79
79
|
<ul>
|
|
80
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#
|
|
80
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L135">src/errors.ts:135</a></li></ul></aside></section>
|
|
81
81
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
82
82
|
<h3 class="tsd-anchor-link" id="message"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
83
83
|
<div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
@@ -13,14 +13,14 @@
|
|
|
13
13
|
<section class="tsd-panel tsd-comment">
|
|
14
14
|
<div class="tsd-comment tsd-typography"><p>Raised when a worker loses the ability to renew a claimed job's lease.</p>
|
|
15
15
|
</div></section>
|
|
16
|
-
<section class="tsd-panel tsd-hierarchy" data-refl="
|
|
16
|
+
<section class="tsd-panel tsd-hierarchy" data-refl="2887">
|
|
17
17
|
<h4>Hierarchy</h4>
|
|
18
18
|
<ul class="tsd-hierarchy">
|
|
19
19
|
<li class="tsd-hierarchy-item"><span class="tsd-signature-type">Error</span>
|
|
20
20
|
<ul class="tsd-hierarchy">
|
|
21
21
|
<li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">LeaseRenewalError</span></li></ul></li></ul></section><aside class="tsd-sources">
|
|
22
22
|
<ul>
|
|
23
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/worker-
|
|
23
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/worker-lease-guard.ts#L13">src/worker-lease-guard.ts:13</a></li></ul></aside>
|
|
24
24
|
<section class="tsd-panel-group tsd-index-group">
|
|
25
25
|
<section class="tsd-panel tsd-index-panel">
|
|
26
26
|
<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>
|
|
@@ -59,7 +59,7 @@
|
|
|
59
59
|
<h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">LeaseRenewalError</a></h4><aside class="tsd-sources">
|
|
60
60
|
<p>Overrides Error.constructor</p>
|
|
61
61
|
<ul>
|
|
62
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/worker-
|
|
62
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/worker-lease-guard.ts#L14">src/worker-lease-guard.ts:14</a></li></ul></aside></div></li></ul></section></section></details>
|
|
63
63
|
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
64
64
|
<h2 class="tsd-anchor-link" id="properties-1">Properties<a href="#properties-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
|
|
65
65
|
<section>
|
|
@@ -10,14 +10,14 @@
|
|
|
10
10
|
<ul class="tsd-breadcrumb" aria-label="Breadcrumb">
|
|
11
11
|
<li><a href="" aria-current="page">LockHeldError</a></li></ul>
|
|
12
12
|
<h1>Class LockHeldError</h1></div>
|
|
13
|
-
<section class="tsd-panel tsd-hierarchy" data-refl="
|
|
13
|
+
<section class="tsd-panel tsd-hierarchy" data-refl="2550">
|
|
14
14
|
<h4>Hierarchy (<a href="../hierarchy.html#LockHeldError">View Summary</a>)</h4>
|
|
15
15
|
<ul class="tsd-hierarchy">
|
|
16
16
|
<li class="tsd-hierarchy-item"><a href="FerricStoreError.html" class="tsd-signature-type tsd-kind-class">FerricStoreError</a>
|
|
17
17
|
<ul class="tsd-hierarchy">
|
|
18
18
|
<li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">LockHeldError</span></li></ul></li></ul></section><aside class="tsd-sources">
|
|
19
19
|
<ul>
|
|
20
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#
|
|
20
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L126">src/errors.ts:126</a></li></ul></aside>
|
|
21
21
|
<section class="tsd-panel-group tsd-index-group">
|
|
22
22
|
<section class="tsd-panel tsd-index-panel">
|
|
23
23
|
<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>
|
|
@@ -77,7 +77,7 @@
|
|
|
77
77
|
<div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"lock_held"</span></div><aside class="tsd-sources">
|
|
78
78
|
<p>Overrides <a href="FerricStoreError.html">FerricStoreError</a>.<a href="FerricStoreError.html#code">code</a></p>
|
|
79
79
|
<ul>
|
|
80
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#
|
|
80
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L127">src/errors.ts:127</a></li></ul></aside></section>
|
|
81
81
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
82
82
|
<h3 class="tsd-anchor-link" id="message"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
83
83
|
<div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
@@ -10,14 +10,14 @@
|
|
|
10
10
|
<ul class="tsd-breadcrumb" aria-label="Breadcrumb">
|
|
11
11
|
<li><a href="" aria-current="page">LockNotOwnedError</a></li></ul>
|
|
12
12
|
<h1>Class LockNotOwnedError</h1></div>
|
|
13
|
-
<section class="tsd-panel tsd-hierarchy" data-refl="
|
|
13
|
+
<section class="tsd-panel tsd-hierarchy" data-refl="2579">
|
|
14
14
|
<h4>Hierarchy (<a href="../hierarchy.html#LockNotOwnedError">View Summary</a>)</h4>
|
|
15
15
|
<ul class="tsd-hierarchy">
|
|
16
16
|
<li class="tsd-hierarchy-item"><a href="FerricStoreError.html" class="tsd-signature-type tsd-kind-class">FerricStoreError</a>
|
|
17
17
|
<ul class="tsd-hierarchy">
|
|
18
18
|
<li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">LockNotOwnedError</span></li></ul></li></ul></section><aside class="tsd-sources">
|
|
19
19
|
<ul>
|
|
20
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#
|
|
20
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L130">src/errors.ts:130</a></li></ul></aside>
|
|
21
21
|
<section class="tsd-panel-group tsd-index-group">
|
|
22
22
|
<section class="tsd-panel tsd-index-panel">
|
|
23
23
|
<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>
|
|
@@ -77,7 +77,7 @@
|
|
|
77
77
|
<div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"lock_not_owned"</span></div><aside class="tsd-sources">
|
|
78
78
|
<p>Overrides <a href="FerricStoreError.html">FerricStoreError</a>.<a href="FerricStoreError.html#code">code</a></p>
|
|
79
79
|
<ul>
|
|
80
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#
|
|
80
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L131">src/errors.ts:131</a></li></ul></aside></section>
|
|
81
81
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
82
82
|
<h3 class="tsd-anchor-link" id="message"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
83
83
|
<div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
@@ -42,7 +42,7 @@
|
|
|
42
42
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
43
43
|
<p>Implementation of <a href="../interfaces/CommandExecutor.html">CommandExecutor</a>.<a href="../interfaces/CommandExecutor.html#close">close</a></p>
|
|
44
44
|
<ul>
|
|
45
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/native-adapter.ts#
|
|
45
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/native-adapter.ts#L219">src/native-adapter.ts:219</a></li></ul></aside></div></li></ul></section>
|
|
46
46
|
<section class="tsd-panel tsd-member">
|
|
47
47
|
<h3 class="tsd-anchor-link" id="executecommand"><span>execute<wbr/>Command</span><a href="#executecommand" 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>
|
|
48
48
|
<ul class="tsd-signatures">
|
|
@@ -87,7 +87,7 @@
|
|
|
87
87
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</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></h4><aside class="tsd-sources">
|
|
88
88
|
<p>Implementation of <a href="../interfaces/CommandExecutor.html">CommandExecutor</a>.<a href="../interfaces/CommandExecutor.html#executepipeline">executePipeline</a></p>
|
|
89
89
|
<ul>
|
|
90
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/native-adapter.ts#
|
|
90
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/native-adapter.ts#L185">src/native-adapter.ts:185</a></li></ul></aside></div></li></ul></section>
|
|
91
91
|
<section class="tsd-panel tsd-member">
|
|
92
92
|
<h3 class="tsd-anchor-link" id="executeprotocolcommand"><span>execute<wbr/>Protocol<wbr/>Command</span><a href="#executeprotocolcommand" 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
93
|
<ul class="tsd-signatures">
|
|
@@ -101,7 +101,7 @@
|
|
|
101
101
|
<li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">laneId</span>: <span class="tsd-signature-type">number</span></span></li></ul></div>
|
|
102
102
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
103
103
|
<ul>
|
|
104
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/native-adapter.ts#
|
|
104
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/native-adapter.ts#L181">src/native-adapter.ts:181</a></li></ul></aside></div></li></ul></section>
|
|
105
105
|
<section class="tsd-panel tsd-member">
|
|
106
106
|
<h3 class="tsd-anchor-link" id="fromurl"><code class="tsd-tag">Static</code><span>from<wbr/>Url</span><a href="#fromurl" 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
|
<ul class="tsd-signatures">
|
|
@@ -10,14 +10,14 @@
|
|
|
10
10
|
<ul class="tsd-breadcrumb" aria-label="Breadcrumb">
|
|
11
11
|
<li><a href="" aria-current="page">OverloadedError</a></li></ul>
|
|
12
12
|
<h1>Class OverloadedError</h1></div>
|
|
13
|
-
<section class="tsd-panel tsd-hierarchy" data-refl="
|
|
13
|
+
<section class="tsd-panel tsd-hierarchy" data-refl="2608">
|
|
14
14
|
<h4>Hierarchy (<a href="../hierarchy.html#OverloadedError">View Summary</a>)</h4>
|
|
15
15
|
<ul class="tsd-hierarchy">
|
|
16
16
|
<li class="tsd-hierarchy-item"><a href="FerricStoreError.html" class="tsd-signature-type tsd-kind-class">FerricStoreError</a>
|
|
17
17
|
<ul class="tsd-hierarchy">
|
|
18
18
|
<li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">OverloadedError</span></li></ul></li></ul></section><aside class="tsd-sources">
|
|
19
19
|
<ul>
|
|
20
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#
|
|
20
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L138">src/errors.ts:138</a></li></ul></aside>
|
|
21
21
|
<section class="tsd-panel-group tsd-index-group">
|
|
22
22
|
<section class="tsd-panel tsd-index-panel">
|
|
23
23
|
<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>
|
|
@@ -63,7 +63,7 @@
|
|
|
63
63
|
<h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">OverloadedError</a></h4><aside class="tsd-sources">
|
|
64
64
|
<p>Overrides <a href="FerricStoreError.html">FerricStoreError</a>.<a href="FerricStoreError.html#constructor">constructor</a></p>
|
|
65
65
|
<ul>
|
|
66
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#
|
|
66
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L142">src/errors.ts:142</a></li></ul></aside></div></li></ul></section></section></details>
|
|
67
67
|
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
68
68
|
<h2 class="tsd-anchor-link" id="properties-1">Properties<a href="#properties-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
|
|
69
69
|
<section>
|
|
@@ -78,7 +78,7 @@
|
|
|
78
78
|
<div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"overloaded"</span></div><aside class="tsd-sources">
|
|
79
79
|
<p>Overrides <a href="FerricStoreError.html">FerricStoreError</a>.<a href="FerricStoreError.html#code">code</a></p>
|
|
80
80
|
<ul>
|
|
81
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#
|
|
81
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L139">src/errors.ts:139</a></li></ul></aside></section>
|
|
82
82
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
83
83
|
<h3 class="tsd-anchor-link" id="message"><span>message</span><a href="#message" 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">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
@@ -101,7 +101,7 @@
|
|
|
101
101
|
<h3 class="tsd-anchor-link" id="reason"><code class="tsd-tag">Readonly</code><span>reason</span><a href="#reason" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
102
102
|
<div class="tsd-signature"><span class="tsd-kind-property">reason</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">undefined</span></div><aside class="tsd-sources">
|
|
103
103
|
<ul>
|
|
104
|
-
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#
|
|
104
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/errors.ts#L140">src/errors.ts:140</a></li></ul></aside></section>
|
|
105
105
|
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
106
106
|
<h3 class="tsd-anchor-link" id="retryable"><code class="tsd-tag">Readonly</code><span>retryable</span><a href="#retryable" 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">retryable</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></div><aside class="tsd-sources">
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
<section class="tsd-panel tsd-comment">
|
|
14
14
|
<div class="tsd-comment tsd-typography"><p>Async terminal-write failure with the number of durable successes drained first.</p>
|
|
15
15
|
</div></section>
|
|
16
|
-
<section class="tsd-panel tsd-hierarchy" data-refl="
|
|
16
|
+
<section class="tsd-panel tsd-hierarchy" data-refl="3378">
|
|
17
17
|
<h4>Hierarchy</h4>
|
|
18
18
|
<ul class="tsd-hierarchy">
|
|
19
19
|
<li class="tsd-hierarchy-item"><span class="tsd-signature-type">Error</span>
|