@xyo-network/modules 2.59.0 → 2.60.0-rc.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/docs.json +65682 -63632
- package/docs/assets/search.js +1 -1
- package/docs/classes/ArchivistWrapper.html +11 -11
- package/docs/classes/BridgeWrapper.html +11 -11
- package/docs/classes/DivinerWrapper.html +11 -11
- package/docs/classes/ModuleErrorBuilder.html +3 -3
- package/docs/classes/ModuleWrapper.html +11 -11
- package/docs/classes/NodeWrapper.html +11 -11
- package/docs/classes/QueryBoundWitnessBuilder.html +11 -22
- package/docs/classes/QueryBoundWitnessValidator.html +21 -32
- package/docs/classes/QueryBoundWitnessWrapper.html +492 -183
- package/docs/classes/SentinelIntervalAutomationWrapper.html +280 -107
- package/docs/classes/SentinelWrapper.html +11 -11
- package/docs/classes/WitnessWrapper.html +11 -11
- package/docs/classes/XyoWitnessWrapper.html +11 -11
- package/docs/functions/isQuerySupportedByModule.html +2 -2
- package/docs/interfaces/QueryValidator.html +2 -2
- package/docs/types/Queryable.html +4 -4
- package/package.json +9 -8
|
@@ -331,16 +331,14 @@
|
|
|
331
331
|
<section class="tsd-panel tsd-member tsd-is-protected"><a id="filterErrors" class="tsd-anchor"></a>
|
|
332
332
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>filter<wbr/>Errors</span><a href="#filterErrors" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
333
333
|
<ul class="tsd-signatures tsd-is-protected">
|
|
334
|
-
<li class="tsd-signature tsd-anchor-link" id="filterErrors.filterErrors-1"><span class="tsd-kind-call-signature">filter<wbr/>Errors</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">
|
|
334
|
+
<li class="tsd-signature tsd-anchor-link" id="filterErrors.filterErrors-1"><span class="tsd-kind-call-signature">filter<wbr/>Errors</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">result</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-type ">SchemaFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type ">PayloadFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">schema</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"network.xyo.error.module"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">sources</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-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#filterErrors.filterErrors-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
335
335
|
<li class="tsd-description">
|
|
336
336
|
<div class="tsd-parameters">
|
|
337
337
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
338
338
|
<ul class="tsd-parameter-list">
|
|
339
339
|
<li>
|
|
340
|
-
<h5><span class="tsd-kind-parameter">
|
|
341
|
-
<
|
|
342
|
-
<h5><span class="tsd-kind-parameter">result</span>: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../types/ModuleQueryResult.html" class="tsd-signature-type tsd-kind-type-alias">ModuleQueryResult</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">SchemaFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type ">PayloadFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">schema</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></h5></li></ul></div>
|
|
343
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">SchemaFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type ">PayloadFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">schema</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"network.xyo.error.module"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">sources</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-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
|
|
340
|
+
<h5><span class="tsd-kind-parameter">result</span>: <a href="../types/ModuleQueryResult.html" class="tsd-signature-type tsd-kind-type-alias">ModuleQueryResult</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">SchemaFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type ">PayloadFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">schema</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></h5></li></ul></div>
|
|
341
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-type ">SchemaFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type ">PayloadFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">schema</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"network.xyo.error.module"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">sources</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-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
344
342
|
<ul>
|
|
345
343
|
<li>Defined in modules/packages/module/packages/wrapper/dist/types/Wrapper.d.ts:73</li></ul></aside></li></ul></section>
|
|
346
344
|
<section class="tsd-panel tsd-member"><a id="listenerCount" class="tsd-anchor"></a>
|
|
@@ -584,18 +582,20 @@ the underlying modules matching the supplied filter</p>
|
|
|
584
582
|
<section class="tsd-panel tsd-member tsd-is-protected"><a id="sendQuery" class="tsd-anchor"></a>
|
|
585
583
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>send<wbr/>Query</span><a href="#sendQuery" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
586
584
|
<ul class="tsd-signatures tsd-is-protected">
|
|
587
|
-
<li class="tsd-signature tsd-anchor-link" id="sendQuery.sendQuery-1"><span class="tsd-kind-call-signature">send<wbr/>Query</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">queryPayload</span>, <span class="tsd-kind-parameter">payloads</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-type ">SchemaFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type ">PayloadFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">schema</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><span class="tsd-signature-symbol">></span><a href="#sendQuery.sendQuery-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
585
|
+
<li class="tsd-signature tsd-anchor-link" id="sendQuery.sendQuery-1"><span class="tsd-kind-call-signature">send<wbr/>Query</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">W</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">queryPayload</span>, <span class="tsd-kind-parameter">payloads</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-type ">SchemaFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type ">PayloadFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">schema</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><span class="tsd-signature-symbol">></span><a href="#sendQuery.sendQuery-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
588
586
|
<li class="tsd-description">
|
|
589
587
|
<section class="tsd-panel">
|
|
590
588
|
<h4>Type Parameters</h4>
|
|
591
589
|
<ul class="tsd-type-parameter-list">
|
|
592
590
|
<li>
|
|
593
|
-
<h4><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type ">SchemaFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type ">PayloadFields</span><span class="tsd-signature-symbol"> & </span><a href="../interfaces/QueryFields.html" class="tsd-signature-type tsd-kind-interface">QueryFields</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">schema</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
|
|
591
|
+
<h4><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type ">SchemaFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type ">PayloadFields</span><span class="tsd-signature-symbol"> & </span><a href="../interfaces/QueryFields.html" class="tsd-signature-type tsd-kind-interface">QueryFields</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">schema</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></h4></li>
|
|
592
|
+
<li>
|
|
593
|
+
<h4><span class="tsd-kind-type-parameter">W</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type ">PayloadWrapper</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">W</span><span class="tsd-signature-symbol">></span> = <span class="tsd-signature-type ">PayloadWrapper</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span></h4></li></ul></section>
|
|
594
594
|
<div class="tsd-parameters">
|
|
595
595
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
596
596
|
<ul class="tsd-parameter-list">
|
|
597
597
|
<li>
|
|
598
|
-
<h5><span class="tsd-kind-parameter">queryPayload</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li>
|
|
598
|
+
<h5><span class="tsd-kind-parameter">queryPayload</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type tsd-kind-type-parameter">W</span></h5></li>
|
|
599
599
|
<li>
|
|
600
600
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">payloads</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-type ">SchemaFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type ">PayloadFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">schema</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></h5></li></ul></div>
|
|
601
601
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-type ">SchemaFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type ">PayloadFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">schema</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><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
@@ -604,7 +604,7 @@ the underlying modules matching the supplied filter</p>
|
|
|
604
604
|
<section class="tsd-panel tsd-member tsd-is-protected"><a id="throwErrors" class="tsd-anchor"></a>
|
|
605
605
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>throw<wbr/>Errors</span><a href="#throwErrors" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
606
606
|
<ul class="tsd-signatures tsd-is-protected">
|
|
607
|
-
<li class="tsd-signature tsd-anchor-link" id="throwErrors.throwErrors-1"><span class="tsd-kind-call-signature">throw<wbr/>Errors</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">query</span>, <span class="tsd-kind-parameter">result</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#throwErrors.throwErrors-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
607
|
+
<li class="tsd-signature tsd-anchor-link" id="throwErrors.throwErrors-1"><span class="tsd-kind-call-signature">throw<wbr/>Errors</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">query</span>, <span class="tsd-kind-parameter">result</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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><a href="#throwErrors.throwErrors-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
608
608
|
<li class="tsd-description">
|
|
609
609
|
<div class="tsd-parameters">
|
|
610
610
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -612,8 +612,8 @@ the underlying modules matching the supplied filter</p>
|
|
|
612
612
|
<li>
|
|
613
613
|
<h5><span class="tsd-kind-parameter">query</span>: <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type ">SchemaFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type ">PayloadFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type ">BoundWitnessFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">query</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">resultSet</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">schema</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"network.xyo.boundwitness"</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-signature-type ">SchemaFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type ">PayloadFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">schema</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><span class="tsd-signature-symbol">]</span></h5></li>
|
|
614
614
|
<li>
|
|
615
|
-
<h5><
|
|
616
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
615
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">result</span>: <a href="../types/ModuleQueryResult.html" class="tsd-signature-type tsd-kind-type-alias">ModuleQueryResult</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">SchemaFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type ">PayloadFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">schema</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></h5></li></ul></div>
|
|
616
|
+
<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">
|
|
617
617
|
<ul>
|
|
618
618
|
<li>Defined in modules/packages/module/packages/wrapper/dist/types/Wrapper.d.ts:75</li></ul></aside></li></ul></section>
|
|
619
619
|
<section class="tsd-panel tsd-member"><a id="canWrap" class="tsd-anchor"></a>
|
|
@@ -368,16 +368,14 @@
|
|
|
368
368
|
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="filterErrors" class="tsd-anchor"></a>
|
|
369
369
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>filter<wbr/>Errors</span><a href="#filterErrors" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
370
370
|
<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
|
|
371
|
-
<li class="tsd-signature tsd-anchor-link" id="filterErrors.filterErrors-1"><span class="tsd-kind-call-signature">filter<wbr/>Errors</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">
|
|
371
|
+
<li class="tsd-signature tsd-anchor-link" id="filterErrors.filterErrors-1"><span class="tsd-kind-call-signature">filter<wbr/>Errors</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">result</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-type ">SchemaFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type ">PayloadFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">schema</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"network.xyo.error.module"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">sources</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-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#filterErrors.filterErrors-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
372
372
|
<li class="tsd-description">
|
|
373
373
|
<div class="tsd-parameters">
|
|
374
374
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
375
375
|
<ul class="tsd-parameter-list">
|
|
376
376
|
<li>
|
|
377
|
-
<h5><span class="tsd-kind-parameter">
|
|
378
|
-
<
|
|
379
|
-
<h5><span class="tsd-kind-parameter">result</span>: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../types/ModuleQueryResult.html" class="tsd-signature-type tsd-kind-type-alias">ModuleQueryResult</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">SchemaFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type ">PayloadFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">schema</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></h5></li></ul></div>
|
|
380
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">SchemaFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type ">PayloadFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">schema</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"network.xyo.error.module"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">sources</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-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
|
|
377
|
+
<h5><span class="tsd-kind-parameter">result</span>: <a href="../types/ModuleQueryResult.html" class="tsd-signature-type tsd-kind-type-alias">ModuleQueryResult</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">SchemaFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type ">PayloadFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">schema</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></h5></li></ul></div>
|
|
378
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-type ">SchemaFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type ">PayloadFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">schema</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"network.xyo.error.module"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">sources</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-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
381
379
|
<p>Inherited from <a href="ModuleWrapper.html">ModuleWrapper</a>.<a href="ModuleWrapper.html#filterErrors">filterErrors</a></p>
|
|
382
380
|
<ul>
|
|
383
381
|
<li>Defined in modules/packages/module/packages/wrapper/dist/types/Wrapper.d.ts:73</li></ul></aside></li></ul></section>
|
|
@@ -635,18 +633,20 @@ the underlying modules matching the supplied filter</p>
|
|
|
635
633
|
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="sendQuery" class="tsd-anchor"></a>
|
|
636
634
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>send<wbr/>Query</span><a href="#sendQuery" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
637
635
|
<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
|
|
638
|
-
<li class="tsd-signature tsd-anchor-link" id="sendQuery.sendQuery-1"><span class="tsd-kind-call-signature">send<wbr/>Query</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">queryPayload</span>, <span class="tsd-kind-parameter">payloads</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-type ">SchemaFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type ">PayloadFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">schema</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><span class="tsd-signature-symbol">></span><a href="#sendQuery.sendQuery-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
636
|
+
<li class="tsd-signature tsd-anchor-link" id="sendQuery.sendQuery-1"><span class="tsd-kind-call-signature">send<wbr/>Query</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">W</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">queryPayload</span>, <span class="tsd-kind-parameter">payloads</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-type ">SchemaFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type ">PayloadFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">schema</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><span class="tsd-signature-symbol">></span><a href="#sendQuery.sendQuery-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
639
637
|
<li class="tsd-description">
|
|
640
638
|
<section class="tsd-panel">
|
|
641
639
|
<h4>Type Parameters</h4>
|
|
642
640
|
<ul class="tsd-type-parameter-list">
|
|
643
641
|
<li>
|
|
644
|
-
<h4><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type ">SchemaFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type ">PayloadFields</span><span class="tsd-signature-symbol"> & </span><a href="../interfaces/QueryFields.html" class="tsd-signature-type tsd-kind-interface">QueryFields</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">schema</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
|
|
642
|
+
<h4><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type ">SchemaFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type ">PayloadFields</span><span class="tsd-signature-symbol"> & </span><a href="../interfaces/QueryFields.html" class="tsd-signature-type tsd-kind-interface">QueryFields</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">schema</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></h4></li>
|
|
643
|
+
<li>
|
|
644
|
+
<h4><span class="tsd-kind-type-parameter">W</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type ">PayloadWrapper</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">W</span><span class="tsd-signature-symbol">></span> = <span class="tsd-signature-type ">PayloadWrapper</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span></h4></li></ul></section>
|
|
645
645
|
<div class="tsd-parameters">
|
|
646
646
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
647
647
|
<ul class="tsd-parameter-list">
|
|
648
648
|
<li>
|
|
649
|
-
<h5><span class="tsd-kind-parameter">queryPayload</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li>
|
|
649
|
+
<h5><span class="tsd-kind-parameter">queryPayload</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type tsd-kind-type-parameter">W</span></h5></li>
|
|
650
650
|
<li>
|
|
651
651
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">payloads</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-type ">SchemaFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type ">PayloadFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">schema</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></h5></li></ul></div>
|
|
652
652
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-type ">SchemaFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type ">PayloadFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">schema</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><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
@@ -656,7 +656,7 @@ the underlying modules matching the supplied filter</p>
|
|
|
656
656
|
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="throwErrors" class="tsd-anchor"></a>
|
|
657
657
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>throw<wbr/>Errors</span><a href="#throwErrors" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
658
658
|
<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
|
|
659
|
-
<li class="tsd-signature tsd-anchor-link" id="throwErrors.throwErrors-1"><span class="tsd-kind-call-signature">throw<wbr/>Errors</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">query</span>, <span class="tsd-kind-parameter">result</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#throwErrors.throwErrors-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
659
|
+
<li class="tsd-signature tsd-anchor-link" id="throwErrors.throwErrors-1"><span class="tsd-kind-call-signature">throw<wbr/>Errors</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">query</span>, <span class="tsd-kind-parameter">result</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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><a href="#throwErrors.throwErrors-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
660
660
|
<li class="tsd-description">
|
|
661
661
|
<div class="tsd-parameters">
|
|
662
662
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -664,8 +664,8 @@ the underlying modules matching the supplied filter</p>
|
|
|
664
664
|
<li>
|
|
665
665
|
<h5><span class="tsd-kind-parameter">query</span>: <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type ">SchemaFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type ">PayloadFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type ">BoundWitnessFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">query</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">resultSet</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">schema</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"network.xyo.boundwitness"</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-signature-type ">SchemaFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type ">PayloadFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">schema</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><span class="tsd-signature-symbol">]</span></h5></li>
|
|
666
666
|
<li>
|
|
667
|
-
<h5><
|
|
668
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
667
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">result</span>: <a href="../types/ModuleQueryResult.html" class="tsd-signature-type tsd-kind-type-alias">ModuleQueryResult</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">SchemaFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type ">PayloadFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">schema</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></h5></li></ul></div>
|
|
668
|
+
<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">
|
|
669
669
|
<p>Inherited from <a href="ModuleWrapper.html">ModuleWrapper</a>.<a href="ModuleWrapper.html#throwErrors">throwErrors</a></p>
|
|
670
670
|
<ul>
|
|
671
671
|
<li>Defined in modules/packages/module/packages/wrapper/dist/types/Wrapper.d.ts:75</li></ul></aside></li></ul></section>
|
|
@@ -48,8 +48,7 @@
|
|
|
48
48
|
</div></section>
|
|
49
49
|
<section class="tsd-index-section">
|
|
50
50
|
<h3 class="tsd-index-heading">Accessors</h3>
|
|
51
|
-
<div class="tsd-index-list"><a href="QueryBoundWitnessBuilder.html#
|
|
52
|
-
<a href="QueryBoundWitnessBuilder.html#_payload_schemas" class="tsd-index-link tsd-is-private tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>_payload_<wbr/>schemas</span></a>
|
|
51
|
+
<div class="tsd-index-list"><a href="QueryBoundWitnessBuilder.html#_payload_schemas" class="tsd-index-link tsd-is-private tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF4D4D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-262144-path"></rect><path d="M8.85 16L11.13 7.24H12.582L14.85 16H13.758L13.182 13.672H10.53L9.954 16H8.85ZM10.746 12.76H12.954L12.282 10.06C12.154 9.548 12.054 9.12 11.982 8.776C11.91 8.432 11.866 8.208 11.85 8.104C11.834 8.208 11.79 8.432 11.718 8.776C11.646 9.12 11.546 9.544 11.418 10.048L10.746 12.76Z" fill="var(--color-text)" id="icon-262144-text"></path></svg><span>_payload_<wbr/>schemas</span></a>
|
|
53
52
|
</div></section>
|
|
54
53
|
<section class="tsd-index-section">
|
|
55
54
|
<h3 class="tsd-index-heading">Methods</h3>
|
|
@@ -115,15 +114,6 @@
|
|
|
115
114
|
<li>Defined in protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:15</li></ul></aside></section></section>
|
|
116
115
|
<section class="tsd-panel-group tsd-member-group">
|
|
117
116
|
<h2>Accessors</h2>
|
|
118
|
-
<section class="tsd-panel tsd-member tsd-is-private tsd-is-inherited"><a id="_payload_hashes" class="tsd-anchor"></a>
|
|
119
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>_payload_<wbr/>hashes</span><a href="#_payload_hashes" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
120
|
-
<ul class="tsd-signatures tsd-is-private tsd-is-inherited">
|
|
121
|
-
<li class="tsd-signature" id="_payload_hashes._payload_hashes-1"><span class="tsd-signature-symbol">get</span> _payload_hashes<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
|
122
|
-
<li class="tsd-description">
|
|
123
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources">
|
|
124
|
-
<p>Inherited from BoundWitnessBuilder._payload_hashes</p>
|
|
125
|
-
<ul>
|
|
126
|
-
<li>Defined in protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:22</li></ul></aside></li></ul></section>
|
|
127
117
|
<section class="tsd-panel tsd-member tsd-is-private tsd-is-inherited"><a id="_payload_schemas" class="tsd-anchor"></a>
|
|
128
118
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>_payload_<wbr/>schemas</span><a href="#_payload_schemas" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
129
119
|
<ul class="tsd-signatures tsd-is-private tsd-is-inherited">
|
|
@@ -132,7 +122,7 @@
|
|
|
132
122
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources">
|
|
133
123
|
<p>Inherited from BoundWitnessBuilder._payload_schemas</p>
|
|
134
124
|
<ul>
|
|
135
|
-
<li>Defined in protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:
|
|
125
|
+
<li>Defined in protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:22</li></ul></aside></li></ul></section></section>
|
|
136
126
|
<section class="tsd-panel-group tsd-member-group">
|
|
137
127
|
<h2>Methods</h2>
|
|
138
128
|
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="build" class="tsd-anchor"></a>
|
|
@@ -148,13 +138,13 @@
|
|
|
148
138
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type tsd-kind-type-parameter">TBoundWitness</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-type ">SchemaFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type ">PayloadFields</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">schema</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><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
149
139
|
<p>Inherited from BoundWitnessBuilder.build</p>
|
|
150
140
|
<ul>
|
|
151
|
-
<li>Defined in protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:
|
|
141
|
+
<li>Defined in protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:23</li></ul></aside></li></ul></section>
|
|
152
142
|
<section class="tsd-panel tsd-member"><a id="hashableFields" class="tsd-anchor"></a>
|
|
153
143
|
<h3 class="tsd-anchor-link"><span>hashable<wbr/>Fields</span><a href="#hashableFields" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
154
144
|
<ul class="tsd-signatures">
|
|
155
|
-
<li class="tsd-signature tsd-anchor-link" id="hashableFields.hashableFields-1"><span class="tsd-kind-call-signature">hashable<wbr/>Fields</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type tsd-kind-type-parameter">TBoundWitness</span><a href="#hashableFields.hashableFields-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
145
|
+
<li class="tsd-signature tsd-anchor-link" id="hashableFields.hashableFields-1"><span class="tsd-kind-call-signature">hashable<wbr/>Fields</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TBoundWitness</span><span class="tsd-signature-symbol">></span><a href="#hashableFields.hashableFields-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
156
146
|
<li class="tsd-description">
|
|
157
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">TBoundWitness</span></h4><aside class="tsd-sources">
|
|
147
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TBoundWitness</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
158
148
|
<p>Overrides BoundWitnessBuilder.hashableFields</p>
|
|
159
149
|
<ul>
|
|
160
150
|
<li>Defined in modules/packages/module/packages/abstract/dist/types/Query/QueryBoundWitnessBuilder.d.ts:8</li></ul></aside></li></ul></section>
|
|
@@ -173,7 +163,7 @@
|
|
|
173
163
|
<h4 class="tsd-returns-title">Returns <a href="QueryBoundWitnessBuilder.html" class="tsd-signature-type tsd-kind-class">QueryBoundWitnessBuilder</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TBoundWitness</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TQuery</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
174
164
|
<p>Inherited from BoundWitnessBuilder.hashes</p>
|
|
175
165
|
<ul>
|
|
176
|
-
<li>Defined in protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:
|
|
166
|
+
<li>Defined in protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:25</li></ul></aside></li></ul></section>
|
|
177
167
|
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="payload" class="tsd-anchor"></a>
|
|
178
168
|
<h3 class="tsd-anchor-link"><span>payload</span><a href="#payload" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
179
169
|
<ul class="tsd-signatures tsd-is-inherited">
|
|
@@ -187,7 +177,7 @@
|
|
|
187
177
|
<h4 class="tsd-returns-title">Returns <a href="QueryBoundWitnessBuilder.html" class="tsd-signature-type tsd-kind-class">QueryBoundWitnessBuilder</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TBoundWitness</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TQuery</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
188
178
|
<p>Inherited from BoundWitnessBuilder.payload</p>
|
|
189
179
|
<ul>
|
|
190
|
-
<li>Defined in protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:
|
|
180
|
+
<li>Defined in protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:26</li></ul></aside></li></ul></section>
|
|
191
181
|
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="payloads" class="tsd-anchor"></a>
|
|
192
182
|
<h3 class="tsd-anchor-link"><span>payloads</span><a href="#payloads" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
193
183
|
<ul class="tsd-signatures tsd-is-inherited">
|
|
@@ -201,7 +191,7 @@
|
|
|
201
191
|
<h4 class="tsd-returns-title">Returns <a href="QueryBoundWitnessBuilder.html" class="tsd-signature-type tsd-kind-class">QueryBoundWitnessBuilder</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TBoundWitness</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TQuery</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
202
192
|
<p>Inherited from BoundWitnessBuilder.payloads</p>
|
|
203
193
|
<ul>
|
|
204
|
-
<li>Defined in protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:
|
|
194
|
+
<li>Defined in protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:27</li></ul></aside></li></ul></section>
|
|
205
195
|
<section class="tsd-panel tsd-member"><a id="query" class="tsd-anchor"></a>
|
|
206
196
|
<h3 class="tsd-anchor-link"><span>query</span><a href="#query" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
207
197
|
<ul class="tsd-signatures">
|
|
@@ -251,7 +241,7 @@
|
|
|
251
241
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</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></h4><aside class="tsd-sources">
|
|
252
242
|
<p>Inherited from BoundWitnessBuilder.signatures</p>
|
|
253
243
|
<ul>
|
|
254
|
-
<li>Defined in protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:
|
|
244
|
+
<li>Defined in protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:30</li></ul></aside></li></ul></section>
|
|
255
245
|
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="witness" class="tsd-anchor"></a>
|
|
256
246
|
<h3 class="tsd-anchor-link"><span>witness</span><a href="#witness" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
257
247
|
<ul class="tsd-signatures tsd-is-inherited">
|
|
@@ -265,7 +255,7 @@
|
|
|
265
255
|
<h4 class="tsd-returns-title">Returns <a href="QueryBoundWitnessBuilder.html" class="tsd-signature-type tsd-kind-class">QueryBoundWitnessBuilder</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TBoundWitness</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TQuery</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
266
256
|
<p>Inherited from BoundWitnessBuilder.witness</p>
|
|
267
257
|
<ul>
|
|
268
|
-
<li>Defined in protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:
|
|
258
|
+
<li>Defined in protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:28</li></ul></aside></li></ul></section>
|
|
269
259
|
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="witnesses" class="tsd-anchor"></a>
|
|
270
260
|
<h3 class="tsd-anchor-link"><span>witnesses</span><a href="#witnesses" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
271
261
|
<ul class="tsd-signatures tsd-is-inherited">
|
|
@@ -279,7 +269,7 @@
|
|
|
279
269
|
<h4 class="tsd-returns-title">Returns <a href="QueryBoundWitnessBuilder.html" class="tsd-signature-type tsd-kind-class">QueryBoundWitnessBuilder</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TBoundWitness</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TQuery</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
280
270
|
<p>Inherited from BoundWitnessBuilder.witnesses</p>
|
|
281
271
|
<ul>
|
|
282
|
-
<li>Defined in protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:
|
|
272
|
+
<li>Defined in protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:29</li></ul></aside></li></ul></section></section></div>
|
|
283
273
|
<div class="col-sidebar">
|
|
284
274
|
<div class="page-menu">
|
|
285
275
|
<div class="tsd-navigation settings">
|
|
@@ -303,7 +293,6 @@
|
|
|
303
293
|
<li><a href="#_resultSet" class="tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>_result<wbr/>Set</span></a></li>
|
|
304
294
|
<li><a href="#config" class="tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>config</span></a></li>
|
|
305
295
|
<li><a href="#logger" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>logger</span></a></li>
|
|
306
|
-
<li><a href="#_payload_hashes" class="tsd-is-private tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>_payload_<wbr/>hashes</span></a></li>
|
|
307
296
|
<li><a href="#_payload_schemas" class="tsd-is-private tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>_payload_<wbr/>schemas</span></a></li>
|
|
308
297
|
<li><a href="#build" class="tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>build</span></a></li>
|
|
309
298
|
<li><a href="#hashableFields" class=""><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>hashable<wbr/>Fields</span></a></li>
|