@xyo-network/network 2.60.0-rc.1 → 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/cjs/XyoNetworkNodePayloadWrapper.js +1 -1
- package/dist/cjs/XyoNetworkNodePayloadWrapper.js.map +1 -1
- package/dist/cjs/XyoNetworkPayloadWrapper.js +1 -1
- package/dist/cjs/XyoNetworkPayloadWrapper.js.map +1 -1
- package/dist/cjs/knownNetworks.js +6 -6
- package/dist/cjs/knownNetworks.js.map +1 -1
- package/dist/docs.json +2809 -1683
- package/dist/esm/XyoNetworkNodePayloadWrapper.js +2 -2
- package/dist/esm/XyoNetworkNodePayloadWrapper.js.map +1 -1
- package/dist/esm/XyoNetworkPayloadWrapper.js +1 -1
- package/dist/esm/XyoNetworkPayloadWrapper.js.map +1 -1
- package/dist/esm/knownNetworks.js +6 -6
- package/dist/esm/knownNetworks.js.map +1 -1
- package/docs/assets/search.js +1 -1
- package/docs/classes/XyoNetworkNodePayloadWrapper.html +85 -71
- package/docs/classes/XyoNetworkPayloadWrapper.html +89 -75
- package/docs/functions/knownArchivists.html +1 -1
- package/docs/functions/knownDiviners.html +1 -1
- package/docs/functions/knownNetworks.html +1 -1
- package/docs/types/XyoNetworkNodePayload.html +1 -1
- package/docs/types/XyoNetworkNodeSchema.html +2 -2
- package/docs/types/XyoNetworkNodeType.html +1 -1
- package/docs/types/XyoNetworkPayload.html +1 -1
- package/docs/types/XyoNetworkSchema.html +2 -2
- package/docs/variables/XyoNetworkNodeSchema-1.html +2 -2
- package/docs/variables/XyoNetworkSchema-1.html +2 -2
- package/package.json +4 -3
- package/src/XyoNetworkNodePayloadWrapper.ts +2 -2
- package/src/XyoNetworkPayloadWrapper.ts +1 -1
- package/src/knownNetworks.ts +6 -6
|
@@ -22,7 +22,7 @@
|
|
|
22
22
|
<ul class="tsd-hierarchy">
|
|
23
23
|
<li><span class="target">XyoNetworkPayloadWrapper</span></li></ul></li></ul></section><aside class="tsd-sources">
|
|
24
24
|
<ul>
|
|
25
|
-
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/
|
|
25
|
+
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/07894923abf1/packages/sdk/packages/network/src/XyoNetworkPayloadWrapper.ts#L7">sdk/packages/network/src/XyoNetworkPayloadWrapper.ts:7</a></li></ul></aside>
|
|
26
26
|
<section class="tsd-panel-group tsd-index-group">
|
|
27
27
|
<section class="tsd-panel tsd-index-panel">
|
|
28
28
|
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
|
|
@@ -41,24 +41,23 @@
|
|
|
41
41
|
<section class="tsd-index-section">
|
|
42
42
|
<h3 class="tsd-index-heading">Accessors</h3>
|
|
43
43
|
<div class="tsd-index-list"><a href="XyoNetworkPayloadWrapper.html#archivists" class="tsd-index-link"><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>archivists</span></a>
|
|
44
|
-
<a href="XyoNetworkPayloadWrapper.html#body" class="tsd-index-link 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>body</span></a>
|
|
45
44
|
<a href="XyoNetworkPayloadWrapper.html#bridges" class="tsd-index-link"><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>bridges</span></a>
|
|
46
45
|
<a href="XyoNetworkPayloadWrapper.html#diviners" class="tsd-index-link"><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>diviners</span></a>
|
|
47
46
|
<a href="XyoNetworkPayloadWrapper.html#hash" class="tsd-index-link 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>hash</span></a>
|
|
48
47
|
<a href="XyoNetworkPayloadWrapper.html#hashFields" class="tsd-index-link 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>hash<wbr/>Fields</span></a>
|
|
49
|
-
<a href="XyoNetworkPayloadWrapper.html#payload" class="tsd-index-link 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</span></a>
|
|
50
|
-
<a href="XyoNetworkPayloadWrapper.html#schema" class="tsd-index-link 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>schema</span></a>
|
|
51
|
-
<a href="XyoNetworkPayloadWrapper.html#schemaName" class="tsd-index-link 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>schema<wbr/>Name</span></a>
|
|
52
48
|
<a href="XyoNetworkPayloadWrapper.html#sentinels" class="tsd-index-link"><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>sentinels</span></a>
|
|
53
49
|
<a href="XyoNetworkPayloadWrapper.html#stringKeyObj" class="tsd-index-link tsd-is-protected 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>string<wbr/>Key<wbr/>Obj</span></a>
|
|
54
50
|
<a href="XyoNetworkPayloadWrapper.html#stringified" class="tsd-index-link 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>stringified</span></a>
|
|
55
51
|
</div></section>
|
|
56
52
|
<section class="tsd-index-section">
|
|
57
53
|
<h3 class="tsd-index-heading">Methods</h3>
|
|
58
|
-
<div class="tsd-index-list"><a href="XyoNetworkPayloadWrapper.html#
|
|
54
|
+
<div class="tsd-index-list"><a href="XyoNetworkPayloadWrapper.html#body" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF4DB8" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-2048-path"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)" id="icon-2048-text"></path></svg><span>body</span></a>
|
|
55
|
+
<a href="XyoNetworkPayloadWrapper.html#filterNodesByType" class="tsd-index-link"><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>filter<wbr/>Nodes<wbr/>By<wbr/>Type</span></a>
|
|
59
56
|
<a href="XyoNetworkPayloadWrapper.html#getErrors" class="tsd-index-link 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>get<wbr/>Errors</span></a>
|
|
60
57
|
<a href="XyoNetworkPayloadWrapper.html#getValid" class="tsd-index-link 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>get<wbr/>Valid</span></a>
|
|
61
58
|
<a href="XyoNetworkPayloadWrapper.html#hashAsync" class="tsd-index-link 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>hash<wbr/>Async</span></a>
|
|
59
|
+
<a href="XyoNetworkPayloadWrapper.html#payload" class="tsd-index-link 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>payload</span></a>
|
|
60
|
+
<a href="XyoNetworkPayloadWrapper.html#schema" class="tsd-index-link 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>schema</span></a>
|
|
62
61
|
<a href="XyoNetworkPayloadWrapper.html#validate" class="tsd-index-link 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>validate</span></a>
|
|
63
62
|
<a href="XyoNetworkPayloadWrapper.html#filterExclude" class="tsd-index-link 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>filter<wbr/>Exclude</span></a>
|
|
64
63
|
<a href="XyoNetworkPayloadWrapper.html#filterInclude" class="tsd-index-link 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>filter<wbr/>Include</span></a>
|
|
@@ -67,6 +66,7 @@
|
|
|
67
66
|
<a href="XyoNetworkPayloadWrapper.html#hashAsync-2" class="tsd-index-link 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>hash<wbr/>Async</span></a>
|
|
68
67
|
<a href="XyoNetworkPayloadWrapper.html#hashFields-2" class="tsd-index-link 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>hash<wbr/>Fields</span></a>
|
|
69
68
|
<a href="XyoNetworkPayloadWrapper.html#hashPairs" class="tsd-index-link 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>hash<wbr/>Pairs</span></a>
|
|
69
|
+
<a href="XyoNetworkPayloadWrapper.html#hashSync" class="tsd-index-link 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>hash<wbr/>Sync</span></a>
|
|
70
70
|
<a href="XyoNetworkPayloadWrapper.html#hashes" class="tsd-index-link 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>hashes</span></a>
|
|
71
71
|
<a href="XyoNetworkPayloadWrapper.html#known" class="tsd-index-link"><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>known</span></a>
|
|
72
72
|
<a href="XyoNetworkPayloadWrapper.html#load" class="tsd-index-link 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>load</span></a>
|
|
@@ -123,16 +123,7 @@
|
|
|
123
123
|
<li class="tsd-description">
|
|
124
124
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</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">docs</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">name</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">slug</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">type</span><span class="tsd-signature-symbol">: </span><a href="../types/XyoNetworkNodeType.html" class="tsd-signature-type tsd-kind-type-alias">XyoNetworkNodeType</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">uri</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">web</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> </span><span class="tsd-kind-property">schema</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"network.xyo.network.node"</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">
|
|
125
125
|
<ul>
|
|
126
|
-
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/
|
|
127
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="body" class="tsd-anchor"></a>
|
|
128
|
-
<h3 class="tsd-anchor-link"><span>body</span><a href="#body" 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
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
130
|
-
<li class="tsd-signature" id="body.body-1"><span class="tsd-signature-symbol">get</span> body<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">TPayload</span></li>
|
|
131
|
-
<li class="tsd-description">
|
|
132
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">TPayload</span></h4><aside class="tsd-sources">
|
|
133
|
-
<p>Inherited from PayloadWrapper.body</p>
|
|
134
|
-
<ul>
|
|
135
|
-
<li>Defined in protocol/packages/payload/packages/wrapper/dist/types/Wrapper.d.ts:8</li></ul></aside></li></ul></section>
|
|
126
|
+
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/07894923abf1/packages/sdk/packages/network/src/XyoNetworkPayloadWrapper.ts#L8">sdk/packages/network/src/XyoNetworkPayloadWrapper.ts:8</a></li></ul></aside></li></ul></section>
|
|
136
127
|
<section class="tsd-panel tsd-member"><a id="bridges" class="tsd-anchor"></a>
|
|
137
128
|
<h3 class="tsd-anchor-link"><span>bridges</span><a href="#bridges" 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>
|
|
138
129
|
<ul class="tsd-signatures">
|
|
@@ -140,7 +131,7 @@
|
|
|
140
131
|
<li class="tsd-description">
|
|
141
132
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</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">docs</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">name</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">slug</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">type</span><span class="tsd-signature-symbol">: </span><a href="../types/XyoNetworkNodeType.html" class="tsd-signature-type tsd-kind-type-alias">XyoNetworkNodeType</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">uri</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">web</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> </span><span class="tsd-kind-property">schema</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"network.xyo.network.node"</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">
|
|
142
133
|
<ul>
|
|
143
|
-
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/
|
|
134
|
+
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/07894923abf1/packages/sdk/packages/network/src/XyoNetworkPayloadWrapper.ts#L12">sdk/packages/network/src/XyoNetworkPayloadWrapper.ts:12</a></li></ul></aside></li></ul></section>
|
|
144
135
|
<section class="tsd-panel tsd-member"><a id="diviners" class="tsd-anchor"></a>
|
|
145
136
|
<h3 class="tsd-anchor-link"><span>diviners</span><a href="#diviners" 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>
|
|
146
137
|
<ul class="tsd-signatures">
|
|
@@ -148,7 +139,7 @@
|
|
|
148
139
|
<li class="tsd-description">
|
|
149
140
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</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">docs</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">name</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">slug</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">type</span><span class="tsd-signature-symbol">: </span><a href="../types/XyoNetworkNodeType.html" class="tsd-signature-type tsd-kind-type-alias">XyoNetworkNodeType</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">uri</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">web</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> </span><span class="tsd-kind-property">schema</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"network.xyo.network.node"</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">
|
|
150
141
|
<ul>
|
|
151
|
-
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/
|
|
142
|
+
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/07894923abf1/packages/sdk/packages/network/src/XyoNetworkPayloadWrapper.ts#L16">sdk/packages/network/src/XyoNetworkPayloadWrapper.ts:16</a></li></ul></aside></li></ul></section>
|
|
152
143
|
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="hash" class="tsd-anchor"></a>
|
|
153
144
|
<h3 class="tsd-anchor-link"><span>hash</span><a href="#hash" 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
145
|
<ul class="tsd-signatures tsd-is-inherited">
|
|
@@ -170,33 +161,6 @@
|
|
|
170
161
|
<p>Inherited from PayloadWrapper.hashFields</p>
|
|
171
162
|
<ul>
|
|
172
163
|
<li>Defined in protocol/packages/core/dist/types/Hasher/Hasher.d.ts:8</li></ul></aside></li></ul></section>
|
|
173
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="payload" class="tsd-anchor"></a>
|
|
174
|
-
<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>
|
|
175
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
176
|
-
<li class="tsd-signature" id="payload.payload-1"><span class="tsd-signature-symbol">get</span> payload<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">TPayload</span></li>
|
|
177
|
-
<li class="tsd-description">
|
|
178
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">TPayload</span></h4><aside class="tsd-sources">
|
|
179
|
-
<p>Inherited from PayloadWrapper.payload</p>
|
|
180
|
-
<ul>
|
|
181
|
-
<li>Defined in protocol/packages/payload/packages/wrapper/dist/types/Wrapper.d.ts:9</li></ul></aside></li></ul></section>
|
|
182
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="schema" class="tsd-anchor"></a>
|
|
183
|
-
<h3 class="tsd-anchor-link"><span>schema</span><a href="#schema" 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>
|
|
184
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
185
|
-
<li class="tsd-signature" id="schema.schema-1"><span class="tsd-signature-symbol">get</span> schema<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
|
186
|
-
<li class="tsd-description">
|
|
187
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
|
188
|
-
<p>Inherited from PayloadWrapper.schema</p>
|
|
189
|
-
<ul>
|
|
190
|
-
<li>Defined in protocol/packages/payload/packages/wrapper/dist/types/Wrapper.d.ts:10</li></ul></aside></li></ul></section>
|
|
191
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="schemaName" class="tsd-anchor"></a>
|
|
192
|
-
<h3 class="tsd-anchor-link"><span>schema<wbr/>Name</span><a href="#schemaName" 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
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
194
|
-
<li class="tsd-signature" id="schemaName.schemaName-1"><span class="tsd-signature-symbol">get</span> schemaName<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
|
195
|
-
<li class="tsd-description">
|
|
196
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
|
197
|
-
<p>Inherited from PayloadWrapper.schemaName</p>
|
|
198
|
-
<ul>
|
|
199
|
-
<li>Defined in protocol/packages/payload/packages/wrapper/dist/types/Wrapper.d.ts:11</li></ul></aside></li></ul></section>
|
|
200
164
|
<section class="tsd-panel tsd-member"><a id="sentinels" class="tsd-anchor"></a>
|
|
201
165
|
<h3 class="tsd-anchor-link"><span>sentinels</span><a href="#sentinels" 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>
|
|
202
166
|
<ul class="tsd-signatures">
|
|
@@ -204,7 +168,7 @@
|
|
|
204
168
|
<li class="tsd-description">
|
|
205
169
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</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">docs</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">name</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">slug</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">type</span><span class="tsd-signature-symbol">: </span><a href="../types/XyoNetworkNodeType.html" class="tsd-signature-type tsd-kind-type-alias">XyoNetworkNodeType</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">uri</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">web</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> </span><span class="tsd-kind-property">schema</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"network.xyo.network.node"</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">
|
|
206
170
|
<ul>
|
|
207
|
-
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/
|
|
171
|
+
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/07894923abf1/packages/sdk/packages/network/src/XyoNetworkPayloadWrapper.ts#L20">sdk/packages/network/src/XyoNetworkPayloadWrapper.ts:20</a></li></ul></aside></li></ul></section>
|
|
208
172
|
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="stringKeyObj" class="tsd-anchor"></a>
|
|
209
173
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>string<wbr/>Key<wbr/>Obj</span><a href="#stringKeyObj" 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>
|
|
210
174
|
<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
|
|
@@ -225,6 +189,15 @@
|
|
|
225
189
|
<li>Defined in protocol/packages/core/dist/types/Hasher/Hasher.d.ts:9</li></ul></aside></li></ul></section></section>
|
|
226
190
|
<section class="tsd-panel-group tsd-member-group">
|
|
227
191
|
<h2>Methods</h2>
|
|
192
|
+
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="body" class="tsd-anchor"></a>
|
|
193
|
+
<h3 class="tsd-anchor-link"><span>body</span><a href="#body" 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>
|
|
194
|
+
<ul class="tsd-signatures tsd-is-inherited">
|
|
195
|
+
<li class="tsd-signature tsd-anchor-link" id="body.body-1"><span class="tsd-kind-call-signature">body</span><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">name</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">nodes</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">docs</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">name</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">slug</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">type</span><span class="tsd-signature-symbol">: </span><a href="../types/XyoNetworkNodeType.html" class="tsd-signature-type tsd-kind-type-alias">XyoNetworkNodeType</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">uri</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">web</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-signature-symbol">}</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">"network.xyo.network.node"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">schema</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"network.xyo.network"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">slug</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><a href="#body.body-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>
|
|
196
|
+
<li class="tsd-description">
|
|
197
|
+
<h4 class="tsd-returns-title">Returns <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">name</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">nodes</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">docs</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">name</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">slug</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">type</span><span class="tsd-signature-symbol">: </span><a href="../types/XyoNetworkNodeType.html" class="tsd-signature-type tsd-kind-type-alias">XyoNetworkNodeType</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">uri</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">web</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-signature-symbol">}</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">"network.xyo.network.node"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">schema</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"network.xyo.network"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">slug</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><aside class="tsd-sources">
|
|
198
|
+
<p>Inherited from PayloadWrapper.body</p>
|
|
199
|
+
<ul>
|
|
200
|
+
<li>Defined in protocol/packages/payload/packages/wrapper/dist/types/Wrapper.d.ts:16</li></ul></aside></li></ul></section>
|
|
228
201
|
<section class="tsd-panel tsd-member"><a id="filterNodesByType" class="tsd-anchor"></a>
|
|
229
202
|
<h3 class="tsd-anchor-link"><span>filter<wbr/>Nodes<wbr/>By<wbr/>Type</span><a href="#filterNodesByType" 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>
|
|
230
203
|
<ul class="tsd-signatures">
|
|
@@ -237,7 +210,7 @@
|
|
|
237
210
|
<h5><span class="tsd-kind-parameter">type</span>: <a href="../types/XyoNetworkNodeType.html" class="tsd-signature-type tsd-kind-type-alias">XyoNetworkNodeType</a></h5></li></ul></div>
|
|
238
211
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</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">docs</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">name</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">slug</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">type</span><span class="tsd-signature-symbol">: </span><a href="../types/XyoNetworkNodeType.html" class="tsd-signature-type tsd-kind-type-alias">XyoNetworkNodeType</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">uri</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">web</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> </span><span class="tsd-kind-property">schema</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"network.xyo.network.node"</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">
|
|
239
212
|
<ul>
|
|
240
|
-
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/
|
|
213
|
+
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/07894923abf1/packages/sdk/packages/network/src/XyoNetworkPayloadWrapper.ts#L28">sdk/packages/network/src/XyoNetworkPayloadWrapper.ts:28</a></li></ul></aside></li></ul></section>
|
|
241
214
|
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="getErrors" class="tsd-anchor"></a>
|
|
242
215
|
<h3 class="tsd-anchor-link"><span>get<wbr/>Errors</span><a href="#getErrors" 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>
|
|
243
216
|
<ul class="tsd-signatures tsd-is-inherited">
|
|
@@ -246,7 +219,7 @@
|
|
|
246
219
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">Error</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
247
220
|
<p>Inherited from PayloadWrapper.getErrors</p>
|
|
248
221
|
<ul>
|
|
249
|
-
<li>Defined in protocol/packages/payload/packages/wrapper/dist/types/Wrapper.d.ts:
|
|
222
|
+
<li>Defined in protocol/packages/payload/packages/wrapper/dist/types/Wrapper.d.ts:17</li></ul></aside></li></ul></section>
|
|
250
223
|
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="getValid" class="tsd-anchor"></a>
|
|
251
224
|
<h3 class="tsd-anchor-link"><span>get<wbr/>Valid</span><a href="#getValid" 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>
|
|
252
225
|
<ul class="tsd-signatures tsd-is-inherited">
|
|
@@ -255,7 +228,7 @@
|
|
|
255
228
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
256
229
|
<p>Inherited from PayloadWrapper.getValid</p>
|
|
257
230
|
<ul>
|
|
258
|
-
<li>Defined in protocol/packages/payload/packages/wrapper/dist/types/Wrapper.d.ts:
|
|
231
|
+
<li>Defined in protocol/packages/payload/packages/wrapper/dist/types/Wrapper.d.ts:18</li></ul></aside></li></ul></section>
|
|
259
232
|
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="hashAsync" class="tsd-anchor"></a>
|
|
260
233
|
<h3 class="tsd-anchor-link"><span>hash<wbr/>Async</span><a href="#hashAsync" 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>
|
|
261
234
|
<ul class="tsd-signatures tsd-is-inherited">
|
|
@@ -264,7 +237,25 @@
|
|
|
264
237
|
<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></h4><aside class="tsd-sources">
|
|
265
238
|
<p>Inherited from PayloadWrapper.hashAsync</p>
|
|
266
239
|
<ul>
|
|
267
|
-
<li>Defined in protocol/packages/core/dist/types/Hasher/Hasher.d.ts:
|
|
240
|
+
<li>Defined in protocol/packages/core/dist/types/Hasher/Hasher.d.ts:22</li></ul></aside></li></ul></section>
|
|
241
|
+
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="payload" class="tsd-anchor"></a>
|
|
242
|
+
<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>
|
|
243
|
+
<ul class="tsd-signatures tsd-is-inherited">
|
|
244
|
+
<li class="tsd-signature tsd-anchor-link" id="payload.payload-1"><span class="tsd-kind-call-signature">payload</span><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">name</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">nodes</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">docs</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">name</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">slug</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">type</span><span class="tsd-signature-symbol">: </span><a href="../types/XyoNetworkNodeType.html" class="tsd-signature-type tsd-kind-type-alias">XyoNetworkNodeType</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">uri</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">web</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-signature-symbol">}</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">"network.xyo.network.node"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">schema</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"network.xyo.network"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">slug</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><a href="#payload.payload-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>
|
|
245
|
+
<li class="tsd-description">
|
|
246
|
+
<h4 class="tsd-returns-title">Returns <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">name</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">nodes</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">docs</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">name</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">slug</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">type</span><span class="tsd-signature-symbol">: </span><a href="../types/XyoNetworkNodeType.html" class="tsd-signature-type tsd-kind-type-alias">XyoNetworkNodeType</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">uri</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">web</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-signature-symbol">}</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">"network.xyo.network.node"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">schema</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"network.xyo.network"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">slug</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><aside class="tsd-sources">
|
|
247
|
+
<p>Inherited from PayloadWrapper.payload</p>
|
|
248
|
+
<ul>
|
|
249
|
+
<li>Defined in protocol/packages/payload/packages/wrapper/dist/types/Wrapper.d.ts:19</li></ul></aside></li></ul></section>
|
|
250
|
+
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="schema" class="tsd-anchor"></a>
|
|
251
|
+
<h3 class="tsd-anchor-link"><span>schema</span><a href="#schema" 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>
|
|
252
|
+
<ul class="tsd-signatures tsd-is-inherited">
|
|
253
|
+
<li class="tsd-signature tsd-anchor-link" id="schema.schema-1"><span class="tsd-kind-call-signature">schema</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#schema.schema-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>
|
|
254
|
+
<li class="tsd-description">
|
|
255
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
|
256
|
+
<p>Inherited from PayloadWrapper.schema</p>
|
|
257
|
+
<ul>
|
|
258
|
+
<li>Defined in protocol/packages/payload/packages/wrapper/dist/types/Wrapper.d.ts:20</li></ul></aside></li></ul></section>
|
|
268
259
|
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="validate" class="tsd-anchor"></a>
|
|
269
260
|
<h3 class="tsd-anchor-link"><span>validate</span><a href="#validate" 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>
|
|
270
261
|
<ul class="tsd-signatures tsd-is-inherited">
|
|
@@ -273,7 +264,7 @@
|
|
|
273
264
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">Error</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
274
265
|
<p>Inherited from PayloadWrapper.validate</p>
|
|
275
266
|
<ul>
|
|
276
|
-
<li>Defined in protocol/packages/payload/packages/wrapper/dist/types/Wrapper.d.ts:
|
|
267
|
+
<li>Defined in protocol/packages/payload/packages/wrapper/dist/types/Wrapper.d.ts:32</li></ul></aside></li></ul></section>
|
|
277
268
|
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="filterExclude" class="tsd-anchor"></a>
|
|
278
269
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>filter<wbr/>Exclude</span><a href="#filterExclude" 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>
|
|
279
270
|
<ul class="tsd-signatures tsd-is-inherited">
|
|
@@ -343,7 +334,7 @@
|
|
|
343
334
|
<li class="tsd-signature tsd-anchor-link" id="hash-2.hash-3"><span class="tsd-kind-call-signature">hash</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">obj</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#hash-2.hash-3" 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>
|
|
344
335
|
<li class="tsd-description">
|
|
345
336
|
<div class="tsd-comment tsd-typography">
|
|
346
|
-
<h3>Deprecated</h3><p>use hashAsync instead</p>
|
|
337
|
+
<h3>Deprecated</h3><p>use hashSync or hashAsync instead</p>
|
|
347
338
|
</div>
|
|
348
339
|
<section class="tsd-panel">
|
|
349
340
|
<h4>Type Parameters</h4>
|
|
@@ -416,6 +407,25 @@
|
|
|
416
407
|
<p>Inherited from PayloadWrapper.hashPairs</p>
|
|
417
408
|
<ul>
|
|
418
409
|
<li>Defined in protocol/packages/core/dist/types/Hasher/Hasher.d.ts:17</li></ul></aside></li></ul></section>
|
|
410
|
+
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="hashSync" class="tsd-anchor"></a>
|
|
411
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>hash<wbr/>Sync</span><a href="#hashSync" 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>
|
|
412
|
+
<ul class="tsd-signatures tsd-is-inherited">
|
|
413
|
+
<li class="tsd-signature tsd-anchor-link" id="hashSync.hashSync-1"><span class="tsd-kind-call-signature">hash<wbr/>Sync</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">obj</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#hashSync.hashSync-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>
|
|
414
|
+
<li class="tsd-description">
|
|
415
|
+
<section class="tsd-panel">
|
|
416
|
+
<h4>Type Parameters</h4>
|
|
417
|
+
<ul class="tsd-type-parameter-list">
|
|
418
|
+
<li>
|
|
419
|
+
<h4><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type ">AnyObject</span></h4></li></ul></section>
|
|
420
|
+
<div class="tsd-parameters">
|
|
421
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
422
|
+
<ul class="tsd-parameter-list">
|
|
423
|
+
<li>
|
|
424
|
+
<h5><span class="tsd-kind-parameter">obj</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li></ul></div>
|
|
425
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
|
426
|
+
<p>Inherited from PayloadWrapper.hashSync</p>
|
|
427
|
+
<ul>
|
|
428
|
+
<li>Defined in protocol/packages/core/dist/types/Hasher/Hasher.d.ts:18</li></ul></aside></li></ul></section>
|
|
419
429
|
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="hashes" class="tsd-anchor"></a>
|
|
420
430
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>hashes</span><a href="#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>
|
|
421
431
|
<ul class="tsd-signatures tsd-is-inherited">
|
|
@@ -434,7 +444,7 @@
|
|
|
434
444
|
<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">
|
|
435
445
|
<p>Inherited from PayloadWrapper.hashes</p>
|
|
436
446
|
<ul>
|
|
437
|
-
<li>Defined in protocol/packages/core/dist/types/Hasher/Hasher.d.ts:
|
|
447
|
+
<li>Defined in protocol/packages/core/dist/types/Hasher/Hasher.d.ts:19</li></ul></aside></li></ul></section>
|
|
438
448
|
<section class="tsd-panel tsd-member"><a id="known" class="tsd-anchor"></a>
|
|
439
449
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>known</span><a href="#known" 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>
|
|
440
450
|
<ul class="tsd-signatures">
|
|
@@ -447,7 +457,7 @@
|
|
|
447
457
|
<h5><span class="tsd-kind-parameter">hash</span>: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
448
458
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">undefined</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">name</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">nodes</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">docs</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">name</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">slug</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">type</span><span class="tsd-signature-symbol">: </span><a href="../types/XyoNetworkNodeType.html" class="tsd-signature-type tsd-kind-type-alias">XyoNetworkNodeType</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">uri</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">web</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-signature-symbol">}</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">"network.xyo.network.node"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">schema</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"network.xyo.network"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">slug</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></h4><aside class="tsd-sources">
|
|
449
459
|
<ul>
|
|
450
|
-
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/
|
|
460
|
+
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/07894923abf1/packages/sdk/packages/network/src/XyoNetworkPayloadWrapper.ts#L24">sdk/packages/network/src/XyoNetworkPayloadWrapper.ts:24</a></li></ul></aside></li></ul></section>
|
|
451
461
|
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="load" class="tsd-anchor"></a>
|
|
452
462
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>load</span><a href="#load" 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>
|
|
453
463
|
<ul class="tsd-signatures tsd-is-inherited">
|
|
@@ -461,11 +471,11 @@
|
|
|
461
471
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</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 ">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></h4><aside class="tsd-sources">
|
|
462
472
|
<p>Inherited from PayloadWrapper.load</p>
|
|
463
473
|
<ul>
|
|
464
|
-
<li>Defined in protocol/packages/payload/packages/wrapper/dist/types/Wrapper.d.ts:
|
|
474
|
+
<li>Defined in protocol/packages/payload/packages/wrapper/dist/types/Wrapper.d.ts:26</li></ul></aside></li></ul></section>
|
|
465
475
|
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="parse" class="tsd-anchor"></a>
|
|
466
476
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>parse</span><a href="#parse" 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>
|
|
467
477
|
<ul class="tsd-signatures tsd-is-inherited">
|
|
468
|
-
<li class="tsd-signature tsd-anchor-link" id="parse.parse-1"><span class="tsd-kind-call-signature">parse</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">payload</span><span class="tsd-signature-symbol">)</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><a href="#parse.parse-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>
|
|
478
|
+
<li class="tsd-signature tsd-anchor-link" id="parse.parse-1"><span class="tsd-kind-call-signature">parse</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">payload</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</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><a href="#parse.parse-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>
|
|
469
479
|
<li class="tsd-description">
|
|
470
480
|
<section class="tsd-panel">
|
|
471
481
|
<h4>Type Parameters</h4>
|
|
@@ -476,11 +486,11 @@
|
|
|
476
486
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
477
487
|
<ul class="tsd-parameter-list">
|
|
478
488
|
<li>
|
|
479
|
-
<h5><span class="tsd-kind-parameter">payload</span>: <span class="tsd-signature-type">
|
|
489
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">payload</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</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></h5></li></ul></div>
|
|
480
490
|
<h4 class="tsd-returns-title">Returns <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><aside class="tsd-sources">
|
|
481
491
|
<p>Inherited from PayloadWrapper.parse</p>
|
|
482
492
|
<ul>
|
|
483
|
-
<li>Defined in protocol/packages/payload/packages/wrapper/dist/types/Wrapper.d.ts:
|
|
493
|
+
<li>Defined in protocol/packages/payload/packages/wrapper/dist/types/Wrapper.d.ts:29</li></ul></aside></li></ul></section>
|
|
484
494
|
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="setLoaderFactory" class="tsd-anchor"></a>
|
|
485
495
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>set<wbr/>Loader<wbr/>Factory</span><a href="#setLoaderFactory" 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>
|
|
486
496
|
<ul class="tsd-signatures tsd-is-inherited">
|
|
@@ -494,7 +504,7 @@
|
|
|
494
504
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
495
505
|
<p>Inherited from PayloadWrapper.setLoaderFactory</p>
|
|
496
506
|
<ul>
|
|
497
|
-
<li>Defined in protocol/packages/payload/packages/wrapper/dist/types/Wrapper.d.ts:
|
|
507
|
+
<li>Defined in protocol/packages/payload/packages/wrapper/dist/types/Wrapper.d.ts:30</li></ul></aside></li></ul></section>
|
|
498
508
|
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="stringify" class="tsd-anchor"></a>
|
|
499
509
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>stringify</span><a href="#stringify" 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>
|
|
500
510
|
<ul class="tsd-signatures tsd-is-inherited">
|
|
@@ -513,7 +523,7 @@
|
|
|
513
523
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
|
514
524
|
<p>Inherited from PayloadWrapper.stringify</p>
|
|
515
525
|
<ul>
|
|
516
|
-
<li>Defined in protocol/packages/core/dist/types/Hasher/Hasher.d.ts:
|
|
526
|
+
<li>Defined in protocol/packages/core/dist/types/Hasher/Hasher.d.ts:20</li></ul></aside></li></ul></section>
|
|
517
527
|
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="toMap" class="tsd-anchor"></a>
|
|
518
528
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>to<wbr/>Map</span><a href="#toMap" 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>
|
|
519
529
|
<ul class="tsd-signatures tsd-is-inherited">
|
|
@@ -532,7 +542,7 @@
|
|
|
532
542
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
533
543
|
<p>Inherited from PayloadWrapper.toMap</p>
|
|
534
544
|
<ul>
|
|
535
|
-
<li>Defined in protocol/packages/core/dist/types/Hasher/Hasher.d.ts:
|
|
545
|
+
<li>Defined in protocol/packages/core/dist/types/Hasher/Hasher.d.ts:21</li></ul></aside></li></ul></section>
|
|
536
546
|
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="toWrappedMap" class="tsd-anchor"></a>
|
|
537
547
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>to<wbr/>Wrapped<wbr/>Map</span><a href="#toWrappedMap" 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>
|
|
538
548
|
<ul class="tsd-signatures tsd-is-inherited">
|
|
@@ -551,7 +561,7 @@
|
|
|
551
561
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type ">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-symbol">></span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
552
562
|
<p>Inherited from PayloadWrapper.toWrappedMap</p>
|
|
553
563
|
<ul>
|
|
554
|
-
<li>Defined in protocol/packages/payload/packages/wrapper/dist/types/Wrapper.d.ts:
|
|
564
|
+
<li>Defined in protocol/packages/payload/packages/wrapper/dist/types/Wrapper.d.ts:31</li></ul></aside></li></ul></section>
|
|
555
565
|
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="tryParse" class="tsd-anchor"></a>
|
|
556
566
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>try<wbr/>Parse</span><a href="#tryParse" 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>
|
|
557
567
|
<ul class="tsd-signatures tsd-is-inherited">
|
|
@@ -565,42 +575,46 @@
|
|
|
565
575
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">PayloadWrapperBase</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></h4><aside class="tsd-sources">
|
|
566
576
|
<p>Inherited from PayloadWrapper.tryParse</p>
|
|
567
577
|
<ul>
|
|
568
|
-
<li>Defined in protocol/packages/payload/packages/wrapper/dist/types/Wrapper.d.ts:
|
|
578
|
+
<li>Defined in protocol/packages/payload/packages/wrapper/dist/types/Wrapper.d.ts:10</li></ul></aside></li></ul></section>
|
|
569
579
|
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="unwrap" class="tsd-anchor"></a>
|
|
570
580
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>unwrap</span><a href="#unwrap" 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>
|
|
571
581
|
<ul class="tsd-signatures tsd-is-inherited">
|
|
572
|
-
<li class="tsd-signature tsd-anchor-link" id="unwrap.unwrap-1"><span class="tsd-kind-call-signature">unwrap</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TPayload</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">payload</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type tsd-kind-type-parameter">TPayload</span><a href="#unwrap.unwrap-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>
|
|
582
|
+
<li class="tsd-signature tsd-anchor-link" id="unwrap.unwrap-1"><span class="tsd-kind-call-signature">unwrap</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TPayload</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TWrapper</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">payload</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type tsd-kind-type-parameter">TPayload</span><a href="#unwrap.unwrap-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>
|
|
573
583
|
<li class="tsd-description">
|
|
574
584
|
<section class="tsd-panel">
|
|
575
585
|
<h4>Type Parameters</h4>
|
|
576
586
|
<ul class="tsd-type-parameter-list">
|
|
577
587
|
<li>
|
|
578
|
-
<h4><span class="tsd-kind-type-parameter">TPayload</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><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-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></h4></li
|
|
588
|
+
<h4><span class="tsd-kind-type-parameter">TPayload</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><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-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></h4></li>
|
|
589
|
+
<li>
|
|
590
|
+
<h4><span class="tsd-kind-type-parameter">TWrapper</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type ">PayloadWrapperBase</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TPayload</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TWrapper</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">TPayload</span><span class="tsd-signature-symbol">></span></h4></li></ul></section>
|
|
579
591
|
<div class="tsd-parameters">
|
|
580
592
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
581
593
|
<ul class="tsd-parameter-list">
|
|
582
594
|
<li>
|
|
583
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">payload</span>: <span class="tsd-signature-type tsd-kind-type-parameter">TPayload</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type
|
|
595
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">payload</span>: <span class="tsd-signature-type tsd-kind-type-parameter">TPayload</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type tsd-kind-type-parameter">TWrapper</span></h5></li></ul></div>
|
|
584
596
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type tsd-kind-type-parameter">TPayload</span></h4><aside class="tsd-sources">
|
|
585
597
|
<p>Inherited from PayloadWrapper.unwrap</p>
|
|
586
598
|
<ul>
|
|
587
|
-
<li>Defined in protocol/packages/payload/packages/wrapper/dist/types/Wrapper.d.ts:
|
|
588
|
-
<li class="tsd-signature tsd-anchor-link" id="unwrap.unwrap-2"><span class="tsd-kind-call-signature">unwrap</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TPayload</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">payload</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><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type tsd-kind-type-parameter">TPayload</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><a href="#unwrap.unwrap-2" 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>
|
|
599
|
+
<li>Defined in protocol/packages/payload/packages/wrapper/dist/types/Wrapper.d.ts:13</li></ul></aside></li>
|
|
600
|
+
<li class="tsd-signature tsd-anchor-link" id="unwrap.unwrap-2"><span class="tsd-kind-call-signature">unwrap</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TPayload</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TWrapper</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">payload</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><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type tsd-kind-type-parameter">TPayload</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><a href="#unwrap.unwrap-2" 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>
|
|
589
601
|
<li class="tsd-description">
|
|
590
602
|
<section class="tsd-panel">
|
|
591
603
|
<h4>Type Parameters</h4>
|
|
592
604
|
<ul class="tsd-type-parameter-list">
|
|
593
605
|
<li>
|
|
594
|
-
<h4><span class="tsd-kind-type-parameter">TPayload</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><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-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></h4></li
|
|
606
|
+
<h4><span class="tsd-kind-type-parameter">TPayload</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><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-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></h4></li>
|
|
607
|
+
<li>
|
|
608
|
+
<h4><span class="tsd-kind-type-parameter">TWrapper</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type ">PayloadWrapperBase</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TPayload</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TWrapper</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">TPayload</span><span class="tsd-signature-symbol">></span></h4></li></ul></section>
|
|
595
609
|
<div class="tsd-parameters">
|
|
596
610
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
597
611
|
<ul class="tsd-parameter-list">
|
|
598
612
|
<li>
|
|
599
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">payload</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-type tsd-kind-type-parameter">TPayload</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type
|
|
613
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">payload</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-type tsd-kind-type-parameter">TPayload</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type tsd-kind-type-parameter">TWrapper</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
|
600
614
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type tsd-kind-type-parameter">TPayload</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
|
|
601
615
|
<p>Inherited from PayloadWrapper.unwrap</p>
|
|
602
616
|
<ul>
|
|
603
|
-
<li>Defined in protocol/packages/payload/packages/wrapper/dist/types/Wrapper.d.ts:
|
|
617
|
+
<li>Defined in protocol/packages/payload/packages/wrapper/dist/types/Wrapper.d.ts:14</li></ul></aside></li></ul></section></section></div>
|
|
604
618
|
<div class="col-sidebar">
|
|
605
619
|
<div class="page-menu">
|
|
606
620
|
<div class="tsd-navigation settings">
|
|
@@ -624,21 +638,20 @@
|
|
|
624
638
|
<li><a href="#wasmInitialized" 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>wasm<wbr/>Initialized</span></a></li>
|
|
625
639
|
<li><a href="#wasmSupport" 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>wasm<wbr/>Support</span></a></li>
|
|
626
640
|
<li><a href="#archivists" class=""><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>archivists</span></a></li>
|
|
627
|
-
<li><a href="#body" class="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>body</span></a></li>
|
|
628
641
|
<li><a href="#bridges" class=""><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>bridges</span></a></li>
|
|
629
642
|
<li><a href="#diviners" class=""><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>diviners</span></a></li>
|
|
630
643
|
<li><a href="#hash" class="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>hash</span></a></li>
|
|
631
644
|
<li><a href="#hashFields" class="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>hash<wbr/>Fields</span></a></li>
|
|
632
|
-
<li><a href="#payload" class="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</span></a></li>
|
|
633
|
-
<li><a href="#schema" class="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>schema</span></a></li>
|
|
634
|
-
<li><a href="#schemaName" class="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>schema<wbr/>Name</span></a></li>
|
|
635
645
|
<li><a href="#sentinels" class=""><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>sentinels</span></a></li>
|
|
636
646
|
<li><a href="#stringKeyObj" class="tsd-is-protected 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>string<wbr/>Key<wbr/>Obj</span></a></li>
|
|
637
647
|
<li><a href="#stringified" class="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>stringified</span></a></li>
|
|
648
|
+
<li><a href="#body" 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>body</span></a></li>
|
|
638
649
|
<li><a href="#filterNodesByType" 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>filter<wbr/>Nodes<wbr/>By<wbr/>Type</span></a></li>
|
|
639
650
|
<li><a href="#getErrors" 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>get<wbr/>Errors</span></a></li>
|
|
640
651
|
<li><a href="#getValid" 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>get<wbr/>Valid</span></a></li>
|
|
641
652
|
<li><a href="#hashAsync" 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>hash<wbr/>Async</span></a></li>
|
|
653
|
+
<li><a href="#payload" 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>payload</span></a></li>
|
|
654
|
+
<li><a href="#schema" 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>schema</span></a></li>
|
|
642
655
|
<li><a href="#validate" 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>validate</span></a></li>
|
|
643
656
|
<li><a href="#filterExclude" 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>filter<wbr/>Exclude</span></a></li>
|
|
644
657
|
<li><a href="#filterInclude" 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>filter<wbr/>Include</span></a></li>
|
|
@@ -647,6 +660,7 @@
|
|
|
647
660
|
<li><a href="#hashAsync-2" 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>hash<wbr/>Async</span></a></li>
|
|
648
661
|
<li><a href="#hashFields-2" 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>hash<wbr/>Fields</span></a></li>
|
|
649
662
|
<li><a href="#hashPairs" 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>hash<wbr/>Pairs</span></a></li>
|
|
663
|
+
<li><a href="#hashSync" 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>hash<wbr/>Sync</span></a></li>
|
|
650
664
|
<li><a href="#hashes" 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>hashes</span></a></li>
|
|
651
665
|
<li><a href="#known" 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>known</span></a></li>
|
|
652
666
|
<li><a href="#load" 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>load</span></a></li>
|