mirror of
https://github.com/morluto/rea.git
synced 2026-10-30 19:35:56 +00:00
docs: refresh generated API reference
This commit is contained in:
morluto committed
1 parent
b33ebb1627
commit
f5f653bd8d
40 files changed
+262
-278
No files matched your search
@@ -323,12 +323,12 @@ entering until the transition has settled.</p>
|
||||
<h3 class="tsd-anchor-link" id="listunknowns"><span>list<wbr/>Unknowns</span><a href="#listunknowns" 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>
|
||||
<ul class="tsd-signatures tsd-is-inherited">
|
||||
<li class="tsd-is-inherited">
|
||||
<div class="tsd-signature tsd-anchor-link" id="listunknowns-1"><span class="tsd-kind-call-signature">listUnknowns</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">filters</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">domain</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-property">severity</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"low"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"medium"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"high"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"critical"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"open"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"investigating"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"blocked"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"contradicted"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"resolved"</span><span class="tsd-signature-symbol">;</span><br/> <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> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">contradicting_evidence_ids</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/> <span class="tsd-kind-property">domain</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-property">mutation_evidence_ids</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/> <span class="tsd-kind-property">previous_revision_digest</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">question</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-property">recommended_probes</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">operation</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">rationale</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><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">registry_version</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">1</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">relationships</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"depends-on"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"related-to"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"contradicts"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">unknown_id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signatureLine truncated
|
||||
<div class="tsd-signature tsd-anchor-link" id="listunknowns-1"><span class="tsd-kind-call-signature">listUnknowns</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">filters</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">domain</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-property">severity</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"low"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"medium"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"high"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"critical"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"open"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"investigating"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"blocked"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"contradicted"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"resolved"</span><span class="tsd-signature-symbol">;</span><br/> <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> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">contradicting_evidence_ids</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/> <span class="tsd-kind-property">domain</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-property">mutation_evidence_ids</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/> <span class="tsd-kind-property">previous_revision_digest</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">question</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-property">recommended_probes</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">operation</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">rationale</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><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">registry_version</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">1</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">relationships</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"depends-on"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"related-to"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"contradicts"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">unknown_id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signaturLine truncated
|
||||
<div class="tsd-description">
|
||||
<div class="tsd-parameters">
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameter-list">
|
||||
<li><span><span class="tsd-kind-parameter">filters</span>: <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">domain</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-property">severity</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"low"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"medium"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"high"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"critical"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"open"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"investigating"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"blocked"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"contradicted"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"resolved"</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></span></li></ul></div>
|
||||
<li><span><span class="tsd-kind-parameter">filters</span>: <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">domain</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-property">severity</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"low"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"medium"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"high"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"critical"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"open"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"investigating"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"blocked"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"contradicted"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"resolved"</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></span></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">contradicting_evidence_ids</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/> <span class="tsd-kind-property">domain</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-property">mutation_evidence_ids</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/> <span class="tsd-kind-property">previous_revision_digest</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">null</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">question</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-property">recommended_probes</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">operation</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">rationale</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><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">registry_version</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">1</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">relationships</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"depends-on"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"related-to"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"contradicts"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">unknown_id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">required_authority</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"shipped-artifact"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"controlled-replay"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"historical-reference"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"external-service"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"analyst-inference"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">required_confidence</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"observed"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"derived"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"inferred"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">required_environment</span><span class="tsd-signature-symbol">:</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">architecture</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span Line truncated
|
||||
<p>Implementation of <a href="../interfaces/application_BinarySessionPort.BinarySessionPort.html">BinarySessionPort</a>.<a href="../interfaces/application_BinarySessionPort.BinarySessionPort.html#listunknowns">listUnknowns</a></p>
|
||||
<p>Inherited from <a href="application_BinarySessionRecords.BinarySessionRecords.html">BinarySessionRecords</a>.<a href="application_BinarySessionRecords.BinarySessionRecords.html#listunknowns">listUnknowns</a></p>
|
||||
@@ -611,7 +611,7 @@ Returns the switch failure even if best-effort restoration also fails.</p>
|
||||
<p>Implementation of <a href="../interfaces/application_BinarySessionPort.BinarySessionPort.html">BinarySessionPort</a>.<a href="../interfaces/application_BinarySessionPort.BinarySessionPort.html#verifyunknownresolution">verifyUnknownResolution</a></p>
|
||||
<p>Inherited from <a href="application_BinarySessionRecords.BinarySessionRecords.html">BinarySessionRecords</a>.<a href="application_BinarySessionRecords.BinarySessionRecords.html#verifyunknownresolution">verifyUnknownResolution</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/morluto/rea/blob/main/src/application/BinarySessionRecords.ts#L281">src/application/BinarySessionRecords.ts:281</a></li></ul></aside></div></li></ul></section></section></details></div>
|
||||
<li>Defined in <a href="https://github.com/morluto/rea/blob/main/src/application/BinarySessionRecords.ts#L283">src/application/BinarySessionRecords.ts:283</a></li></ul></aside></div></li></ul></section></section></details></div>
|
||||
<div class="col-sidebar">
|
||||
<div class="page-menu">
|
||||
<div class="tsd-navigation settings">
|
||||
|
||||
Reference in new issue
Block a user