quantus/api
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[CI Skip] 0.33.6

Browse Source
This commit is contained in:
Travis CI
2018-12-08 14:37:17 +00:00
parent 448a729d70
commit c30cecf0c1
350 changed files with 7154 additions and 43761 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/GLOSSARY.html
+31 -31
View File
@@ -1118,9 +1118,9 @@
</li>
<li class="chapter " data-level="4.58" data-path="types/classes/_metadata_.callmetadata.html">
<li class="chapter " data-level="4.58" data-path="types/classes/_metadata_.callmetadata.md">
<a href="types/classes/_metadata_.callmetadata.html">
<span>
hidden
@@ -1131,9 +1131,9 @@
</li>
<li class="chapter " data-level="4.59" data-path="types/classes/_metadata_.eventmetadata.html">
<li class="chapter " data-level="4.59" data-path="types/classes/_metadata_.eventmetadata.md">
<a href="types/classes/_metadata_.eventmetadata.html">
<span>
hidden
@@ -1144,9 +1144,9 @@
</li>
<li class="chapter " data-level="4.60" data-path="types/classes/_metadata_.functionargumentmetadata.html">
<li class="chapter " data-level="4.60" data-path="types/classes/_metadata_.functionargumentmetadata.md">
<a href="types/classes/_metadata_.functionargumentmetadata.html">
<span>
hidden
@@ -1157,9 +1157,9 @@
</li>
<li class="chapter " data-level="4.61" data-path="types/classes/_metadata_.functionmetadata.html">
<li class="chapter " data-level="4.61" data-path="types/classes/_metadata_.functionmetadata.md">
<a href="types/classes/_metadata_.functionmetadata.html">
<span>
hidden
@@ -1170,9 +1170,9 @@
</li>
<li class="chapter " data-level="4.62" data-path="types/classes/_metadata_.modulemetadata.html">
<li class="chapter " data-level="4.62" data-path="types/classes/_metadata_.modulemetadata.md">
<a href="types/classes/_metadata_.modulemetadata.html">
<span>
hidden
@@ -1183,9 +1183,9 @@
</li>
<li class="chapter " data-level="4.63" data-path="types/classes/_metadata_.outerdispatchcall.html">
<li class="chapter " data-level="4.63" data-path="types/classes/_metadata_.outerdispatchcall.md">
<a href="types/classes/_metadata_.outerdispatchcall.html">
<span>
hidden
@@ -1196,9 +1196,9 @@
</li>
<li class="chapter " data-level="4.64" data-path="types/classes/_metadata_.outerdispatchmetadata.html">
<li class="chapter " data-level="4.64" data-path="types/classes/_metadata_.outerdispatchmetadata.md">
<a href="types/classes/_metadata_.outerdispatchmetadata.html">
<span>
hidden
@@ -1209,9 +1209,9 @@
</li>
<li class="chapter " data-level="4.65" data-path="types/classes/_metadata_.outereventmetadata.html">
<li class="chapter " data-level="4.65" data-path="types/classes/_metadata_.outereventmetadata.md">
<a href="types/classes/_metadata_.outereventmetadata.html">
<span>
hidden
@@ -1222,9 +1222,9 @@
</li>
<li class="chapter " data-level="4.66" data-path="types/classes/_metadata_.outereventmetadataevent.html">
<li class="chapter " data-level="4.66" data-path="types/classes/_metadata_.outereventmetadataevent.md">
<a href="types/classes/_metadata_.outereventmetadataevent.html">
<span>
hidden
@@ -1248,9 +1248,9 @@
</li>
<li class="chapter " data-level="4.68" data-path="types/classes/_metadata_.runtimemodulemetadata.html">
<li class="chapter " data-level="4.68" data-path="types/classes/_metadata_.runtimemodulemetadata.md">
<a href="types/classes/_metadata_.runtimemodulemetadata.html">
<span>
hidden
@@ -1261,9 +1261,9 @@
</li>
<li class="chapter " data-level="4.69" data-path="types/classes/_metadata_.storagefunctionmetadata.html">
<li class="chapter " data-level="4.69" data-path="types/classes/_metadata_.storagefunctionmetadata.md">
<a href="types/classes/_metadata_.storagefunctionmetadata.html">
<span>
hidden
@@ -1274,9 +1274,9 @@
</li>
<li class="chapter " data-level="4.70" data-path="types/classes/_metadata_.storagefunctionmodifier.html">
<li class="chapter " data-level="4.70" data-path="types/classes/_metadata_.storagefunctionmodifier.md">
<a href="types/classes/_metadata_.storagefunctionmodifier.html">
<span>
hidden
@@ -1287,9 +1287,9 @@
</li>
<li class="chapter " data-level="4.71" data-path="types/classes/_metadata_.storagefunctiontype.html">
<li class="chapter " data-level="4.71" data-path="types/classes/_metadata_.storagefunctiontype.md">
<a href="types/classes/_metadata_.storagefunctiontype.html">
<span>
hidden
@@ -1300,9 +1300,9 @@
</li>
<li class="chapter " data-level="4.72" data-path="types/classes/_metadata_.storagefunctiontype_map.html">
<li class="chapter " data-level="4.72" data-path="types/classes/_metadata_.storagefunctiontype_map.md">
<a href="types/classes/_metadata_.storagefunctiontype_map.html">
<span>
hidden
@@ -1313,9 +1313,9 @@
</li>
<li class="chapter " data-level="4.73" data-path="types/classes/_metadata_.storagemetadata.html">
<li class="chapter " data-level="4.73" data-path="types/classes/_metadata_.storagemetadata.md">
<a href="types/classes/_metadata_.storagemetadata.html">
<span>
hidden
@@ -1993,7 +1993,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"GLOSSARY.md","mtime":"2018-12-07T11:31:10.042Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-07T11:34:45.610Z"},"basePath":".","book":{"language":""}});
gitbook.page.hasChanged({"page":{"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"GLOSSARY.md","mtime":"2018-12-08T14:32:44.438Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-08T14:36:23.372Z"},"basePath":".","book":{"language":""}});
});
</script>
</div>
docs/METHODS_EVENTS.html
+31 -31
View File
@@ -1122,9 +1122,9 @@
</li>
<li class="chapter " data-level="4.58" data-path="types/classes/_metadata_.callmetadata.html">
<li class="chapter " data-level="4.58" data-path="types/classes/_metadata_.callmetadata.md">
<a href="types/classes/_metadata_.callmetadata.html">
<span>
hidden
@@ -1135,9 +1135,9 @@
</li>
<li class="chapter " data-level="4.59" data-path="types/classes/_metadata_.eventmetadata.html">
<li class="chapter " data-level="4.59" data-path="types/classes/_metadata_.eventmetadata.md">
<a href="types/classes/_metadata_.eventmetadata.html">
<span>
hidden
@@ -1148,9 +1148,9 @@
</li>
<li class="chapter " data-level="4.60" data-path="types/classes/_metadata_.functionargumentmetadata.html">
<li class="chapter " data-level="4.60" data-path="types/classes/_metadata_.functionargumentmetadata.md">
<a href="types/classes/_metadata_.functionargumentmetadata.html">
<span>
hidden
@@ -1161,9 +1161,9 @@
</li>
<li class="chapter " data-level="4.61" data-path="types/classes/_metadata_.functionmetadata.html">
<li class="chapter " data-level="4.61" data-path="types/classes/_metadata_.functionmetadata.md">
<a href="types/classes/_metadata_.functionmetadata.html">
<span>
hidden
@@ -1174,9 +1174,9 @@
</li>
<li class="chapter " data-level="4.62" data-path="types/classes/_metadata_.modulemetadata.html">
<li class="chapter " data-level="4.62" data-path="types/classes/_metadata_.modulemetadata.md">
<a href="types/classes/_metadata_.modulemetadata.html">
<span>
hidden
@@ -1187,9 +1187,9 @@
</li>
<li class="chapter " data-level="4.63" data-path="types/classes/_metadata_.outerdispatchcall.html">
<li class="chapter " data-level="4.63" data-path="types/classes/_metadata_.outerdispatchcall.md">
<a href="types/classes/_metadata_.outerdispatchcall.html">
<span>
hidden
@@ -1200,9 +1200,9 @@
</li>
<li class="chapter " data-level="4.64" data-path="types/classes/_metadata_.outerdispatchmetadata.html">
<li class="chapter " data-level="4.64" data-path="types/classes/_metadata_.outerdispatchmetadata.md">
<a href="types/classes/_metadata_.outerdispatchmetadata.html">
<span>
hidden
@@ -1213,9 +1213,9 @@
</li>
<li class="chapter " data-level="4.65" data-path="types/classes/_metadata_.outereventmetadata.html">
<li class="chapter " data-level="4.65" data-path="types/classes/_metadata_.outereventmetadata.md">
<a href="types/classes/_metadata_.outereventmetadata.html">
<span>
hidden
@@ -1226,9 +1226,9 @@
</li>
<li class="chapter " data-level="4.66" data-path="types/classes/_metadata_.outereventmetadataevent.html">
<li class="chapter " data-level="4.66" data-path="types/classes/_metadata_.outereventmetadataevent.md">
<a href="types/classes/_metadata_.outereventmetadataevent.html">
<span>
hidden
@@ -1252,9 +1252,9 @@
</li>
<li class="chapter " data-level="4.68" data-path="types/classes/_metadata_.runtimemodulemetadata.html">
<li class="chapter " data-level="4.68" data-path="types/classes/_metadata_.runtimemodulemetadata.md">
<a href="types/classes/_metadata_.runtimemodulemetadata.html">
<span>
hidden
@@ -1265,9 +1265,9 @@
</li>
<li class="chapter " data-level="4.69" data-path="types/classes/_metadata_.storagefunctionmetadata.html">
<li class="chapter " data-level="4.69" data-path="types/classes/_metadata_.storagefunctionmetadata.md">
<a href="types/classes/_metadata_.storagefunctionmetadata.html">
<span>
hidden
@@ -1278,9 +1278,9 @@
</li>
<li class="chapter " data-level="4.70" data-path="types/classes/_metadata_.storagefunctionmodifier.html">
<li class="chapter " data-level="4.70" data-path="types/classes/_metadata_.storagefunctionmodifier.md">
<a href="types/classes/_metadata_.storagefunctionmodifier.html">
<span>
hidden
@@ -1291,9 +1291,9 @@
</li>
<li class="chapter " data-level="4.71" data-path="types/classes/_metadata_.storagefunctiontype.html">
<li class="chapter " data-level="4.71" data-path="types/classes/_metadata_.storagefunctiontype.md">
<a href="types/classes/_metadata_.storagefunctiontype.html">
<span>
hidden
@@ -1304,9 +1304,9 @@
</li>
<li class="chapter " data-level="4.72" data-path="types/classes/_metadata_.storagefunctiontype_map.html">
<li class="chapter " data-level="4.72" data-path="types/classes/_metadata_.storagefunctiontype_map.md">
<a href="types/classes/_metadata_.storagefunctiontype_map.html">
<span>
hidden
@@ -1317,9 +1317,9 @@
</li>
<li class="chapter " data-level="4.73" data-path="types/classes/_metadata_.storagemetadata.html">
<li class="chapter " data-level="4.73" data-path="types/classes/_metadata_.storagemetadata.md">
<a href="types/classes/_metadata_.storagemetadata.html">
<span>
hidden
@@ -2167,7 +2167,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Events (runtime)","level":"2.4","depth":1,"next":{"title":"ApiPromise","level":"3.1","depth":1,"path":"examples/promise/README.md","ref":"examples/promise/README.md","articles":[{"title":"Simple connect","level":"3.1.1","depth":2,"path":"examples/promise/01_simple_connect/README.md","ref":"examples/promise/01_simple_connect/README.md","articles":[]},{"title":"Listen to blocks","level":"3.1.2","depth":2,"path":"examples/promise/02_listen_to_blocks/README.md","ref":"examples/promise/02_listen_to_blocks/README.md","articles":[]},{"title":"Listen to balance change","level":"3.1.3","depth":2,"path":"examples/promise/03_listen_to_balance_change/README.md","ref":"examples/promise/03_listen_to_balance_change/README.md","articles":[]},{"title":"Read chain state","level":"3.1.4","depth":2,"path":"examples/promise/05_read_storage/README.md","ref":"examples/promise/05_read_storage/README.md","articles":[]},{"title":"Make a transfer","level":"3.1.5","depth":2,"path":"examples/promise/07_transfer_dots/README.md","ref":"examples/promise/07_transfer_dots/README.md","articles":[]},{"title":"Display system events","level":"3.1.6","depth":2,"path":"examples/promise/08_system_events/README.md","ref":"examples/promise/08_system_events/README.md","articles":[]}]},"previous":{"title":"Extrinsics (runtime)","level":"2.3","depth":1,"path":"METHODS_EXTRINSICS.md","ref":"METHODS_EXTRINSICS.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"METHODS_EVENTS.md","mtime":"2018-12-07T11:33:09.211Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-07T11:34:45.610Z"},"basePath":".","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"Events (runtime)","level":"2.4","depth":1,"next":{"title":"ApiPromise","level":"3.1","depth":1,"path":"examples/promise/README.md","ref":"examples/promise/README.md","articles":[{"title":"Simple connect","level":"3.1.1","depth":2,"path":"examples/promise/01_simple_connect/README.md","ref":"examples/promise/01_simple_connect/README.md","articles":[]},{"title":"Listen to blocks","level":"3.1.2","depth":2,"path":"examples/promise/02_listen_to_blocks/README.md","ref":"examples/promise/02_listen_to_blocks/README.md","articles":[]},{"title":"Listen to balance change","level":"3.1.3","depth":2,"path":"examples/promise/03_listen_to_balance_change/README.md","ref":"examples/promise/03_listen_to_balance_change/README.md","articles":[]},{"title":"Read chain state","level":"3.1.4","depth":2,"path":"examples/promise/05_read_storage/README.md","ref":"examples/promise/05_read_storage/README.md","articles":[]},{"title":"Make a transfer","level":"3.1.5","depth":2,"path":"examples/promise/07_transfer_dots/README.md","ref":"examples/promise/07_transfer_dots/README.md","articles":[]},{"title":"Display system events","level":"3.1.6","depth":2,"path":"examples/promise/08_system_events/README.md","ref":"examples/promise/08_system_events/README.md","articles":[]}]},"previous":{"title":"Extrinsics (runtime)","level":"2.3","depth":1,"path":"METHODS_EXTRINSICS.md","ref":"METHODS_EXTRINSICS.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"METHODS_EVENTS.md","mtime":"2018-12-08T14:34:45.887Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-08T14:36:23.372Z"},"basePath":".","book":{"language":""}});
});
</script>
</div>
docs/METHODS_EXTRINSICS.html
+31 -31
View File
@@ -1122,9 +1122,9 @@
</li>
<li class="chapter " data-level="4.58" data-path="types/classes/_metadata_.callmetadata.html">
<li class="chapter " data-level="4.58" data-path="types/classes/_metadata_.callmetadata.md">
<a href="types/classes/_metadata_.callmetadata.html">
<span>
hidden
@@ -1135,9 +1135,9 @@
</li>
<li class="chapter " data-level="4.59" data-path="types/classes/_metadata_.eventmetadata.html">
<li class="chapter " data-level="4.59" data-path="types/classes/_metadata_.eventmetadata.md">
<a href="types/classes/_metadata_.eventmetadata.html">
<span>
hidden
@@ -1148,9 +1148,9 @@
</li>
<li class="chapter " data-level="4.60" data-path="types/classes/_metadata_.functionargumentmetadata.html">
<li class="chapter " data-level="4.60" data-path="types/classes/_metadata_.functionargumentmetadata.md">
<a href="types/classes/_metadata_.functionargumentmetadata.html">
<span>
hidden
@@ -1161,9 +1161,9 @@
</li>
<li class="chapter " data-level="4.61" data-path="types/classes/_metadata_.functionmetadata.html">
<li class="chapter " data-level="4.61" data-path="types/classes/_metadata_.functionmetadata.md">
<a href="types/classes/_metadata_.functionmetadata.html">
<span>
hidden
@@ -1174,9 +1174,9 @@
</li>
<li class="chapter " data-level="4.62" data-path="types/classes/_metadata_.modulemetadata.html">
<li class="chapter " data-level="4.62" data-path="types/classes/_metadata_.modulemetadata.md">
<a href="types/classes/_metadata_.modulemetadata.html">
<span>
hidden
@@ -1187,9 +1187,9 @@
</li>
<li class="chapter " data-level="4.63" data-path="types/classes/_metadata_.outerdispatchcall.html">
<li class="chapter " data-level="4.63" data-path="types/classes/_metadata_.outerdispatchcall.md">
<a href="types/classes/_metadata_.outerdispatchcall.html">
<span>
hidden
@@ -1200,9 +1200,9 @@
</li>
<li class="chapter " data-level="4.64" data-path="types/classes/_metadata_.outerdispatchmetadata.html">
<li class="chapter " data-level="4.64" data-path="types/classes/_metadata_.outerdispatchmetadata.md">
<a href="types/classes/_metadata_.outerdispatchmetadata.html">
<span>
hidden
@@ -1213,9 +1213,9 @@
</li>
<li class="chapter " data-level="4.65" data-path="types/classes/_metadata_.outereventmetadata.html">
<li class="chapter " data-level="4.65" data-path="types/classes/_metadata_.outereventmetadata.md">
<a href="types/classes/_metadata_.outereventmetadata.html">
<span>
hidden
@@ -1226,9 +1226,9 @@
</li>
<li class="chapter " data-level="4.66" data-path="types/classes/_metadata_.outereventmetadataevent.html">
<li class="chapter " data-level="4.66" data-path="types/classes/_metadata_.outereventmetadataevent.md">
<a href="types/classes/_metadata_.outereventmetadataevent.html">
<span>
hidden
@@ -1252,9 +1252,9 @@
</li>
<li class="chapter " data-level="4.68" data-path="types/classes/_metadata_.runtimemodulemetadata.html">
<li class="chapter " data-level="4.68" data-path="types/classes/_metadata_.runtimemodulemetadata.md">
<a href="types/classes/_metadata_.runtimemodulemetadata.html">
<span>
hidden
@@ -1265,9 +1265,9 @@
</li>
<li class="chapter " data-level="4.69" data-path="types/classes/_metadata_.storagefunctionmetadata.html">
<li class="chapter " data-level="4.69" data-path="types/classes/_metadata_.storagefunctionmetadata.md">
<a href="types/classes/_metadata_.storagefunctionmetadata.html">
<span>
hidden
@@ -1278,9 +1278,9 @@
</li>
<li class="chapter " data-level="4.70" data-path="types/classes/_metadata_.storagefunctionmodifier.html">
<li class="chapter " data-level="4.70" data-path="types/classes/_metadata_.storagefunctionmodifier.md">
<a href="types/classes/_metadata_.storagefunctionmodifier.html">
<span>
hidden
@@ -1291,9 +1291,9 @@
</li>
<li class="chapter " data-level="4.71" data-path="types/classes/_metadata_.storagefunctiontype.html">
<li class="chapter " data-level="4.71" data-path="types/classes/_metadata_.storagefunctiontype.md">
<a href="types/classes/_metadata_.storagefunctiontype.html">
<span>
hidden
@@ -1304,9 +1304,9 @@
</li>
<li class="chapter " data-level="4.72" data-path="types/classes/_metadata_.storagefunctiontype_map.html">
<li class="chapter " data-level="4.72" data-path="types/classes/_metadata_.storagefunctiontype_map.md">
<a href="types/classes/_metadata_.storagefunctiontype_map.html">
<span>
hidden
@@ -1317,9 +1317,9 @@
</li>
<li class="chapter " data-level="4.73" data-path="types/classes/_metadata_.storagemetadata.html">
<li class="chapter " data-level="4.73" data-path="types/classes/_metadata_.storagemetadata.md">
<a href="types/classes/_metadata_.storagemetadata.html">
<span>
hidden
@@ -2113,7 +2113,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Extrinsics (runtime)","level":"2.3","depth":1,"next":{"title":"Events (runtime)","level":"2.4","depth":1,"path":"METHODS_EVENTS.md","ref":"METHODS_EVENTS.md","articles":[]},"previous":{"title":"Chain state (runtime)","level":"2.2","depth":1,"path":"METHODS_STORAGE.md","ref":"METHODS_STORAGE.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"METHODS_EXTRINSICS.md","mtime":"2018-12-07T11:33:09.211Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-07T11:34:45.610Z"},"basePath":".","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"Extrinsics (runtime)","level":"2.3","depth":1,"next":{"title":"Events (runtime)","level":"2.4","depth":1,"path":"METHODS_EVENTS.md","ref":"METHODS_EVENTS.md","articles":[]},"previous":{"title":"Chain state (runtime)","level":"2.2","depth":1,"path":"METHODS_STORAGE.md","ref":"METHODS_STORAGE.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"METHODS_EXTRINSICS.md","mtime":"2018-12-08T14:34:45.887Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-08T14:36:23.372Z"},"basePath":".","book":{"language":""}});
});
</script>
</div>
docs/METHODS_RPC.html
+31 -31
View File
@@ -1122,9 +1122,9 @@
</li>
<li class="chapter " data-level="4.58" data-path="types/classes/_metadata_.callmetadata.html">
<li class="chapter " data-level="4.58" data-path="types/classes/_metadata_.callmetadata.md">
<a href="types/classes/_metadata_.callmetadata.html">
<span>
hidden
@@ -1135,9 +1135,9 @@
</li>
<li class="chapter " data-level="4.59" data-path="types/classes/_metadata_.eventmetadata.html">
<li class="chapter " data-level="4.59" data-path="types/classes/_metadata_.eventmetadata.md">
<a href="types/classes/_metadata_.eventmetadata.html">
<span>
hidden
@@ -1148,9 +1148,9 @@
</li>
<li class="chapter " data-level="4.60" data-path="types/classes/_metadata_.functionargumentmetadata.html">
<li class="chapter " data-level="4.60" data-path="types/classes/_metadata_.functionargumentmetadata.md">
<a href="types/classes/_metadata_.functionargumentmetadata.html">
<span>
hidden
@@ -1161,9 +1161,9 @@
</li>
<li class="chapter " data-level="4.61" data-path="types/classes/_metadata_.functionmetadata.html">
<li class="chapter " data-level="4.61" data-path="types/classes/_metadata_.functionmetadata.md">
<a href="types/classes/_metadata_.functionmetadata.html">
<span>
hidden
@@ -1174,9 +1174,9 @@
</li>
<li class="chapter " data-level="4.62" data-path="types/classes/_metadata_.modulemetadata.html">
<li class="chapter " data-level="4.62" data-path="types/classes/_metadata_.modulemetadata.md">
<a href="types/classes/_metadata_.modulemetadata.html">
<span>
hidden
@@ -1187,9 +1187,9 @@
</li>
<li class="chapter " data-level="4.63" data-path="types/classes/_metadata_.outerdispatchcall.html">
<li class="chapter " data-level="4.63" data-path="types/classes/_metadata_.outerdispatchcall.md">
<a href="types/classes/_metadata_.outerdispatchcall.html">
<span>
hidden
@@ -1200,9 +1200,9 @@
</li>
<li class="chapter " data-level="4.64" data-path="types/classes/_metadata_.outerdispatchmetadata.html">
<li class="chapter " data-level="4.64" data-path="types/classes/_metadata_.outerdispatchmetadata.md">
<a href="types/classes/_metadata_.outerdispatchmetadata.html">
<span>
hidden
@@ -1213,9 +1213,9 @@
</li>
<li class="chapter " data-level="4.65" data-path="types/classes/_metadata_.outereventmetadata.html">
<li class="chapter " data-level="4.65" data-path="types/classes/_metadata_.outereventmetadata.md">
<a href="types/classes/_metadata_.outereventmetadata.html">
<span>
hidden
@@ -1226,9 +1226,9 @@
</li>
<li class="chapter " data-level="4.66" data-path="types/classes/_metadata_.outereventmetadataevent.html">
<li class="chapter " data-level="4.66" data-path="types/classes/_metadata_.outereventmetadataevent.md">
<a href="types/classes/_metadata_.outereventmetadataevent.html">
<span>
hidden
@@ -1252,9 +1252,9 @@
</li>
<li class="chapter " data-level="4.68" data-path="types/classes/_metadata_.runtimemodulemetadata.html">
<li class="chapter " data-level="4.68" data-path="types/classes/_metadata_.runtimemodulemetadata.md">
<a href="types/classes/_metadata_.runtimemodulemetadata.html">
<span>
hidden
@@ -1265,9 +1265,9 @@
</li>
<li class="chapter " data-level="4.69" data-path="types/classes/_metadata_.storagefunctionmetadata.html">
<li class="chapter " data-level="4.69" data-path="types/classes/_metadata_.storagefunctionmetadata.md">
<a href="types/classes/_metadata_.storagefunctionmetadata.html">
<span>
hidden
@@ -1278,9 +1278,9 @@
</li>
<li class="chapter " data-level="4.70" data-path="types/classes/_metadata_.storagefunctionmodifier.html">
<li class="chapter " data-level="4.70" data-path="types/classes/_metadata_.storagefunctionmodifier.md">
<a href="types/classes/_metadata_.storagefunctionmodifier.html">
<span>
hidden
@@ -1291,9 +1291,9 @@
</li>
<li class="chapter " data-level="4.71" data-path="types/classes/_metadata_.storagefunctiontype.html">
<li class="chapter " data-level="4.71" data-path="types/classes/_metadata_.storagefunctiontype.md">
<a href="types/classes/_metadata_.storagefunctiontype.html">
<span>
hidden
@@ -1304,9 +1304,9 @@
</li>
<li class="chapter " data-level="4.72" data-path="types/classes/_metadata_.storagefunctiontype_map.html">
<li class="chapter " data-level="4.72" data-path="types/classes/_metadata_.storagefunctiontype_map.md">
<a href="types/classes/_metadata_.storagefunctiontype_map.html">
<span>
hidden
@@ -1317,9 +1317,9 @@
</li>
<li class="chapter " data-level="4.73" data-path="types/classes/_metadata_.storagemetadata.html">
<li class="chapter " data-level="4.73" data-path="types/classes/_metadata_.storagemetadata.md">
<a href="types/classes/_metadata_.storagemetadata.html">
<span>
hidden
@@ -2119,7 +2119,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"RPC","level":"2.1","depth":1,"next":{"title":"Chain state (runtime)","level":"2.2","depth":1,"path":"METHODS_STORAGE.md","ref":"METHODS_STORAGE.md","articles":[]},"previous":{"title":"types (codec implementation)","level":"1.4","depth":1,"path":"types/README.md","ref":"types/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"METHODS_RPC.md","mtime":"2018-12-07T11:33:09.211Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-07T11:34:45.610Z"},"basePath":".","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"RPC","level":"2.1","depth":1,"next":{"title":"Chain state (runtime)","level":"2.2","depth":1,"path":"METHODS_STORAGE.md","ref":"METHODS_STORAGE.md","articles":[]},"previous":{"title":"types (codec implementation)","level":"1.4","depth":1,"path":"types/README.md","ref":"types/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"METHODS_RPC.md","mtime":"2018-12-08T14:34:45.887Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-08T14:36:23.372Z"},"basePath":".","book":{"language":""}});
});
</script>
</div>
docs/METHODS_STORAGE.html
+31 -31
View File
@@ -1122,9 +1122,9 @@
</li>
<li class="chapter " data-level="4.58" data-path="types/classes/_metadata_.callmetadata.html">
<li class="chapter " data-level="4.58" data-path="types/classes/_metadata_.callmetadata.md">
<a href="types/classes/_metadata_.callmetadata.html">
<span>
hidden
@@ -1135,9 +1135,9 @@
</li>
<li class="chapter " data-level="4.59" data-path="types/classes/_metadata_.eventmetadata.html">
<li class="chapter " data-level="4.59" data-path="types/classes/_metadata_.eventmetadata.md">
<a href="types/classes/_metadata_.eventmetadata.html">
<span>
hidden
@@ -1148,9 +1148,9 @@
</li>
<li class="chapter " data-level="4.60" data-path="types/classes/_metadata_.functionargumentmetadata.html">
<li class="chapter " data-level="4.60" data-path="types/classes/_metadata_.functionargumentmetadata.md">
<a href="types/classes/_metadata_.functionargumentmetadata.html">
<span>
hidden
@@ -1161,9 +1161,9 @@
</li>
<li class="chapter " data-level="4.61" data-path="types/classes/_metadata_.functionmetadata.html">
<li class="chapter " data-level="4.61" data-path="types/classes/_metadata_.functionmetadata.md">
<a href="types/classes/_metadata_.functionmetadata.html">
<span>
hidden
@@ -1174,9 +1174,9 @@
</li>
<li class="chapter " data-level="4.62" data-path="types/classes/_metadata_.modulemetadata.html">
<li class="chapter " data-level="4.62" data-path="types/classes/_metadata_.modulemetadata.md">
<a href="types/classes/_metadata_.modulemetadata.html">
<span>
hidden
@@ -1187,9 +1187,9 @@
</li>
<li class="chapter " data-level="4.63" data-path="types/classes/_metadata_.outerdispatchcall.html">
<li class="chapter " data-level="4.63" data-path="types/classes/_metadata_.outerdispatchcall.md">
<a href="types/classes/_metadata_.outerdispatchcall.html">
<span>
hidden
@@ -1200,9 +1200,9 @@
</li>
<li class="chapter " data-level="4.64" data-path="types/classes/_metadata_.outerdispatchmetadata.html">
<li class="chapter " data-level="4.64" data-path="types/classes/_metadata_.outerdispatchmetadata.md">
<a href="types/classes/_metadata_.outerdispatchmetadata.html">
<span>
hidden
@@ -1213,9 +1213,9 @@
</li>
<li class="chapter " data-level="4.65" data-path="types/classes/_metadata_.outereventmetadata.html">
<li class="chapter " data-level="4.65" data-path="types/classes/_metadata_.outereventmetadata.md">
<a href="types/classes/_metadata_.outereventmetadata.html">
<span>
hidden
@@ -1226,9 +1226,9 @@
</li>
<li class="chapter " data-level="4.66" data-path="types/classes/_metadata_.outereventmetadataevent.html">
<li class="chapter " data-level="4.66" data-path="types/classes/_metadata_.outereventmetadataevent.md">
<a href="types/classes/_metadata_.outereventmetadataevent.html">
<span>
hidden
@@ -1252,9 +1252,9 @@
</li>
<li class="chapter " data-level="4.68" data-path="types/classes/_metadata_.runtimemodulemetadata.html">
<li class="chapter " data-level="4.68" data-path="types/classes/_metadata_.runtimemodulemetadata.md">
<a href="types/classes/_metadata_.runtimemodulemetadata.html">
<span>
hidden
@@ -1265,9 +1265,9 @@
</li>
<li class="chapter " data-level="4.69" data-path="types/classes/_metadata_.storagefunctionmetadata.html">
<li class="chapter " data-level="4.69" data-path="types/classes/_metadata_.storagefunctionmetadata.md">
<a href="types/classes/_metadata_.storagefunctionmetadata.html">
<span>
hidden
@@ -1278,9 +1278,9 @@
</li>
<li class="chapter " data-level="4.70" data-path="types/classes/_metadata_.storagefunctionmodifier.html">
<li class="chapter " data-level="4.70" data-path="types/classes/_metadata_.storagefunctionmodifier.md">
<a href="types/classes/_metadata_.storagefunctionmodifier.html">
<span>
hidden
@@ -1291,9 +1291,9 @@
</li>
<li class="chapter " data-level="4.71" data-path="types/classes/_metadata_.storagefunctiontype.html">
<li class="chapter " data-level="4.71" data-path="types/classes/_metadata_.storagefunctiontype.md">
<a href="types/classes/_metadata_.storagefunctiontype.html">
<span>
hidden
@@ -1304,9 +1304,9 @@
</li>
<li class="chapter " data-level="4.72" data-path="types/classes/_metadata_.storagefunctiontype_map.html">
<li class="chapter " data-level="4.72" data-path="types/classes/_metadata_.storagefunctiontype_map.md">
<a href="types/classes/_metadata_.storagefunctiontype_map.html">
<span>
hidden
@@ -1317,9 +1317,9 @@
</li>
<li class="chapter " data-level="4.73" data-path="types/classes/_metadata_.storagemetadata.html">
<li class="chapter " data-level="4.73" data-path="types/classes/_metadata_.storagemetadata.md">
<a href="types/classes/_metadata_.storagemetadata.html">
<span>
hidden
@@ -2454,7 +2454,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Chain state (runtime)","level":"2.2","depth":1,"next":{"title":"Extrinsics (runtime)","level":"2.3","depth":1,"path":"METHODS_EXTRINSICS.md","ref":"METHODS_EXTRINSICS.md","articles":[]},"previous":{"title":"RPC","level":"2.1","depth":1,"path":"METHODS_RPC.md","ref":"METHODS_RPC.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"METHODS_STORAGE.md","mtime":"2018-12-07T11:33:09.251Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-07T11:34:45.610Z"},"basePath":".","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"Chain state (runtime)","level":"2.2","depth":1,"next":{"title":"Extrinsics (runtime)","level":"2.3","depth":1,"path":"METHODS_EXTRINSICS.md","ref":"METHODS_EXTRINSICS.md","articles":[]},"previous":{"title":"RPC","level":"2.1","depth":1,"path":"METHODS_RPC.md","ref":"METHODS_RPC.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"METHODS_STORAGE.md","mtime":"2018-12-08T14:34:45.935Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-08T14:36:23.372Z"},"basePath":".","book":{"language":""}});
});
</script>
</div>
docs/api-observable/classes/_base_.apibase.md
+9 -9
View File
@@ -14,7 +14,7 @@
⊕ **new ApiBase**(api: *`RpcRxInterface`*): [ApiBase](_base_.apibase.md)
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Base.ts#L33)*
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Base.ts#L33)*
**Parameters:**
@@ -34,7 +34,7 @@ ___
**● whenReady**: *`Observable`<`boolean`>*
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Base.ts#L33)*
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Base.ts#L33)*
___
<a id="extrinsics"></a>
@@ -43,7 +43,7 @@ ___
**● extrinsics**: *`Extrinsics`* = extrinsicsStatic
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Base.ts#L41)*
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Base.ts#L41)*
___
<a id="storage"></a>
@@ -52,7 +52,7 @@ ___
**● storage**: *`Storage`* = storageStatic
*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Base.ts#L42)*
*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Base.ts#L42)*
___
@@ -64,7 +64,7 @@ ___
getgenesisHash(): `Hash`
*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Base.ts#L87)*
*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Base.ts#L87)*
**Returns:** `Hash`
@@ -78,7 +78,7 @@ ___
▸ **isConnected**(): `Observable`<`boolean`>
*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Base.ts#L91)*
*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Base.ts#L91)*
**Returns:** `Observable`<`boolean`>
@@ -89,7 +89,7 @@ ___
▸ **rawCall**<`T`>(__namedParameters: *`object`*, ...params: *`Array`<`any`>*): `Observable`<`T`>
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Base.ts#L95)*
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Base.ts#L95)*
**Type parameters:**
@@ -110,7 +110,7 @@ ___
▸ **rawStorage**<`T`>(key: * `Uint8Array` &#124; `StorageFunction`*, ...params: *`Array`<`any`>*): `Observable`< `T` &#124; `undefined`>
*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Base.ts#L108)*
*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Base.ts#L108)*
**Type parameters:**
@@ -131,7 +131,7 @@ ___
▸ **rawStorageMulti**<`T`>(...keys: *`Array`< `Uint8Array` &#124; [`StorageFunction`] &#124; [`StorageFunction`, `any`]>*): `Observable`<`T`>
*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Base.ts#L123)*
*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Base.ts#L123)*
**Type parameters:**
docs/api-observable/classes/_calls_.apicalls.md
+48 -48
View File
@@ -18,7 +18,7 @@
*Inherited from [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Base.ts#L33)*
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Base.ts#L33)*
**Parameters:**
@@ -40,7 +40,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[whenReady](_base_.apibase.md#whenready)*
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Base.ts#L33)*
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Base.ts#L33)*
___
<a id="extrinsics"></a>
@@ -51,7 +51,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[extrinsics](_base_.apibase.md#extrinsics)*
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Base.ts#L41)*
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Base.ts#L41)*
___
<a id="storage"></a>
@@ -62,7 +62,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[storage](_base_.apibase.md#storage)*
*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Base.ts#L42)*
*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Base.ts#L42)*
___
@@ -76,7 +76,7 @@ getgenesisHash(): `Hash`
*Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)*
*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Base.ts#L87)*
*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Base.ts#L87)*
**Returns:** `Hash`
@@ -92,7 +92,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[accountNonce](_queries_.apiqueries.md#accountnonce)*
*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L19)*
*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L19)*
**Parameters:**
@@ -111,7 +111,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceFree](_queries_.apiqueries.md#balancefree)*
*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L23)*
*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L23)*
**Parameters:**
@@ -130,7 +130,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceReserved](_queries_.apiqueries.md#balancereserved)*
*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L27)*
*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L27)*
**Parameters:**
@@ -147,7 +147,7 @@ ___
▸ **bestNumber**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Calls.ts#L13)*
*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Calls.ts#L13)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -160,7 +160,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[blockNow](_queries_.apiqueries.md#blocknow)*
*Defined in [Queries.ts:35](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L35)*
*Defined in [Queries.ts:35](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L35)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -173,7 +173,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[blockPeriod](_queries_.apiqueries.md#blockperiod)*
*Defined in [Queries.ts:31](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L31)*
*Defined in [Queries.ts:31](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L31)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -184,7 +184,7 @@ ___
▸ **chain**(): `Observable`< `Text` &#124; `undefined`>
*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Calls.ts#L25)*
*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Calls.ts#L25)*
**Returns:** `Observable`< `Text` &#124; `undefined`>
@@ -197,7 +197,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyLaunchPeriod](_queries_.apiqueries.md#democracylaunchperiod)*
*Defined in [Queries.ts:39](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L39)*
*Defined in [Queries.ts:39](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L39)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -210,7 +210,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyNextTally](_queries_.apiqueries.md#democracynexttally)*
*Defined in [Queries.ts:43](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L43)*
*Defined in [Queries.ts:43](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L43)*
**Returns:** `Observable`< `ReferendumIndex` &#124; `undefined`>
@@ -223,7 +223,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyVotingPeriod](_queries_.apiqueries.md#democracyvotingperiod)*
*Defined in [Queries.ts:126](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L126)*
*Defined in [Queries.ts:126](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L126)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -236,7 +236,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[eraLastLengthChange](_queries_.apiqueries.md#eralastlengthchange)*
*Defined in [Queries.ts:151](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L151)*
*Defined in [Queries.ts:151](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L151)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -249,7 +249,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[fees](_queries_.apiqueries.md#fees)*
*Defined in [Queries.ts:130](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L130)*
*Defined in [Queries.ts:130](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L130)*
**Returns:** `Observable`<[RxFees](../modules/_types_.md#rxfees)>
@@ -262,7 +262,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[getAccountEnumSet](_queries_.apiqueries.md#getaccountenumset)*
*Defined in [Queries.ts:47](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L47)*
*Defined in [Queries.ts:47](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L47)*
**Parameters:**
@@ -279,7 +279,7 @@ ___
▸ **getBlock**(hash: *`Uint8Array`*): `Observable`< `SignedBlock` &#124; `undefined`>
*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Calls.ts#L29)*
*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Calls.ts#L29)*
**Parameters:**
@@ -298,7 +298,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[isConnected](_base_.apibase.md#isconnected)*
*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Base.ts#L91)*
*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Base.ts#L91)*
**Returns:** `Observable`<`boolean`>
@@ -311,7 +311,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[nextAccountEnumSet](_queries_.apiqueries.md#nextaccountenumset)*
*Defined in [Queries.ts:58](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L58)*
*Defined in [Queries.ts:58](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L58)*
**Returns:** `Observable`< `AccountIndex` &#124; `undefined`>
@@ -324,7 +324,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[proposalDeposits](_queries_.apiqueries.md#proposaldeposits)*
*Defined in [Queries.ts:62](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L62)*
*Defined in [Queries.ts:62](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L62)*
**Parameters:**
@@ -343,7 +343,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[publicProposals](_queries_.apiqueries.md#publicproposals)*
*Defined in [Queries.ts:75](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L75)*
*Defined in [Queries.ts:75](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L75)*
**Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>>
@@ -356,7 +356,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)*
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Base.ts#L95)*
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Base.ts#L95)*
**Type parameters:**
@@ -379,7 +379,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)*
*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Base.ts#L108)*
*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Base.ts#L108)*
**Type parameters:**
@@ -402,7 +402,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)*
*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Base.ts#L123)*
*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Base.ts#L123)*
**Type parameters:**
@@ -424,7 +424,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumCount](_queries_.apiqueries.md#referendumcount)*
*Defined in [Queries.ts:94](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L94)*
*Defined in [Queries.ts:94](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L94)*
**Returns:** `Observable`< `ReferendumIndex` &#124; `undefined`>
@@ -437,7 +437,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumInfo](_queries_.apiqueries.md#referenduminfo)*
*Defined in [Queries.ts:98](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L98)*
*Defined in [Queries.ts:98](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L98)*
**Parameters:**
@@ -456,7 +456,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVote](_queries_.apiqueries.md#referendumvote)*
*Defined in [Queries.ts:111](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L111)*
*Defined in [Queries.ts:111](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L111)*
**Parameters:**
@@ -476,7 +476,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVoters](_queries_.apiqueries.md#referendumvoters)*
*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L115)*
*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L115)*
**Parameters:**
@@ -495,7 +495,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentIndex](_queries_.apiqueries.md#sessioncurrentindex)*
*Defined in [Queries.ts:163](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L163)*
*Defined in [Queries.ts:163](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L163)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -508,7 +508,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentStart](_queries_.apiqueries.md#sessioncurrentstart)*
*Defined in [Queries.ts:167](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L167)*
*Defined in [Queries.ts:167](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L167)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -521,7 +521,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLastLengthChange](_queries_.apiqueries.md#sessionlastlengthchange)*
*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L171)*
*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L171)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -534,7 +534,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLength](_queries_.apiqueries.md#sessionlength)*
*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L175)*
*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L175)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -547,7 +547,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionReward](_queries_.apiqueries.md#sessionreward)*
*Defined in [Queries.ts:155](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L155)*
*Defined in [Queries.ts:155](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L155)*
**Returns:** `Observable`< `Perbill` &#124; `undefined`>
@@ -560,7 +560,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionRewardCurrent](_queries_.apiqueries.md#sessionrewardcurrent)*
*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L159)*
*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L159)*
**Returns:** `Observable`< `Balance` &#124; `undefined`>
@@ -573,7 +573,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionValidators](_queries_.apiqueries.md#sessionvalidators)*
*Defined in [Queries.ts:183](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L183)*
*Defined in [Queries.ts:183](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L183)*
**Returns:** `Observable`<`Array`<`AccountId`>>
@@ -586,7 +586,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionsPerEra](_queries_.apiqueries.md#sessionsperera)*
*Defined in [Queries.ts:179](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L179)*
*Defined in [Queries.ts:179](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L179)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -599,7 +599,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingIntentions](_queries_.apiqueries.md#stakingintentions)*
*Defined in [Queries.ts:194](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L194)*
*Defined in [Queries.ts:194](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L194)*
**Returns:** `Observable`<`Array`<`AccountId`>>
@@ -612,7 +612,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominating](_queries_.apiqueries.md#stakingnominating)*
*Defined in [Queries.ts:216](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L216)*
*Defined in [Queries.ts:216](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L216)*
**Parameters:**
@@ -631,7 +631,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominatorsFor](_queries_.apiqueries.md#stakingnominatorsfor)*
*Defined in [Queries.ts:205](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L205)*
*Defined in [Queries.ts:205](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L205)*
**Parameters:**
@@ -648,7 +648,7 @@ ___
▸ **submitAndWatchExtrinsic**(extrinsic: *`Extrinsic`*): `Observable`< `ExtrinsicStatus` &#124; `undefined`>
*Defined in [Calls.ts:51](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Calls.ts#L51)*
*Defined in [Calls.ts:51](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Calls.ts#L51)*
**Parameters:**
@@ -665,7 +665,7 @@ ___
▸ **submitExtrinsic**(extrinsic: *`Extrinsic`*): `Observable`< `Hash` &#124; `undefined`>
*Defined in [Calls.ts:47](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Calls.ts#L47)*
*Defined in [Calls.ts:47](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Calls.ts#L47)*
**Parameters:**
@@ -682,7 +682,7 @@ ___
▸ **subscribeNewHead**(): `Observable`< `Header` &#124; `undefined`>
*Defined in [Calls.ts:33](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Calls.ts#L33)*
*Defined in [Calls.ts:33](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Calls.ts#L33)*
**Returns:** `Observable`< `Header` &#124; `undefined`>
@@ -695,7 +695,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[systemEvents](_queries_.apiqueries.md#systemevents)*
*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L220)*
*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L220)*
**Returns:** `Observable`<`Array`<`EventRecord`>>
@@ -706,7 +706,7 @@ ___
▸ **systemName**(): `Observable`< `Text` &#124; `undefined`>
*Defined in [Calls.ts:39](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Calls.ts#L39)*
*Defined in [Calls.ts:39](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Calls.ts#L39)*
**Returns:** `Observable`< `Text` &#124; `undefined`>
@@ -717,7 +717,7 @@ ___
▸ **systemVersion**(): `Observable`< `Text` &#124; `undefined`>
*Defined in [Calls.ts:43](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Calls.ts#L43)*
*Defined in [Calls.ts:43](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Calls.ts#L43)*
**Returns:** `Observable`< `Text` &#124; `undefined`>
@@ -730,7 +730,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[validatorCount](_queries_.apiqueries.md#validatorcount)*
*Defined in [Queries.ts:231](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L231)*
*Defined in [Queries.ts:231](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L231)*
**Returns:** `Observable`< `u32` &#124; `undefined`>
docs/api-observable/classes/_classes_.rxproposal.md
+14 -14
View File
@@ -25,7 +25,7 @@
*Overrides Struct.__constructor*
*Defined in [classes.ts:12](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/classes.ts#L12)*
*Defined in [classes.ts:12](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/classes.ts#L12)*
**Parameters:**
@@ -72,7 +72,7 @@ getType(): `E`
*Inherited from Struct.Type*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L133)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L127)*
*__description__*: Returns the Type description to sthe structure
@@ -85,7 +85,7 @@ ___
getaddress(): `AccountId`
*Defined in [classes.ts:21](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/classes.ts#L21)*
*Defined in [classes.ts:21](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/classes.ts#L21)*
**Returns:** `AccountId`
@@ -98,7 +98,7 @@ getencodedLength(): `number`
*Inherited from Struct.encodedLength*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L140)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:134](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L134)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -111,7 +111,7 @@ ___
getid(): `PropIndex`
*Defined in [classes.ts:25](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/classes.ts#L25)*
*Defined in [classes.ts:25](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/classes.ts#L25)*
**Returns:** `PropIndex`
@@ -122,7 +122,7 @@ ___
getproposal(): `Proposal`
*Defined in [classes.ts:29](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/classes.ts#L29)*
*Defined in [classes.ts:29](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/classes.ts#L29)*
**Returns:** `Proposal`
@@ -222,7 +222,7 @@ ___
*Overrides Map.get*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:150](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L150)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:144](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L144)*
*__description__*: Returns a specific names entry in the structure
@@ -243,7 +243,7 @@ ___
*Inherited from Struct.getAtIndex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:157](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L157)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:151](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L151)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
@@ -318,7 +318,7 @@ ___
*Inherited from Struct.toArray*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:164](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L164)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L158)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -333,7 +333,7 @@ ___
*Inherited from Struct.toHex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:171](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L171)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:165](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L165)*
*__description__*: Returns a hex string representation of the value
@@ -348,7 +348,7 @@ ___
*Inherited from Struct.toJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:178](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L178)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:172](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L172)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -363,7 +363,7 @@ ___
*Inherited from Struct.toString*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:192](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L192)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:186](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L186)*
*__description__*: Returns the string representation of the value
@@ -378,7 +378,7 @@ ___
*Inherited from Struct.toU8a*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:200](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L200)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L194)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -414,7 +414,7 @@ ___
*Inherited from Struct.with*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L113)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:107](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L107)*
**Type parameters:**
docs/api-observable/classes/_classes_.rxproposaldeposits.md
+13 -13
View File
@@ -25,7 +25,7 @@
*Overrides Struct.__constructor*
*Defined in [classes.ts:36](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/classes.ts#L36)*
*Defined in [classes.ts:36](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/classes.ts#L36)*
**Parameters:**
@@ -72,7 +72,7 @@ getType(): `E`
*Inherited from Struct.Type*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L133)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L127)*
*__description__*: Returns the Type description to sthe structure
@@ -85,7 +85,7 @@ ___
getaddresses(): `Vector`<`AccountId`>
*Defined in [classes.ts:44](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/classes.ts#L44)*
*Defined in [classes.ts:44](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/classes.ts#L44)*
**Returns:** `Vector`<`AccountId`>
@@ -96,7 +96,7 @@ ___
getbalance(): `Balance`
*Defined in [classes.ts:48](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/classes.ts#L48)*
*Defined in [classes.ts:48](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/classes.ts#L48)*
**Returns:** `Balance`
@@ -109,7 +109,7 @@ getencodedLength(): `number`
*Inherited from Struct.encodedLength*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L140)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:134](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L134)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -211,7 +211,7 @@ ___
*Overrides Map.get*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:150](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L150)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:144](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L144)*
*__description__*: Returns a specific names entry in the structure
@@ -232,7 +232,7 @@ ___
*Inherited from Struct.getAtIndex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:157](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L157)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:151](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L151)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
@@ -307,7 +307,7 @@ ___
*Inherited from Struct.toArray*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:164](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L164)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L158)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -322,7 +322,7 @@ ___
*Inherited from Struct.toHex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:171](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L171)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:165](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L165)*
*__description__*: Returns a hex string representation of the value
@@ -337,7 +337,7 @@ ___
*Inherited from Struct.toJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:178](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L178)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:172](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L172)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -352,7 +352,7 @@ ___
*Inherited from Struct.toString*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:192](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L192)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:186](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L186)*
*__description__*: Returns the string representation of the value
@@ -367,7 +367,7 @@ ___
*Inherited from Struct.toU8a*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:200](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L200)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L194)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -403,7 +403,7 @@ ___
*Inherited from Struct.with*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L113)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:107](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L107)*
**Type parameters:**
docs/api-observable/classes/_classes_.rxreferendum.md
+15 -15
View File
@@ -25,7 +25,7 @@
*Overrides Struct.__constructor*
*Defined in [classes.ts:55](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/classes.ts#L55)*
*Defined in [classes.ts:55](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/classes.ts#L55)*
**Parameters:**
@@ -73,7 +73,7 @@ getType(): `E`
*Inherited from Struct.Type*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L133)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L127)*
*__description__*: Returns the Type description to sthe structure
@@ -86,7 +86,7 @@ ___
getblockNumber(): `BlockNumber`
*Defined in [classes.ts:65](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/classes.ts#L65)*
*Defined in [classes.ts:65](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/classes.ts#L65)*
**Returns:** `BlockNumber`
@@ -99,7 +99,7 @@ getencodedLength(): `number`
*Inherited from Struct.encodedLength*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L140)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:134](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L134)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -112,7 +112,7 @@ ___
getid(): `ReferendumIndex`
*Defined in [classes.ts:69](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/classes.ts#L69)*
*Defined in [classes.ts:69](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/classes.ts#L69)*
**Returns:** `ReferendumIndex`
@@ -123,7 +123,7 @@ ___
getproposal(): `Proposal`
*Defined in [classes.ts:73](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/classes.ts#L73)*
*Defined in [classes.ts:73](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/classes.ts#L73)*
**Returns:** `Proposal`
@@ -134,7 +134,7 @@ ___
getvoteThreshold(): `VoteThreshold`
*Defined in [classes.ts:77](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/classes.ts#L77)*
*Defined in [classes.ts:77](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/classes.ts#L77)*
**Returns:** `VoteThreshold`
@@ -234,7 +234,7 @@ ___
*Overrides Map.get*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:150](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L150)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:144](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L144)*
*__description__*: Returns a specific names entry in the structure
@@ -255,7 +255,7 @@ ___
*Inherited from Struct.getAtIndex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:157](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L157)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:151](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L151)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
@@ -330,7 +330,7 @@ ___
*Inherited from Struct.toArray*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:164](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L164)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L158)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -345,7 +345,7 @@ ___
*Inherited from Struct.toHex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:171](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L171)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:165](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L165)*
*__description__*: Returns a hex string representation of the value
@@ -360,7 +360,7 @@ ___
*Inherited from Struct.toJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:178](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L178)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:172](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L172)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -375,7 +375,7 @@ ___
*Inherited from Struct.toString*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:192](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L192)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:186](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L186)*
*__description__*: Returns the string representation of the value
@@ -390,7 +390,7 @@ ___
*Inherited from Struct.toU8a*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:200](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L200)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L194)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -426,7 +426,7 @@ ___
*Inherited from Struct.with*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L113)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:107](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L107)*
**Type parameters:**
docs/api-observable/classes/_combined_.apicombined.md
+72 -72
View File
@@ -18,7 +18,7 @@
*Inherited from [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Base.ts#L33)*
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Base.ts#L33)*
**Parameters:**
@@ -40,7 +40,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[whenReady](_base_.apibase.md#whenready)*
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Base.ts#L33)*
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Base.ts#L33)*
___
<a id="extrinsics"></a>
@@ -51,7 +51,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[extrinsics](_base_.apibase.md#extrinsics)*
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Base.ts#L41)*
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Base.ts#L41)*
___
<a id="storage"></a>
@@ -62,7 +62,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[storage](_base_.apibase.md#storage)*
*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Base.ts#L42)*
*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Base.ts#L42)*
___
@@ -76,7 +76,7 @@ getgenesisHash(): `Hash`
*Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)*
*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Base.ts#L87)*
*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Base.ts#L87)*
**Returns:** `Hash`
@@ -90,7 +90,7 @@ ___
▸ **accountIdAndIndex**(address?: * `AccountId` &#124; `AccountIndex` &#124; `string` &#124; `null`*): `Observable`<[`AccountId` &#124; `undefined`, `AccountIndex` &#124; `undefined`]>
*Defined in [Combined.ts:79](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Combined.ts#L79)*
*Defined in [Combined.ts:79](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Combined.ts#L79)*
**Parameters:**
@@ -107,7 +107,7 @@ ___
▸ **accountIdFromIndex**(_accountIndex: * `AccountIndex` &#124; `string`*): `Observable`< `AccountId` &#124; `undefined`>
*Defined in [Combined.ts:53](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Combined.ts#L53)*
*Defined in [Combined.ts:53](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Combined.ts#L53)*
**Parameters:**
@@ -124,7 +124,7 @@ ___
▸ **accountIndexFromId**(accountId: * `AccountId` &#124; `string`*): `Observable`< `AccountIndex` &#124; `undefined`>
*Defined in [Combined.ts:68](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Combined.ts#L68)*
*Defined in [Combined.ts:68](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Combined.ts#L68)*
**Parameters:**
@@ -141,7 +141,7 @@ ___
▸ **accountIndexes**(): `Observable`<`object`>
*Defined in [Combined.ts:23](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Combined.ts#L23)*
*Defined in [Combined.ts:23](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Combined.ts#L23)*
**Returns:** `Observable`<`object`>
@@ -154,7 +154,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[accountNonce](_queries_.apiqueries.md#accountnonce)*
*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L19)*
*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L19)*
**Parameters:**
@@ -173,7 +173,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceFree](_queries_.apiqueries.md#balancefree)*
*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L23)*
*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L23)*
**Parameters:**
@@ -192,7 +192,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceReserved](_queries_.apiqueries.md#balancereserved)*
*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L27)*
*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L27)*
**Parameters:**
@@ -211,7 +211,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[bestNumber](_calls_.apicalls.md#bestnumber)*
*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Calls.ts#L13)*
*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Calls.ts#L13)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -224,7 +224,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[blockNow](_queries_.apiqueries.md#blocknow)*
*Defined in [Queries.ts:35](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L35)*
*Defined in [Queries.ts:35](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L35)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -237,7 +237,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[blockPeriod](_queries_.apiqueries.md#blockperiod)*
*Defined in [Queries.ts:31](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L31)*
*Defined in [Queries.ts:31](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L31)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -250,7 +250,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[chain](_calls_.apicalls.md#chain)*
*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Calls.ts#L25)*
*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Calls.ts#L25)*
**Returns:** `Observable`< `Text` &#124; `undefined`>
@@ -263,7 +263,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyLaunchPeriod](_queries_.apiqueries.md#democracylaunchperiod)*
*Defined in [Queries.ts:39](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L39)*
*Defined in [Queries.ts:39](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L39)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -276,7 +276,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyNextTally](_queries_.apiqueries.md#democracynexttally)*
*Defined in [Queries.ts:43](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L43)*
*Defined in [Queries.ts:43](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L43)*
**Returns:** `Observable`< `ReferendumIndex` &#124; `undefined`>
@@ -287,7 +287,7 @@ ___
▸ **democracyReferendumVoters**(referendumId: * `ReferendumIndex` &#124; `BN` &#124; `number`*): `Observable`<`Array`<[RxReferendumVote](../modules/_types_.md#rxreferendumvote)>>
*Defined in [Combined.ts:137](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Combined.ts#L137)*
*Defined in [Combined.ts:137](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Combined.ts#L137)*
**Parameters:**
@@ -304,7 +304,7 @@ ___
▸ **democracyVotersBalancesOf**(referendumId: * `ReferendumIndex` &#124; `BN` &#124; `number`*): `Observable`<`Array`<`Balance`>>
*Defined in [Combined.ts:182](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Combined.ts#L182)*
*Defined in [Combined.ts:182](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Combined.ts#L182)*
**Parameters:**
@@ -321,7 +321,7 @@ ___
▸ **democracyVotersVotesOf**(referendumId: * `ReferendumIndex` &#124; `BN` &#124; `number`*): `Observable`<`Array`<`Bool`>>
*Defined in [Combined.ts:198](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Combined.ts#L198)*
*Defined in [Combined.ts:198](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Combined.ts#L198)*
**Parameters:**
@@ -340,7 +340,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyVotingPeriod](_queries_.apiqueries.md#democracyvotingperiod)*
*Defined in [Queries.ts:126](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L126)*
*Defined in [Queries.ts:126](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L126)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -351,7 +351,7 @@ ___
▸ **eraBlockLength**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Combined.ts:209](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Combined.ts#L209)*
*Defined in [Combined.ts:209](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Combined.ts#L209)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -362,7 +362,7 @@ ___
▸ **eraBlockProgress**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Combined.ts:224](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Combined.ts#L224)*
*Defined in [Combined.ts:224](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Combined.ts#L224)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -373,7 +373,7 @@ ___
▸ **eraBlockRemaining**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Combined.ts:247](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Combined.ts#L247)*
*Defined in [Combined.ts:247](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Combined.ts#L247)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -386,7 +386,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[eraLastLengthChange](_queries_.apiqueries.md#eralastlengthchange)*
*Defined in [Queries.ts:151](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L151)*
*Defined in [Queries.ts:151](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L151)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -399,7 +399,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[fees](_queries_.apiqueries.md#fees)*
*Defined in [Queries.ts:130](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L130)*
*Defined in [Queries.ts:130](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L130)*
**Returns:** `Observable`<[RxFees](../modules/_types_.md#rxfees)>
@@ -412,7 +412,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[getAccountEnumSet](_queries_.apiqueries.md#getaccountenumset)*
*Defined in [Queries.ts:47](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L47)*
*Defined in [Queries.ts:47](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L47)*
**Parameters:**
@@ -431,7 +431,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[getBlock](_calls_.apicalls.md#getblock)*
*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Calls.ts#L29)*
*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Calls.ts#L29)*
**Parameters:**
@@ -450,7 +450,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[isConnected](_base_.apibase.md#isconnected)*
*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Base.ts#L91)*
*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Base.ts#L91)*
**Returns:** `Observable`<`boolean`>
@@ -463,7 +463,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[nextAccountEnumSet](_queries_.apiqueries.md#nextaccountenumset)*
*Defined in [Queries.ts:58](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L58)*
*Defined in [Queries.ts:58](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L58)*
**Returns:** `Observable`< `AccountIndex` &#124; `undefined`>
@@ -476,7 +476,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[proposalDeposits](_queries_.apiqueries.md#proposaldeposits)*
*Defined in [Queries.ts:62](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L62)*
*Defined in [Queries.ts:62](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L62)*
**Parameters:**
@@ -493,7 +493,7 @@ ___
▸ **publicProposalCount**(): `Observable`<`number`>
*Defined in [Combined.ts:115](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Combined.ts#L115)*
*Defined in [Combined.ts:115](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Combined.ts#L115)*
**Returns:** `Observable`<`number`>
@@ -506,7 +506,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[publicProposals](_queries_.apiqueries.md#publicproposals)*
*Defined in [Queries.ts:75](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L75)*
*Defined in [Queries.ts:75](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L75)*
**Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>>
@@ -519,7 +519,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)*
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Base.ts#L95)*
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Base.ts#L95)*
**Type parameters:**
@@ -542,7 +542,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)*
*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Base.ts#L108)*
*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Base.ts#L108)*
**Type parameters:**
@@ -565,7 +565,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)*
*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Base.ts#L123)*
*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Base.ts#L123)*
**Type parameters:**
@@ -587,7 +587,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumCount](_queries_.apiqueries.md#referendumcount)*
*Defined in [Queries.ts:94](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L94)*
*Defined in [Queries.ts:94](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L94)*
**Returns:** `Observable`< `ReferendumIndex` &#124; `undefined`>
@@ -600,7 +600,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumInfo](_queries_.apiqueries.md#referenduminfo)*
*Defined in [Queries.ts:98](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L98)*
*Defined in [Queries.ts:98](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L98)*
**Parameters:**
@@ -619,7 +619,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVote](_queries_.apiqueries.md#referendumvote)*
*Defined in [Queries.ts:111](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L111)*
*Defined in [Queries.ts:111](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L111)*
**Parameters:**
@@ -639,7 +639,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVoters](_queries_.apiqueries.md#referendumvoters)*
*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L115)*
*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L115)*
**Parameters:**
@@ -656,7 +656,7 @@ ___
▸ **referendumVotes**(index: * `ReferendumIndex` &#124; `BN` &#124; `number`*, addresses: *`Array`< `AccountId` &#124; `string`>*): `Observable`<`boolean`>
*Defined in [Combined.ts:174](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Combined.ts#L174)*
*Defined in [Combined.ts:174](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Combined.ts#L174)*
**Parameters:**
@@ -674,7 +674,7 @@ ___
▸ **referendums**(): `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>>
*Defined in [Combined.ts:153](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Combined.ts#L153)*
*Defined in [Combined.ts:153](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Combined.ts#L153)*
**Returns:** `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>>
@@ -685,7 +685,7 @@ ___
▸ **referendumsInfo**(referendumIds: *`Array`< `ReferendumIndex` &#124; `BN` &#124; `number`>*): `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>>
*Defined in [Combined.ts:125](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Combined.ts#L125)*
*Defined in [Combined.ts:125](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Combined.ts#L125)*
**Parameters:**
@@ -702,7 +702,7 @@ ___
▸ **sessionBlockProgress**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Combined.ts:262](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Combined.ts#L262)*
*Defined in [Combined.ts:262](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Combined.ts#L262)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -713,7 +713,7 @@ ___
▸ **sessionBlockRemaining**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Combined.ts:282](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Combined.ts#L282)*
*Defined in [Combined.ts:282](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Combined.ts#L282)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -724,7 +724,7 @@ ___
▸ **sessionBrokenValue**(): `Observable`< `Moment` &#124; `undefined`>
*Defined in [Combined.ts:297](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Combined.ts#L297)*
*Defined in [Combined.ts:297](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Combined.ts#L297)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -737,7 +737,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentIndex](_queries_.apiqueries.md#sessioncurrentindex)*
*Defined in [Queries.ts:163](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L163)*
*Defined in [Queries.ts:163](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L163)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -750,7 +750,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentStart](_queries_.apiqueries.md#sessioncurrentstart)*
*Defined in [Queries.ts:167](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L167)*
*Defined in [Queries.ts:167](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L167)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -763,7 +763,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLastLengthChange](_queries_.apiqueries.md#sessionlastlengthchange)*
*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L171)*
*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L171)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -776,7 +776,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLength](_queries_.apiqueries.md#sessionlength)*
*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L175)*
*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L175)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -789,7 +789,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionReward](_queries_.apiqueries.md#sessionreward)*
*Defined in [Queries.ts:155](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L155)*
*Defined in [Queries.ts:155](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L155)*
**Returns:** `Observable`< `Perbill` &#124; `undefined`>
@@ -802,7 +802,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionRewardCurrent](_queries_.apiqueries.md#sessionrewardcurrent)*
*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L159)*
*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L159)*
**Returns:** `Observable`< `Balance` &#124; `undefined`>
@@ -813,7 +813,7 @@ ___
▸ **sessionTimeExpected**(): `Observable`< `Moment` &#124; `undefined`>
*Defined in [Combined.ts:316](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Combined.ts#L316)*
*Defined in [Combined.ts:316](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Combined.ts#L316)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -824,7 +824,7 @@ ___
▸ **sessionTimeRemaining**(): `Observable`< `Moment` &#124; `undefined`>
*Defined in [Combined.ts:331](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Combined.ts#L331)*
*Defined in [Combined.ts:331](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Combined.ts#L331)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -837,7 +837,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionValidators](_queries_.apiqueries.md#sessionvalidators)*
*Defined in [Queries.ts:183](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L183)*
*Defined in [Queries.ts:183](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L183)*
**Returns:** `Observable`<`Array`<`AccountId`>>
@@ -850,7 +850,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionsPerEra](_queries_.apiqueries.md#sessionsperera)*
*Defined in [Queries.ts:179](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L179)*
*Defined in [Queries.ts:179](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L179)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -863,7 +863,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingIntentions](_queries_.apiqueries.md#stakingintentions)*
*Defined in [Queries.ts:194](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L194)*
*Defined in [Queries.ts:194](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L194)*
**Returns:** `Observable`<`Array`<`AccountId`>>
@@ -876,7 +876,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominating](_queries_.apiqueries.md#stakingnominating)*
*Defined in [Queries.ts:216](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L216)*
*Defined in [Queries.ts:216](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L216)*
**Parameters:**
@@ -895,7 +895,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominatorsFor](_queries_.apiqueries.md#stakingnominatorsfor)*
*Defined in [Queries.ts:205](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L205)*
*Defined in [Queries.ts:205](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L205)*
**Parameters:**
@@ -914,7 +914,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[submitAndWatchExtrinsic](_calls_.apicalls.md#submitandwatchextrinsic)*
*Defined in [Calls.ts:51](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Calls.ts#L51)*
*Defined in [Calls.ts:51](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Calls.ts#L51)*
**Parameters:**
@@ -933,7 +933,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[submitExtrinsic](_calls_.apicalls.md#submitextrinsic)*
*Defined in [Calls.ts:47](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Calls.ts#L47)*
*Defined in [Calls.ts:47](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Calls.ts#L47)*
**Parameters:**
@@ -952,7 +952,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[subscribeNewHead](_calls_.apicalls.md#subscribenewhead)*
*Defined in [Calls.ts:33](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Calls.ts#L33)*
*Defined in [Calls.ts:33](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Calls.ts#L33)*
**Returns:** `Observable`< `Header` &#124; `undefined`>
@@ -965,7 +965,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[systemEvents](_queries_.apiqueries.md#systemevents)*
*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L220)*
*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L220)*
**Returns:** `Observable`<`Array`<`EventRecord`>>
@@ -978,7 +978,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[systemName](_calls_.apicalls.md#systemname)*
*Defined in [Calls.ts:39](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Calls.ts#L39)*
*Defined in [Calls.ts:39](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Calls.ts#L39)*
**Returns:** `Observable`< `Text` &#124; `undefined`>
@@ -991,7 +991,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[systemVersion](_calls_.apicalls.md#systemversion)*
*Defined in [Calls.ts:43](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Calls.ts#L43)*
*Defined in [Calls.ts:43](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Calls.ts#L43)*
**Returns:** `Observable`< `Text` &#124; `undefined`>
@@ -1002,7 +1002,7 @@ ___
▸ **validatingBalance**(address: * `AccountId` &#124; `string`*): `Observable`<[RxBalance](../modules/_types_.md#rxbalance)>
*Defined in [Combined.ts:346](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Combined.ts#L346)*
*Defined in [Combined.ts:346](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Combined.ts#L346)*
**Parameters:**
@@ -1019,7 +1019,7 @@ ___
▸ **validatingBalances**(...addresses: *`Array`< `AccountId` &#124; `string`>*): `Observable`<[RxBalanceMap](../modules/_types_.md#rxbalancemap)>
*Defined in [Combined.ts:371](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Combined.ts#L371)*
*Defined in [Combined.ts:371](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Combined.ts#L371)*
**Parameters:**
@@ -1038,7 +1038,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[validatorCount](_queries_.apiqueries.md#validatorcount)*
*Defined in [Queries.ts:231](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L231)*
*Defined in [Queries.ts:231](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L231)*
**Returns:** `Observable`< `u32` &#124; `undefined`>
@@ -1049,7 +1049,7 @@ ___
▸ **votingBalance**(address: * `AccountIndex` &#124; `AccountId` &#124; `string`*): `Observable`<[RxBalance](../modules/_types_.md#rxbalance)>
*Defined in [Combined.ts:385](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Combined.ts#L385)*
*Defined in [Combined.ts:385](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Combined.ts#L385)*
**Parameters:**
@@ -1066,7 +1066,7 @@ ___
▸ **votingBalances**(...addresses: *`Array`< `AccountId` &#124; `string`>*): `Observable`<[RxBalance](../modules/_types_.md#rxbalance)[]>
*Defined in [Combined.ts:425](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Combined.ts#L425)*
*Defined in [Combined.ts:425](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Combined.ts#L425)*
**Parameters:**
@@ -1083,7 +1083,7 @@ ___
▸ **votingBalancesNominatorsFor**(address: * `AccountId` &#124; `string`*): `Observable`<`any`>
*Defined in [Combined.ts:414](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Combined.ts#L414)*
*Defined in [Combined.ts:414](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Combined.ts#L414)*
**Parameters:**
docs/api-observable/classes/_index_.api.md
+72 -72
View File
@@ -16,7 +16,7 @@
*Inherited from [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Base.ts#L33)*
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Base.ts#L33)*
**Parameters:**
@@ -38,7 +38,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[whenReady](_base_.apibase.md#whenready)*
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Base.ts#L33)*
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Base.ts#L33)*
___
<a id="extrinsics"></a>
@@ -49,7 +49,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[extrinsics](_base_.apibase.md#extrinsics)*
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Base.ts#L41)*
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Base.ts#L41)*
___
<a id="storage"></a>
@@ -60,7 +60,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[storage](_base_.apibase.md#storage)*
*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Base.ts#L42)*
*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Base.ts#L42)*
___
@@ -74,7 +74,7 @@ getgenesisHash(): `Hash`
*Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)*
*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Base.ts#L87)*
*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Base.ts#L87)*
**Returns:** `Hash`
@@ -90,7 +90,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[accountIdAndIndex](_combined_.apicombined.md#accountidandindex)*
*Defined in [Combined.ts:79](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Combined.ts#L79)*
*Defined in [Combined.ts:79](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Combined.ts#L79)*
**Parameters:**
@@ -109,7 +109,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[accountIdFromIndex](_combined_.apicombined.md#accountidfromindex)*
*Defined in [Combined.ts:53](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Combined.ts#L53)*
*Defined in [Combined.ts:53](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Combined.ts#L53)*
**Parameters:**
@@ -128,7 +128,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[accountIndexFromId](_combined_.apicombined.md#accountindexfromid)*
*Defined in [Combined.ts:68](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Combined.ts#L68)*
*Defined in [Combined.ts:68](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Combined.ts#L68)*
**Parameters:**
@@ -147,7 +147,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[accountIndexes](_combined_.apicombined.md#accountindexes)*
*Defined in [Combined.ts:23](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Combined.ts#L23)*
*Defined in [Combined.ts:23](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Combined.ts#L23)*
**Returns:** `Observable`<`object`>
@@ -160,7 +160,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[accountNonce](_queries_.apiqueries.md#accountnonce)*
*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L19)*
*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L19)*
**Parameters:**
@@ -179,7 +179,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceFree](_queries_.apiqueries.md#balancefree)*
*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L23)*
*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L23)*
**Parameters:**
@@ -198,7 +198,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceReserved](_queries_.apiqueries.md#balancereserved)*
*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L27)*
*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L27)*
**Parameters:**
@@ -217,7 +217,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[bestNumber](_calls_.apicalls.md#bestnumber)*
*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Calls.ts#L13)*
*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Calls.ts#L13)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -230,7 +230,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[blockNow](_queries_.apiqueries.md#blocknow)*
*Defined in [Queries.ts:35](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L35)*
*Defined in [Queries.ts:35](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L35)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -243,7 +243,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[blockPeriod](_queries_.apiqueries.md#blockperiod)*
*Defined in [Queries.ts:31](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L31)*
*Defined in [Queries.ts:31](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L31)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -256,7 +256,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[chain](_calls_.apicalls.md#chain)*
*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Calls.ts#L25)*
*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Calls.ts#L25)*
**Returns:** `Observable`< `Text` &#124; `undefined`>
@@ -269,7 +269,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyLaunchPeriod](_queries_.apiqueries.md#democracylaunchperiod)*
*Defined in [Queries.ts:39](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L39)*
*Defined in [Queries.ts:39](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L39)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -282,7 +282,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyNextTally](_queries_.apiqueries.md#democracynexttally)*
*Defined in [Queries.ts:43](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L43)*
*Defined in [Queries.ts:43](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L43)*
**Returns:** `Observable`< `ReferendumIndex` &#124; `undefined`>
@@ -295,7 +295,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[democracyReferendumVoters](_combined_.apicombined.md#democracyreferendumvoters)*
*Defined in [Combined.ts:137](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Combined.ts#L137)*
*Defined in [Combined.ts:137](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Combined.ts#L137)*
**Parameters:**
@@ -314,7 +314,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[democracyVotersBalancesOf](_combined_.apicombined.md#democracyvotersbalancesof)*
*Defined in [Combined.ts:182](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Combined.ts#L182)*
*Defined in [Combined.ts:182](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Combined.ts#L182)*
**Parameters:**
@@ -333,7 +333,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[democracyVotersVotesOf](_combined_.apicombined.md#democracyvotersvotesof)*
*Defined in [Combined.ts:198](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Combined.ts#L198)*
*Defined in [Combined.ts:198](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Combined.ts#L198)*
**Parameters:**
@@ -352,7 +352,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyVotingPeriod](_queries_.apiqueries.md#democracyvotingperiod)*
*Defined in [Queries.ts:126](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L126)*
*Defined in [Queries.ts:126](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L126)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -365,7 +365,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[eraBlockLength](_combined_.apicombined.md#erablocklength)*
*Defined in [Combined.ts:209](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Combined.ts#L209)*
*Defined in [Combined.ts:209](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Combined.ts#L209)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -378,7 +378,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[eraBlockProgress](_combined_.apicombined.md#erablockprogress)*
*Defined in [Combined.ts:224](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Combined.ts#L224)*
*Defined in [Combined.ts:224](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Combined.ts#L224)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -391,7 +391,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[eraBlockRemaining](_combined_.apicombined.md#erablockremaining)*
*Defined in [Combined.ts:247](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Combined.ts#L247)*
*Defined in [Combined.ts:247](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Combined.ts#L247)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -404,7 +404,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[eraLastLengthChange](_queries_.apiqueries.md#eralastlengthchange)*
*Defined in [Queries.ts:151](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L151)*
*Defined in [Queries.ts:151](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L151)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -417,7 +417,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[fees](_queries_.apiqueries.md#fees)*
*Defined in [Queries.ts:130](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L130)*
*Defined in [Queries.ts:130](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L130)*
**Returns:** `Observable`<[RxFees](../modules/_types_.md#rxfees)>
@@ -430,7 +430,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[getAccountEnumSet](_queries_.apiqueries.md#getaccountenumset)*
*Defined in [Queries.ts:47](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L47)*
*Defined in [Queries.ts:47](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L47)*
**Parameters:**
@@ -449,7 +449,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[getBlock](_calls_.apicalls.md#getblock)*
*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Calls.ts#L29)*
*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Calls.ts#L29)*
**Parameters:**
@@ -468,7 +468,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[isConnected](_base_.apibase.md#isconnected)*
*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Base.ts#L91)*
*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Base.ts#L91)*
**Returns:** `Observable`<`boolean`>
@@ -481,7 +481,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[nextAccountEnumSet](_queries_.apiqueries.md#nextaccountenumset)*
*Defined in [Queries.ts:58](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L58)*
*Defined in [Queries.ts:58](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L58)*
**Returns:** `Observable`< `AccountIndex` &#124; `undefined`>
@@ -494,7 +494,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[proposalDeposits](_queries_.apiqueries.md#proposaldeposits)*
*Defined in [Queries.ts:62](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L62)*
*Defined in [Queries.ts:62](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L62)*
**Parameters:**
@@ -513,7 +513,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[publicProposalCount](_combined_.apicombined.md#publicproposalcount)*
*Defined in [Combined.ts:115](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Combined.ts#L115)*
*Defined in [Combined.ts:115](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Combined.ts#L115)*
**Returns:** `Observable`<`number`>
@@ -526,7 +526,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[publicProposals](_queries_.apiqueries.md#publicproposals)*
*Defined in [Queries.ts:75](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L75)*
*Defined in [Queries.ts:75](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L75)*
**Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>>
@@ -539,7 +539,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)*
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Base.ts#L95)*
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Base.ts#L95)*
**Type parameters:**
@@ -562,7 +562,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)*
*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Base.ts#L108)*
*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Base.ts#L108)*
**Type parameters:**
@@ -585,7 +585,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)*
*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Base.ts#L123)*
*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Base.ts#L123)*
**Type parameters:**
@@ -607,7 +607,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumCount](_queries_.apiqueries.md#referendumcount)*
*Defined in [Queries.ts:94](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L94)*
*Defined in [Queries.ts:94](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L94)*
**Returns:** `Observable`< `ReferendumIndex` &#124; `undefined`>
@@ -620,7 +620,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumInfo](_queries_.apiqueries.md#referenduminfo)*
*Defined in [Queries.ts:98](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L98)*
*Defined in [Queries.ts:98](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L98)*
**Parameters:**
@@ -639,7 +639,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVote](_queries_.apiqueries.md#referendumvote)*
*Defined in [Queries.ts:111](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L111)*
*Defined in [Queries.ts:111](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L111)*
**Parameters:**
@@ -659,7 +659,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVoters](_queries_.apiqueries.md#referendumvoters)*
*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L115)*
*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L115)*
**Parameters:**
@@ -678,7 +678,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[referendumVotes](_combined_.apicombined.md#referendumvotes)*
*Defined in [Combined.ts:174](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Combined.ts#L174)*
*Defined in [Combined.ts:174](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Combined.ts#L174)*
**Parameters:**
@@ -698,7 +698,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[referendums](_combined_.apicombined.md#referendums)*
*Defined in [Combined.ts:153](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Combined.ts#L153)*
*Defined in [Combined.ts:153](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Combined.ts#L153)*
**Returns:** `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>>
@@ -711,7 +711,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[referendumsInfo](_combined_.apicombined.md#referendumsinfo)*
*Defined in [Combined.ts:125](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Combined.ts#L125)*
*Defined in [Combined.ts:125](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Combined.ts#L125)*
**Parameters:**
@@ -730,7 +730,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[sessionBlockProgress](_combined_.apicombined.md#sessionblockprogress)*
*Defined in [Combined.ts:262](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Combined.ts#L262)*
*Defined in [Combined.ts:262](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Combined.ts#L262)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -743,7 +743,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[sessionBlockRemaining](_combined_.apicombined.md#sessionblockremaining)*
*Defined in [Combined.ts:282](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Combined.ts#L282)*
*Defined in [Combined.ts:282](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Combined.ts#L282)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -756,7 +756,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[sessionBrokenValue](_combined_.apicombined.md#sessionbrokenvalue)*
*Defined in [Combined.ts:297](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Combined.ts#L297)*
*Defined in [Combined.ts:297](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Combined.ts#L297)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -769,7 +769,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentIndex](_queries_.apiqueries.md#sessioncurrentindex)*
*Defined in [Queries.ts:163](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L163)*
*Defined in [Queries.ts:163](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L163)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -782,7 +782,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentStart](_queries_.apiqueries.md#sessioncurrentstart)*
*Defined in [Queries.ts:167](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L167)*
*Defined in [Queries.ts:167](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L167)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -795,7 +795,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLastLengthChange](_queries_.apiqueries.md#sessionlastlengthchange)*
*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L171)*
*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L171)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -808,7 +808,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLength](_queries_.apiqueries.md#sessionlength)*
*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L175)*
*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L175)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -821,7 +821,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionReward](_queries_.apiqueries.md#sessionreward)*
*Defined in [Queries.ts:155](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L155)*
*Defined in [Queries.ts:155](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L155)*
**Returns:** `Observable`< `Perbill` &#124; `undefined`>
@@ -834,7 +834,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionRewardCurrent](_queries_.apiqueries.md#sessionrewardcurrent)*
*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L159)*
*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L159)*
**Returns:** `Observable`< `Balance` &#124; `undefined`>
@@ -847,7 +847,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[sessionTimeExpected](_combined_.apicombined.md#sessiontimeexpected)*
*Defined in [Combined.ts:316](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Combined.ts#L316)*
*Defined in [Combined.ts:316](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Combined.ts#L316)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -860,7 +860,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[sessionTimeRemaining](_combined_.apicombined.md#sessiontimeremaining)*
*Defined in [Combined.ts:331](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Combined.ts#L331)*
*Defined in [Combined.ts:331](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Combined.ts#L331)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -873,7 +873,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionValidators](_queries_.apiqueries.md#sessionvalidators)*
*Defined in [Queries.ts:183](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L183)*
*Defined in [Queries.ts:183](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L183)*
**Returns:** `Observable`<`Array`<`AccountId`>>
@@ -886,7 +886,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionsPerEra](_queries_.apiqueries.md#sessionsperera)*
*Defined in [Queries.ts:179](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L179)*
*Defined in [Queries.ts:179](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L179)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -899,7 +899,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingIntentions](_queries_.apiqueries.md#stakingintentions)*
*Defined in [Queries.ts:194](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L194)*
*Defined in [Queries.ts:194](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L194)*
**Returns:** `Observable`<`Array`<`AccountId`>>
@@ -912,7 +912,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominating](_queries_.apiqueries.md#stakingnominating)*
*Defined in [Queries.ts:216](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L216)*
*Defined in [Queries.ts:216](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L216)*
**Parameters:**
@@ -931,7 +931,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominatorsFor](_queries_.apiqueries.md#stakingnominatorsfor)*
*Defined in [Queries.ts:205](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L205)*
*Defined in [Queries.ts:205](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L205)*
**Parameters:**
@@ -950,7 +950,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[submitAndWatchExtrinsic](_calls_.apicalls.md#submitandwatchextrinsic)*
*Defined in [Calls.ts:51](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Calls.ts#L51)*
*Defined in [Calls.ts:51](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Calls.ts#L51)*
**Parameters:**
@@ -969,7 +969,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[submitExtrinsic](_calls_.apicalls.md#submitextrinsic)*
*Defined in [Calls.ts:47](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Calls.ts#L47)*
*Defined in [Calls.ts:47](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Calls.ts#L47)*
**Parameters:**
@@ -988,7 +988,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[subscribeNewHead](_calls_.apicalls.md#subscribenewhead)*
*Defined in [Calls.ts:33](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Calls.ts#L33)*
*Defined in [Calls.ts:33](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Calls.ts#L33)*
**Returns:** `Observable`< `Header` &#124; `undefined`>
@@ -1001,7 +1001,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[systemEvents](_queries_.apiqueries.md#systemevents)*
*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L220)*
*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L220)*
**Returns:** `Observable`<`Array`<`EventRecord`>>
@@ -1014,7 +1014,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[systemName](_calls_.apicalls.md#systemname)*
*Defined in [Calls.ts:39](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Calls.ts#L39)*
*Defined in [Calls.ts:39](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Calls.ts#L39)*
**Returns:** `Observable`< `Text` &#124; `undefined`>
@@ -1027,7 +1027,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[systemVersion](_calls_.apicalls.md#systemversion)*
*Defined in [Calls.ts:43](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Calls.ts#L43)*
*Defined in [Calls.ts:43](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Calls.ts#L43)*
**Returns:** `Observable`< `Text` &#124; `undefined`>
@@ -1040,7 +1040,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[validatingBalance](_combined_.apicombined.md#validatingbalance)*
*Defined in [Combined.ts:346](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Combined.ts#L346)*
*Defined in [Combined.ts:346](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Combined.ts#L346)*
**Parameters:**
@@ -1059,7 +1059,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[validatingBalances](_combined_.apicombined.md#validatingbalances)*
*Defined in [Combined.ts:371](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Combined.ts#L371)*
*Defined in [Combined.ts:371](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Combined.ts#L371)*
**Parameters:**
@@ -1078,7 +1078,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[validatorCount](_queries_.apiqueries.md#validatorcount)*
*Defined in [Queries.ts:231](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L231)*
*Defined in [Queries.ts:231](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L231)*
**Returns:** `Observable`< `u32` &#124; `undefined`>
@@ -1091,7 +1091,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[votingBalance](_combined_.apicombined.md#votingbalance)*
*Defined in [Combined.ts:385](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Combined.ts#L385)*
*Defined in [Combined.ts:385](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Combined.ts#L385)*
**Parameters:**
@@ -1110,7 +1110,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[votingBalances](_combined_.apicombined.md#votingbalances)*
*Defined in [Combined.ts:425](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Combined.ts#L425)*
*Defined in [Combined.ts:425](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Combined.ts#L425)*
**Parameters:**
@@ -1129,7 +1129,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[votingBalancesNominatorsFor](_combined_.apicombined.md#votingbalancesnominatorsfor)*
*Defined in [Combined.ts:414](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Combined.ts#L414)*
*Defined in [Combined.ts:414](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Combined.ts#L414)*
**Parameters:**
docs/api-observable/classes/_queries_.apiqueries.md
+40 -40
View File
@@ -18,7 +18,7 @@
*Inherited from [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Base.ts#L33)*
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Base.ts#L33)*
**Parameters:**
@@ -40,7 +40,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[whenReady](_base_.apibase.md#whenready)*
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Base.ts#L33)*
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Base.ts#L33)*
___
<a id="extrinsics"></a>
@@ -51,7 +51,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[extrinsics](_base_.apibase.md#extrinsics)*
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Base.ts#L41)*
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Base.ts#L41)*
___
<a id="storage"></a>
@@ -62,7 +62,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[storage](_base_.apibase.md#storage)*
*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Base.ts#L42)*
*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Base.ts#L42)*
___
@@ -76,7 +76,7 @@ getgenesisHash(): `Hash`
*Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)*
*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Base.ts#L87)*
*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Base.ts#L87)*
**Returns:** `Hash`
@@ -90,7 +90,7 @@ ___
▸ **accountNonce**(address: * `AccountId` &#124; `string`*): `Observable`< `Index` &#124; `undefined`>
*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L19)*
*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L19)*
**Parameters:**
@@ -107,7 +107,7 @@ ___
▸ **balanceFree**(address: * `AccountId` &#124; `string`*): `Observable`< `Balance` &#124; `undefined`>
*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L23)*
*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L23)*
**Parameters:**
@@ -124,7 +124,7 @@ ___
▸ **balanceReserved**(address: * `AccountId` &#124; `string`*): `Observable`< `Balance` &#124; `undefined`>
*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L27)*
*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L27)*
**Parameters:**
@@ -141,7 +141,7 @@ ___
▸ **blockNow**(): `Observable`< `Moment` &#124; `undefined`>
*Defined in [Queries.ts:35](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L35)*
*Defined in [Queries.ts:35](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L35)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -152,7 +152,7 @@ ___
▸ **blockPeriod**(): `Observable`< `Moment` &#124; `undefined`>
*Defined in [Queries.ts:31](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L31)*
*Defined in [Queries.ts:31](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L31)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -163,7 +163,7 @@ ___
▸ **democracyLaunchPeriod**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Queries.ts:39](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L39)*
*Defined in [Queries.ts:39](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L39)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -174,7 +174,7 @@ ___
▸ **democracyNextTally**(): `Observable`< `ReferendumIndex` &#124; `undefined`>
*Defined in [Queries.ts:43](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L43)*
*Defined in [Queries.ts:43](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L43)*
**Returns:** `Observable`< `ReferendumIndex` &#124; `undefined`>
@@ -185,7 +185,7 @@ ___
▸ **democracyVotingPeriod**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Queries.ts:126](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L126)*
*Defined in [Queries.ts:126](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L126)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -196,7 +196,7 @@ ___
▸ **eraLastLengthChange**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Queries.ts:151](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L151)*
*Defined in [Queries.ts:151](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L151)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -207,7 +207,7 @@ ___
▸ **fees**(): `Observable`<[RxFees](../modules/_types_.md#rxfees)>
*Defined in [Queries.ts:130](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L130)*
*Defined in [Queries.ts:130](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L130)*
**Returns:** `Observable`<[RxFees](../modules/_types_.md#rxfees)>
@@ -218,7 +218,7 @@ ___
▸ **getAccountEnumSet**(index: * `AccountIndex` &#124; `BN` &#124; `number`*): `Observable`< `Array`<`AccountId`> &#124; `undefined`>
*Defined in [Queries.ts:47](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L47)*
*Defined in [Queries.ts:47](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L47)*
**Parameters:**
@@ -237,7 +237,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[isConnected](_base_.apibase.md#isconnected)*
*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Base.ts#L91)*
*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Base.ts#L91)*
**Returns:** `Observable`<`boolean`>
@@ -248,7 +248,7 @@ ___
▸ **nextAccountEnumSet**(): `Observable`< `AccountIndex` &#124; `undefined`>
*Defined in [Queries.ts:58](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L58)*
*Defined in [Queries.ts:58](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L58)*
**Returns:** `Observable`< `AccountIndex` &#124; `undefined`>
@@ -259,7 +259,7 @@ ___
▸ **proposalDeposits**(proposalId: * `PropIndex` &#124; `BN` &#124; `number`*): `Observable`< [RxProposalDeposits](_classes_.rxproposaldeposits.md) &#124; `undefined`>
*Defined in [Queries.ts:62](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L62)*
*Defined in [Queries.ts:62](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L62)*
**Parameters:**
@@ -276,7 +276,7 @@ ___
▸ **publicProposals**(): `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>>
*Defined in [Queries.ts:75](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L75)*
*Defined in [Queries.ts:75](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L75)*
**Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>>
@@ -289,7 +289,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)*
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Base.ts#L95)*
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Base.ts#L95)*
**Type parameters:**
@@ -312,7 +312,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)*
*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Base.ts#L108)*
*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Base.ts#L108)*
**Type parameters:**
@@ -335,7 +335,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)*
*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Base.ts#L123)*
*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Base.ts#L123)*
**Type parameters:**
@@ -355,7 +355,7 @@ ___
▸ **referendumCount**(): `Observable`< `ReferendumIndex` &#124; `undefined`>
*Defined in [Queries.ts:94](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L94)*
*Defined in [Queries.ts:94](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L94)*
**Returns:** `Observable`< `ReferendumIndex` &#124; `undefined`>
@@ -366,7 +366,7 @@ ___
▸ **referendumInfo**(referendumId: * `ReferendumIndex` &#124; `BN` &#124; `number`*): `Observable`< [RxReferendum](_classes_.rxreferendum.md) &#124; `undefined`>
*Defined in [Queries.ts:98](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L98)*
*Defined in [Queries.ts:98](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L98)*
**Parameters:**
@@ -383,7 +383,7 @@ ___
▸ **referendumVote**(index: * `ReferendumIndex` &#124; `BN` &#124; `number`*, address: * `AccountId` &#124; `string`*): `Observable`< `Bool` &#124; `undefined`>
*Defined in [Queries.ts:111](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L111)*
*Defined in [Queries.ts:111](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L111)*
**Parameters:**
@@ -401,7 +401,7 @@ ___
▸ **referendumVoters**(index: * `ReferendumIndex` &#124; `BN` &#124; `number`*): `Observable`<`Array`<`AccountId`>>
*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L115)*
*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L115)*
**Parameters:**
@@ -418,7 +418,7 @@ ___
▸ **sessionCurrentIndex**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Queries.ts:163](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L163)*
*Defined in [Queries.ts:163](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L163)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -429,7 +429,7 @@ ___
▸ **sessionCurrentStart**(): `Observable`< `Moment` &#124; `undefined`>
*Defined in [Queries.ts:167](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L167)*
*Defined in [Queries.ts:167](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L167)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -440,7 +440,7 @@ ___
▸ **sessionLastLengthChange**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L171)*
*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L171)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -451,7 +451,7 @@ ___
▸ **sessionLength**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L175)*
*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L175)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -462,7 +462,7 @@ ___
▸ **sessionReward**(): `Observable`< `Perbill` &#124; `undefined`>
*Defined in [Queries.ts:155](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L155)*
*Defined in [Queries.ts:155](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L155)*
**Returns:** `Observable`< `Perbill` &#124; `undefined`>
@@ -473,7 +473,7 @@ ___
▸ **sessionRewardCurrent**(): `Observable`< `Balance` &#124; `undefined`>
*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L159)*
*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L159)*
**Returns:** `Observable`< `Balance` &#124; `undefined`>
@@ -484,7 +484,7 @@ ___
▸ **sessionValidators**(): `Observable`<`Array`<`AccountId`>>
*Defined in [Queries.ts:183](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L183)*
*Defined in [Queries.ts:183](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L183)*
**Returns:** `Observable`<`Array`<`AccountId`>>
@@ -495,7 +495,7 @@ ___
▸ **sessionsPerEra**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Queries.ts:179](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L179)*
*Defined in [Queries.ts:179](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L179)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -506,7 +506,7 @@ ___
▸ **stakingIntentions**(): `Observable`<`Array`<`AccountId`>>
*Defined in [Queries.ts:194](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L194)*
*Defined in [Queries.ts:194](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L194)*
**Returns:** `Observable`<`Array`<`AccountId`>>
@@ -517,7 +517,7 @@ ___
▸ **stakingNominating**(address: * `AccountId` &#124; `string`*): `Observable`< `AccountId` &#124; `undefined`>
*Defined in [Queries.ts:216](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L216)*
*Defined in [Queries.ts:216](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L216)*
**Parameters:**
@@ -534,7 +534,7 @@ ___
▸ **stakingNominatorsFor**(address: * `AccountId` &#124; `string`*): `Observable`<`Array`<`AccountId`>>
*Defined in [Queries.ts:205](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L205)*
*Defined in [Queries.ts:205](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L205)*
**Parameters:**
@@ -551,7 +551,7 @@ ___
▸ **systemEvents**(): `Observable`<`Array`<`EventRecord`>>
*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L220)*
*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L220)*
**Returns:** `Observable`<`Array`<`EventRecord`>>
@@ -562,7 +562,7 @@ ___
▸ **validatorCount**(): `Observable`< `u32` &#124; `undefined`>
*Defined in [Queries.ts:231](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/Queries.ts#L231)*
*Defined in [Queries.ts:231](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/Queries.ts#L231)*
**Returns:** `Observable`< `u32` &#124; `undefined`>
docs/api-observable/modules/_types_.md
+5 -5
View File
@@ -9,7 +9,7 @@
**Ƭ ApiFunctions**: * `keyof ApiBase` &#124; `keyof ApiCalls` &#124; `keyof ApiCombined` &#124; `keyof ApiQueries`
*
*Defined in [types.ts:12](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/types.ts#L12)*
*Defined in [types.ts:12](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/types.ts#L12)*
___
<a id="rxbalance"></a>
@@ -18,7 +18,7 @@ ___
**Ƭ RxBalance**: *`object`*
*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/types.ts#L14)*
*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/types.ts#L14)*
#### Type declaration
@@ -29,7 +29,7 @@ ___
**Ƭ RxBalanceMap**: *`object`*
*Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/types.ts#L38)*
*Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/types.ts#L38)*
#### Type declaration
@@ -42,7 +42,7 @@ ___
**Ƭ RxFees**: *`object`*
*Defined in [types.ts:24](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/types.ts#L24)*
*Defined in [types.ts:24](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/types.ts#L24)*
#### Type declaration
@@ -53,7 +53,7 @@ ___
**Ƭ RxReferendumVote**: *`object`*
*Defined in [types.ts:32](https://github.com/polkadot-js/api/blob/69f6850/packages/api-observable/src/types.ts#L32)*
*Defined in [types.ts:32](https://github.com/polkadot-js/api/blob/448a729/packages/api-observable/src/types.ts#L32)*
#### Type declaration
docs/api/classes/_base_.apibase.md
+9 -9
View File
@@ -24,7 +24,7 @@
⊕ **new ApiBase**(provider?: * [ApiOptions](../interfaces/_types_.apioptions.md) &#124; `ProviderInterface`*): [ApiBase](_base_.apibase.md)
*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/Base.ts#L40)*
*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/Base.ts#L40)*
*__description__*: Create an instance of the class
@@ -58,7 +58,7 @@ ___
getgenesisHash(): `Hash`
*Defined in [Base.ts:79](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/Base.ts#L79)*
*Defined in [Base.ts:79](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/Base.ts#L79)*
*__description__*: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions.
@@ -71,7 +71,7 @@ ___
gethasSubscriptions(): `boolean`
*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/Base.ts#L88)*
*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/Base.ts#L88)*
*__description__*: `true` when subscriptions are supported
@@ -84,7 +84,7 @@ ___
getquery(): `S`
*Defined in [Base.ts:124](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/Base.ts#L124)*
*Defined in [Base.ts:124](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/Base.ts#L124)*
*__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.
@@ -107,7 +107,7 @@ ___
getrpc(): `R`
*Defined in [Base.ts:144](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/Base.ts#L144)*
*Defined in [Base.ts:144](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/Base.ts#L144)*
*__description__*: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic `api.query` and `api.tx` sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime.
@@ -130,7 +130,7 @@ ___
getruntimeMetadata(): `RuntimeMetadata`
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/Base.ts#L95)*
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/Base.ts#L95)*
*__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.
@@ -143,7 +143,7 @@ ___
getruntimeVersion(): `RuntimeVersion`
*Defined in [Base.ts:104](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/Base.ts#L104)*
*Defined in [Base.ts:104](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/Base.ts#L104)*
*__description__*: Contains the version information for the current runtime.
@@ -156,7 +156,7 @@ ___
gettx(): `E`
*Defined in [Base.ts:163](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/Base.ts#L163)*
*Defined in [Base.ts:163](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/Base.ts#L163)*
*__description__*: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata.
@@ -183,7 +183,7 @@ ___
▸ **on**(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `void`
*Defined in [Base.ts:188](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/Base.ts#L188)*
*Defined in [Base.ts:188](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/Base.ts#L188)*
*__description__*: Attach an eventemitter handler to listen to a specific event
docs/api/classes/_promise_combinator_.combinator.md
+1 -1
View File
@@ -12,7 +12,7 @@
⊕ **new Combinator**(fns: *`Array`<[CombinatorFunction](../modules/_promise_combinator_.md#combinatorfunction)>*, callback: *[CombinatorCallback](../modules/_promise_combinator_.md#combinatorcallback)*): [Combinator](_promise_combinator_.combinator.md)
*Defined in [promise/Combinator.ts:14](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/promise/Combinator.ts#L14)*
*Defined in [promise/Combinator.ts:14](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/promise/Combinator.ts#L14)*
**Parameters:**
docs/api/classes/_promise_index_.apipromise.html
+43 -43
View File
@@ -1122,9 +1122,9 @@
</li>
<li class="chapter " data-level="4.58" data-path="../../types/classes/_metadata_.callmetadata.html">
<li class="chapter " data-level="4.58" data-path="../../types/classes/_metadata_.callmetadata.md">
<a href="../../types/classes/_metadata_.callmetadata.html">
<span>
hidden
@@ -1135,9 +1135,9 @@
</li>
<li class="chapter " data-level="4.59" data-path="../../types/classes/_metadata_.eventmetadata.html">
<li class="chapter " data-level="4.59" data-path="../../types/classes/_metadata_.eventmetadata.md">
<a href="../../types/classes/_metadata_.eventmetadata.html">
<span>
hidden
@@ -1148,9 +1148,9 @@
</li>
<li class="chapter " data-level="4.60" data-path="../../types/classes/_metadata_.functionargumentmetadata.html">
<li class="chapter " data-level="4.60" data-path="../../types/classes/_metadata_.functionargumentmetadata.md">
<a href="../../types/classes/_metadata_.functionargumentmetadata.html">
<span>
hidden
@@ -1161,9 +1161,9 @@
</li>
<li class="chapter " data-level="4.61" data-path="../../types/classes/_metadata_.functionmetadata.html">
<li class="chapter " data-level="4.61" data-path="../../types/classes/_metadata_.functionmetadata.md">
<a href="../../types/classes/_metadata_.functionmetadata.html">
<span>
hidden
@@ -1174,9 +1174,9 @@
</li>
<li class="chapter " data-level="4.62" data-path="../../types/classes/_metadata_.modulemetadata.html">
<li class="chapter " data-level="4.62" data-path="../../types/classes/_metadata_.modulemetadata.md">
<a href="../../types/classes/_metadata_.modulemetadata.html">
<span>
hidden
@@ -1187,9 +1187,9 @@
</li>
<li class="chapter " data-level="4.63" data-path="../../types/classes/_metadata_.outerdispatchcall.html">
<li class="chapter " data-level="4.63" data-path="../../types/classes/_metadata_.outerdispatchcall.md">
<a href="../../types/classes/_metadata_.outerdispatchcall.html">
<span>
hidden
@@ -1200,9 +1200,9 @@
</li>
<li class="chapter " data-level="4.64" data-path="../../types/classes/_metadata_.outerdispatchmetadata.html">
<li class="chapter " data-level="4.64" data-path="../../types/classes/_metadata_.outerdispatchmetadata.md">
<a href="../../types/classes/_metadata_.outerdispatchmetadata.html">
<span>
hidden
@@ -1213,9 +1213,9 @@
</li>
<li class="chapter " data-level="4.65" data-path="../../types/classes/_metadata_.outereventmetadata.html">
<li class="chapter " data-level="4.65" data-path="../../types/classes/_metadata_.outereventmetadata.md">
<a href="../../types/classes/_metadata_.outereventmetadata.html">
<span>
hidden
@@ -1226,9 +1226,9 @@
</li>
<li class="chapter " data-level="4.66" data-path="../../types/classes/_metadata_.outereventmetadataevent.html">
<li class="chapter " data-level="4.66" data-path="../../types/classes/_metadata_.outereventmetadataevent.md">
<a href="../../types/classes/_metadata_.outereventmetadataevent.html">
<span>
hidden
@@ -1252,9 +1252,9 @@
</li>
<li class="chapter " data-level="4.68" data-path="../../types/classes/_metadata_.runtimemodulemetadata.html">
<li class="chapter " data-level="4.68" data-path="../../types/classes/_metadata_.runtimemodulemetadata.md">
<a href="../../types/classes/_metadata_.runtimemodulemetadata.html">
<span>
hidden
@@ -1265,9 +1265,9 @@
</li>
<li class="chapter " data-level="4.69" data-path="../../types/classes/_metadata_.storagefunctionmetadata.html">
<li class="chapter " data-level="4.69" data-path="../../types/classes/_metadata_.storagefunctionmetadata.md">
<a href="../../types/classes/_metadata_.storagefunctionmetadata.html">
<span>
hidden
@@ -1278,9 +1278,9 @@
</li>
<li class="chapter " data-level="4.70" data-path="../../types/classes/_metadata_.storagefunctionmodifier.html">
<li class="chapter " data-level="4.70" data-path="../../types/classes/_metadata_.storagefunctionmodifier.md">
<a href="../../types/classes/_metadata_.storagefunctionmodifier.html">
<span>
hidden
@@ -1291,9 +1291,9 @@
</li>
<li class="chapter " data-level="4.71" data-path="../../types/classes/_metadata_.storagefunctiontype.html">
<li class="chapter " data-level="4.71" data-path="../../types/classes/_metadata_.storagefunctiontype.md">
<a href="../../types/classes/_metadata_.storagefunctiontype.html">
<span>
hidden
@@ -1304,9 +1304,9 @@
</li>
<li class="chapter " data-level="4.72" data-path="../../types/classes/_metadata_.storagefunctiontype_map.html">
<li class="chapter " data-level="4.72" data-path="../../types/classes/_metadata_.storagefunctiontype_map.md">
<a href="../../types/classes/_metadata_.storagefunctiontype_map.html">
<span>
hidden
@@ -1317,9 +1317,9 @@
</li>
<li class="chapter " data-level="4.73" data-path="../../types/classes/_metadata_.storagemetadata.html">
<li class="chapter " data-level="4.73" data-path="../../types/classes/_metadata_.storagemetadata.md">
<a href="../../types/classes/_metadata_.storagemetadata.html">
<span>
hidden
@@ -2036,7 +2036,7 @@
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new ApiPromise</strong>(options?: <em> <a href="../interfaces/_types_.apioptions.md">ApiOptions</a> | <code>ProviderInterface</code></em>): <a href="_promise_index_.apipromise.html">ApiPromise</a></p>
<p><em>Overrides <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#constructor">constructor</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/promise/index.ts#L132" target="_blank">promise/index.ts:132</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/api/src/promise/index.ts#L132" target="_blank">promise/index.ts:132</a></em></p>
<p><em><strong>description</strong></em>: Creates an instance of the ApiPromise class</p>
<p><em><strong>example</strong></em>: </p>
<pre><code class="lang-javascript"><div class="sunlight-container sunlight-theme-gitbook"><div class="sunlight-code-container"><pre class="sunlight-highlight-javascript sunlight-highlighted"><span class="sunlight-javascript"><span class="sunlight-reservedWord">import</span>&#xA0;<span class="sunlight-ident">Api</span>&#xA0;<span class="sunlight-ident">from</span>&#xA0;<span class="sunlight-string">&apos;@polkadot/api/promise&apos;</span><span class="sunlight-punctuation">;</span>
@@ -2071,7 +2071,7 @@
<h2 id="genesishash">genesisHash</h2>
<p>getgenesisHash(): <code>Hash</code></p>
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#genesishash">genesisHash</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/Base.ts#L79" target="_blank">Base.ts:79</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/api/src/Base.ts#L79" target="_blank">Base.ts:79</a></em></p>
<p><em><strong>description</strong></em>: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions.</p>
<p><strong>Returns:</strong> <code>Hash</code></p>
<hr>
@@ -2079,14 +2079,14 @@
<h2 id="hassubscriptions">hasSubscriptions</h2>
<p>gethasSubscriptions(): <code>boolean</code></p>
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#hassubscriptions">hasSubscriptions</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/Base.ts#L88" target="_blank">Base.ts:88</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/api/src/Base.ts#L88" target="_blank">Base.ts:88</a></em></p>
<p><em><strong>description</strong></em>: <code>true</code> when subscriptions are supported</p>
<p><strong>Returns:</strong> <code>boolean</code></p>
<hr>
<p><a id="isready"></a></p>
<h2 id="isready">isReady</h2>
<p>getisReady(): <code>Promise</code>&lt;<a href="_promise_index_.apipromise.html">ApiPromise</a>&gt;</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/promise/index.ts#L167" target="_blank">promise/index.ts:167</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/api/src/promise/index.ts#L167" target="_blank">promise/index.ts:167</a></em></p>
<p><em><strong>description</strong></em>: Promise that returns the first time we are connected and loaded</p>
<p><strong>Returns:</strong> <code>Promise</code>&lt;<a href="_promise_index_.apipromise.html">ApiPromise</a>&gt;</p>
<hr>
@@ -2094,7 +2094,7 @@
<h2 id="query">query</h2>
<p>getquery(): <a href="../interfaces/_promise_types_.queryablestorage.md">QueryableStorage</a></p>
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#query">query</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/Base.ts#L124" target="_blank">Base.ts:124</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/api/src/Base.ts#L124" target="_blank">Base.ts:124</a></em></p>
<p><em><strong>description</strong></em>: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.</p>
<p>All calls inside the namespace, is denoted by <code>section</code>.<code>method</code> and may take an optional query parameter. As an example, <code>api.query.timestamp.now()</code> (current block timestamp) does not take parameters, while <code>api.query.system.accountNonce(&lt;accountId&gt;)</code> (retrieving the associated nonce for an account), takes the <code>AccountId</code> as a parameter.</p>
<p><em><strong>example</strong></em>: </p>
@@ -2108,7 +2108,7 @@
<h2 id="rpc">rpc</h2>
<p>getrpc(): <code>Rpc</code></p>
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#rpc">rpc</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/Base.ts#L144" target="_blank">Base.ts:144</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/api/src/Base.ts#L144" target="_blank">Base.ts:144</a></em></p>
<p><em><strong>description</strong></em>: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic <code>api.query</code> and <code>api.tx</code> sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime.</p>
<p>RPC endpoints available here allow for the query of chain, node and system information, in addition to providing interfaces for the raw queries of state (usine known keys) and the submission of transactions.</p>
<p><em><strong>example</strong></em>: </p>
@@ -2122,7 +2122,7 @@
<h2 id="runtimemetadata">runtimeMetadata</h2>
<p>getruntimeMetadata(): <code>RuntimeMetadata</code></p>
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#runtimemetadata">runtimeMetadata</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/Base.ts#L95" target="_blank">Base.ts:95</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/api/src/Base.ts#L95" target="_blank">Base.ts:95</a></em></p>
<p><em><strong>description</strong></em>: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics &amp; storage, but is useful for current runtime inspection.</p>
<p><strong>Returns:</strong> <code>RuntimeMetadata</code></p>
<hr>
@@ -2130,7 +2130,7 @@
<h2 id="runtimeversion">runtimeVersion</h2>
<p>getruntimeVersion(): <code>RuntimeVersion</code></p>
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#runtimeversion">runtimeVersion</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/Base.ts#L104" target="_blank">Base.ts:104</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/api/src/Base.ts#L104" target="_blank">Base.ts:104</a></em></p>
<p><em><strong>description</strong></em>: Contains the version information for the current runtime.</p>
<p><strong>Returns:</strong> <code>RuntimeVersion</code></p>
<hr>
@@ -2138,7 +2138,7 @@
<h2 id="tx">tx</h2>
<p>gettx(): <a href="../interfaces/_promise_types_.submittableextrinsics.md">SubmittableExtrinsics</a></p>
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#tx">tx</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/Base.ts#L163" target="_blank">Base.ts:163</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/api/src/Base.ts#L163" target="_blank">Base.ts:163</a></em></p>
<p><em><strong>description</strong></em>: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata.</p>
<p><em><strong>example</strong></em>: </p>
<pre><code class="lang-javascript"><div class="sunlight-container sunlight-theme-gitbook"><div class="sunlight-code-container"><pre class="sunlight-highlight-javascript sunlight-highlighted"><span class="sunlight-javascript"><span class="sunlight-ident">api</span><span class="sunlight-operator">.</span><span class="sunlight-ident">tx</span><span class="sunlight-operator">.</span><span class="sunlight-ident">balances</span>
@@ -2154,7 +2154,7 @@
<p><a id="combinelatest"></a></p>
<h2 id="combinelatest">combineLatest</h2>
<p>&#x25B8; <strong>combineLatest</strong>(fns: <em><code>Array</code>&lt;<a href="../modules/_promise_combinator_.md#combinatorfunction">CombinatorFunction</a>&gt;</em>, callback: <em><a href="../modules/_promise_combinator_.md#combinatorcallback">CombinatorCallback</a></em>): <a href="_promise_combinator_.combinator.md">Combinator</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/promise/index.ts#L195" target="_blank">promise/index.ts:195</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/api/src/promise/index.ts#L195" target="_blank">promise/index.ts:195</a></em></p>
<p><em><strong>description</strong></em>: Creates a combinator that can be used to combine the latest results from multiple subscriptions</p>
<p><em><strong>example</strong></em>: </p>
<pre><code class="lang-javascript"><div class="sunlight-container sunlight-theme-gitbook"><div class="sunlight-code-container"><pre class="sunlight-highlight-javascript sunlight-highlighted"><span class="sunlight-javascript"><span class="sunlight-reservedWord">const</span>&#xA0;<span class="sunlight-ident">address</span>&#xA0;<span class="sunlight-operator">=</span>&#xA0;<span class="sunlight-string">&apos;5DTestUPts3kjeXSTMyerHihn1uwMfLj8vU8sqF7qYrFacT7&apos;</span><span class="sunlight-punctuation">;</span>
@@ -2196,7 +2196,7 @@
<h2 id="on">on</h2>
<p>&#x25B8; <strong>on</strong>(type: <em><a href="../modules/_types_.md#apiinterface_events">ApiInterface$Events</a></em>, handler: <em><code>function</code></em>): <code>void</code></p>
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#on">on</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/Base.ts#L188" target="_blank">Base.ts:188</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/api/src/Base.ts#L188" target="_blank">Base.ts:188</a></em></p>
<p><em><strong>description</strong></em>: Attach an eventemitter handler to listen to a specific event</p>
<p><em><strong>example</strong></em>: </p>
<pre><code class="lang-javascript"><div class="sunlight-container sunlight-theme-gitbook"><div class="sunlight-code-container"><pre class="sunlight-highlight-javascript sunlight-highlighted"><span class="sunlight-javascript"><span class="sunlight-ident">api</span><span class="sunlight-operator">.</span><span class="sunlight-ident">on</span><span class="sunlight-punctuation">(</span><span class="sunlight-string">&apos;disconnected&apos;</span><span class="sunlight-punctuation">,</span>&#xA0;<span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">)</span>&#xA0;<span class="sunlight-operator">=</span><span class="sunlight-operator">&gt;</span>&#xA0;<span class="sunlight-punctuation">{</span>
@@ -2234,7 +2234,7 @@
<p><a id="create"></a></p>
<h2 id="static-create"><code>&lt;Static&gt;</code> create</h2>
<p>&#x25B8; <strong>create</strong>(options?: <em> <a href="../interfaces/_types_.apioptions.md">ApiOptions</a> | <code>ProviderInterface</code></em>): <code>Promise</code>&lt;<a href="_promise_index_.apipromise.html">ApiPromise</a>&gt;</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/promise/index.ts#L130" target="_blank">promise/index.ts:130</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/api/src/promise/index.ts#L130" target="_blank">promise/index.ts:130</a></em></p>
<p><em><strong>description</strong></em>: Creates an ApiPromise instance using the supplied provider. Returns an Promise containing the actual Api instance.</p>
<p><em><strong>example</strong></em>: </p>
<pre><code class="lang-javascript"><div class="sunlight-container sunlight-theme-gitbook"><div class="sunlight-code-container"><pre class="sunlight-highlight-javascript sunlight-highlighted"><span class="sunlight-javascript"><span class="sunlight-reservedWord">import</span>&#xA0;<span class="sunlight-ident">Api</span>&#xA0;<span class="sunlight-ident">from</span>&#xA0;<span class="sunlight-string">&apos;@polkadot/api/promise&apos;</span><span class="sunlight-punctuation">;</span>
@@ -2309,7 +2309,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"ApiPromise","level":"1.2.1","depth":2,"next":{"title":"ApiRx","level":"1.2.2","depth":2,"path":"api/classes/_rx_index_.apirx.md","ref":"api/classes/_rx_index_.apirx.md","articles":[]},"previous":{"title":"api","level":"1.2","depth":1,"path":"api/README.md","ref":"api/README.md","articles":[{"title":"ApiPromise","level":"1.2.1","depth":2,"path":"api/classes/_promise_index_.apipromise.md","ref":"api/classes/_promise_index_.apipromise.md","articles":[]},{"title":"ApiRx","level":"1.2.2","depth":2,"path":"api/classes/_rx_index_.apirx.md","ref":"api/classes/_rx_index_.apirx.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"api/classes/_promise_index_.apipromise.md","mtime":"2018-12-07T11:33:15.931Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-07T11:34:45.610Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"ApiPromise","level":"1.2.1","depth":2,"next":{"title":"ApiRx","level":"1.2.2","depth":2,"path":"api/classes/_rx_index_.apirx.md","ref":"api/classes/_rx_index_.apirx.md","articles":[]},"previous":{"title":"api","level":"1.2","depth":1,"path":"api/README.md","ref":"api/README.md","articles":[{"title":"ApiPromise","level":"1.2.1","depth":2,"path":"api/classes/_promise_index_.apipromise.md","ref":"api/classes/_promise_index_.apipromise.md","articles":[]},{"title":"ApiRx","level":"1.2.2","depth":2,"path":"api/classes/_rx_index_.apirx.md","ref":"api/classes/_rx_index_.apirx.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"api/classes/_promise_index_.apipromise.md","mtime":"2018-12-08T14:34:52.752Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-08T14:36:23.372Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/api/classes/_promise_index_.apipromise.md
+12 -12
View File
@@ -106,7 +106,7 @@ ApiPromise.create().then((api) => {
*Overrides [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
*Defined in [promise/index.ts:132](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/promise/index.ts#L132)*
*Defined in [promise/index.ts:132](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/promise/index.ts#L132)*
*__description__*: Creates an instance of the ApiPromise class
@@ -142,7 +142,7 @@ getgenesisHash(): `Hash`
*Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)*
*Defined in [Base.ts:79](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/Base.ts#L79)*
*Defined in [Base.ts:79](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/Base.ts#L79)*
*__description__*: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions.
@@ -157,7 +157,7 @@ gethasSubscriptions(): `boolean`
*Inherited from [ApiBase](_base_.apibase.md).[hasSubscriptions](_base_.apibase.md#hassubscriptions)*
*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/Base.ts#L88)*
*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/Base.ts#L88)*
*__description__*: `true` when subscriptions are supported
@@ -170,7 +170,7 @@ ___
getisReady(): `Promise`<[ApiPromise](_promise_index_.apipromise.md)>
*Defined in [promise/index.ts:167](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/promise/index.ts#L167)*
*Defined in [promise/index.ts:167](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/promise/index.ts#L167)*
*__description__*: Promise that returns the first time we are connected and loaded
@@ -185,7 +185,7 @@ getquery(): [QueryableStorage](../interfaces/_promise_types_.queryablestorage.md
*Inherited from [ApiBase](_base_.apibase.md).[query](_base_.apibase.md#query)*
*Defined in [Base.ts:124](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/Base.ts#L124)*
*Defined in [Base.ts:124](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/Base.ts#L124)*
*__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.
@@ -210,7 +210,7 @@ getrpc(): `Rpc`
*Inherited from [ApiBase](_base_.apibase.md).[rpc](_base_.apibase.md#rpc)*
*Defined in [Base.ts:144](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/Base.ts#L144)*
*Defined in [Base.ts:144](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/Base.ts#L144)*
*__description__*: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic `api.query` and `api.tx` sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime.
@@ -235,7 +235,7 @@ getruntimeMetadata(): `RuntimeMetadata`
*Inherited from [ApiBase](_base_.apibase.md).[runtimeMetadata](_base_.apibase.md#runtimemetadata)*
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/Base.ts#L95)*
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/Base.ts#L95)*
*__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.
@@ -250,7 +250,7 @@ getruntimeVersion(): `RuntimeVersion`
*Inherited from [ApiBase](_base_.apibase.md).[runtimeVersion](_base_.apibase.md#runtimeversion)*
*Defined in [Base.ts:104](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/Base.ts#L104)*
*Defined in [Base.ts:104](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/Base.ts#L104)*
*__description__*: Contains the version information for the current runtime.
@@ -265,7 +265,7 @@ gettx(): [SubmittableExtrinsics](../interfaces/_promise_types_.submittableextrin
*Inherited from [ApiBase](_base_.apibase.md).[tx](_base_.apibase.md#tx)*
*Defined in [Base.ts:163](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/Base.ts#L163)*
*Defined in [Base.ts:163](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/Base.ts#L163)*
*__description__*: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata.
@@ -292,7 +292,7 @@ ___
▸ **combineLatest**(fns: *`Array`<[CombinatorFunction](../modules/_promise_combinator_.md#combinatorfunction)>*, callback: *[CombinatorCallback](../modules/_promise_combinator_.md#combinatorcallback)*): [Combinator](_promise_combinator_.combinator.md)
*Defined in [promise/index.ts:195](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/promise/index.ts#L195)*
*Defined in [promise/index.ts:195](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/promise/index.ts#L195)*
*__description__*: Creates a combinator that can be used to combine the latest results from multiple subscriptions
@@ -329,7 +329,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[on](_base_.apibase.md#on)*
*Defined in [Base.ts:188](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/Base.ts#L188)*
*Defined in [Base.ts:188](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/Base.ts#L188)*
*__description__*: Attach an eventemitter handler to listen to a specific event
@@ -361,7 +361,7 @@ ___
▸ **create**(options?: * [ApiOptions](../interfaces/_types_.apioptions.md) &#124; `ProviderInterface`*): `Promise`<[ApiPromise](_promise_index_.apipromise.md)>
*Defined in [promise/index.ts:130](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/promise/index.ts#L130)*
*Defined in [promise/index.ts:130](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/promise/index.ts#L130)*
*__description__*: Creates an ApiPromise instance using the supplied provider. Returns an Promise containing the actual Api instance.
docs/api/classes/_promise_submittableextrinsic_.submittableextrinsic.md
+24 -24
View File
@@ -25,7 +25,7 @@
*Overrides Extrinsic.__constructor*
*Defined in [promise/SubmittableExtrinsic.ts:12](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/promise/SubmittableExtrinsic.ts#L12)*
*Defined in [promise/SubmittableExtrinsic.ts:12](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/promise/SubmittableExtrinsic.ts#L12)*
**Parameters:**
@@ -73,7 +73,7 @@ getType(): `E`
*Inherited from Struct.Type*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L133)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L127)*
*__description__*: Returns the Type description to sthe structure
@@ -88,7 +88,7 @@ getargs(): `Array`<`Codec`>
*Inherited from Extrinsic.args*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:69](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Extrinsic.ts#L69)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:69](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Extrinsic.ts#L69)*
*__description__*: The arguments passed to for the call, exposes args so it is compatible with \[\[Method\]\]
@@ -103,7 +103,7 @@ getcallIndex(): `Uint8Array`
*Inherited from Extrinsic.callIndex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:76](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Extrinsic.ts#L76)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:76](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Extrinsic.ts#L76)*
*__description__*: The actual `[sectionIndex, methodIndex]` as used in the Method
@@ -118,7 +118,7 @@ getdata(): `Uint8Array`
*Inherited from Extrinsic.data*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:83](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Extrinsic.ts#L83)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:83](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Extrinsic.ts#L83)*
*__description__*: The actual data for the Method
@@ -135,7 +135,7 @@ getencodedLength(): `number`
*Overrides Struct.encodedLength*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:90](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Extrinsic.ts#L90)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:90](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Extrinsic.ts#L90)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -150,7 +150,7 @@ gethash(): `Hash`
*Inherited from Extrinsic.hash*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:99](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Extrinsic.ts#L99)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:99](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Extrinsic.ts#L99)*
*__description__*: Convernience function, encodes the extrinsic and returns the actual hash
@@ -165,7 +165,7 @@ getisSigned(): `boolean`
*Inherited from Extrinsic.isSigned*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:108](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Extrinsic.ts#L108)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:108](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Extrinsic.ts#L108)*
*__description__*: `true` id the extrinsic is signed
@@ -180,7 +180,7 @@ getlength(): `number`
*Inherited from Extrinsic.length*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:115](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Extrinsic.ts#L115)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:115](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Extrinsic.ts#L115)*
*__description__*: The length of the encoded value
@@ -195,7 +195,7 @@ getmeta(): `FunctionMetadata`
*Inherited from Extrinsic.meta*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:122](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Extrinsic.ts#L122)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:122](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Extrinsic.ts#L122)*
*__description__*: The \[\[FunctionMetadata\]\] that describes the extrinsic
@@ -210,7 +210,7 @@ getmethod(): `Method`
*Inherited from Extrinsic.method*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:129](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Extrinsic.ts#L129)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:129](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Extrinsic.ts#L129)*
*__description__*: The \[\[Method\]\] this extrinsic wraps
@@ -225,7 +225,7 @@ getsignature(): `ExtrinsicSignature`
*Inherited from Extrinsic.signature*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:136](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Extrinsic.ts#L136)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:136](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Extrinsic.ts#L136)*
*__description__*: The \[\[ExtrinsicSignature\]\]
@@ -258,7 +258,7 @@ ___
*Inherited from Extrinsic.addSignature*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:143](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Extrinsic.ts#L143)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:143](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Extrinsic.ts#L143)*
*__description__*: Add an \[\[ExtrinsicSignature\]\] to the extrinsic (already generated)
@@ -351,7 +351,7 @@ ___
*Overrides Map.get*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:150](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L150)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:144](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L144)*
*__description__*: Returns a specific names entry in the structure
@@ -372,7 +372,7 @@ ___
*Inherited from Struct.getAtIndex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:157](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L157)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:151](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L151)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
@@ -425,7 +425,7 @@ ___
▸ **send**(statusCb?: * `undefined` &#124; `function`*): `Promise`<`Hash`>
*Defined in [promise/SubmittableExtrinsic.ts:20](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/promise/SubmittableExtrinsic.ts#L20)*
*Defined in [promise/SubmittableExtrinsic.ts:20](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/promise/SubmittableExtrinsic.ts#L20)*
**Parameters:**
@@ -464,7 +464,7 @@ ___
*Overrides Extrinsic.sign*
*Defined in [promise/SubmittableExtrinsic.ts:28](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/promise/SubmittableExtrinsic.ts#L28)*
*Defined in [promise/SubmittableExtrinsic.ts:28](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/promise/SubmittableExtrinsic.ts#L28)*
**Parameters:**
@@ -485,7 +485,7 @@ ___
*Inherited from Struct.toArray*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:164](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L164)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L158)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -502,7 +502,7 @@ ___
*Overrides Struct.toHex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:161](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Extrinsic.ts#L161)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:161](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Extrinsic.ts#L161)*
*__description__*: Returns a hex string representation of the value
@@ -519,7 +519,7 @@ ___
*Overrides Struct.toJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:168](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Extrinsic.ts#L168)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:168](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Extrinsic.ts#L168)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -534,7 +534,7 @@ ___
*Inherited from Struct.toString*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:192](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L192)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:186](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L186)*
*__description__*: Returns the string representation of the value
@@ -551,7 +551,7 @@ ___
*Overrides Struct.toU8a*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:176](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Extrinsic.ts#L176)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:176](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Extrinsic.ts#L176)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -587,7 +587,7 @@ ___
*Inherited from Extrinsic.decodeExtrinsic*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:44](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Extrinsic.ts#L44)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:44](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Extrinsic.ts#L44)*
**Parameters:**
@@ -606,7 +606,7 @@ ___
*Inherited from Struct.with*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L113)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:107](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L107)*
**Type parameters:**
docs/api/classes/_rx_index_.apirx.html
+43 -43
View File
@@ -1122,9 +1122,9 @@
</li>
<li class="chapter " data-level="4.58" data-path="../../types/classes/_metadata_.callmetadata.html">
<li class="chapter " data-level="4.58" data-path="../../types/classes/_metadata_.callmetadata.md">
<a href="../../types/classes/_metadata_.callmetadata.html">
<span>
hidden
@@ -1135,9 +1135,9 @@
</li>
<li class="chapter " data-level="4.59" data-path="../../types/classes/_metadata_.eventmetadata.html">
<li class="chapter " data-level="4.59" data-path="../../types/classes/_metadata_.eventmetadata.md">
<a href="../../types/classes/_metadata_.eventmetadata.html">
<span>
hidden
@@ -1148,9 +1148,9 @@
</li>
<li class="chapter " data-level="4.60" data-path="../../types/classes/_metadata_.functionargumentmetadata.html">
<li class="chapter " data-level="4.60" data-path="../../types/classes/_metadata_.functionargumentmetadata.md">
<a href="../../types/classes/_metadata_.functionargumentmetadata.html">
<span>
hidden
@@ -1161,9 +1161,9 @@
</li>
<li class="chapter " data-level="4.61" data-path="../../types/classes/_metadata_.functionmetadata.html">
<li class="chapter " data-level="4.61" data-path="../../types/classes/_metadata_.functionmetadata.md">
<a href="../../types/classes/_metadata_.functionmetadata.html">
<span>
hidden
@@ -1174,9 +1174,9 @@
</li>
<li class="chapter " data-level="4.62" data-path="../../types/classes/_metadata_.modulemetadata.html">
<li class="chapter " data-level="4.62" data-path="../../types/classes/_metadata_.modulemetadata.md">
<a href="../../types/classes/_metadata_.modulemetadata.html">
<span>
hidden
@@ -1187,9 +1187,9 @@
</li>
<li class="chapter " data-level="4.63" data-path="../../types/classes/_metadata_.outerdispatchcall.html">
<li class="chapter " data-level="4.63" data-path="../../types/classes/_metadata_.outerdispatchcall.md">
<a href="../../types/classes/_metadata_.outerdispatchcall.html">
<span>
hidden
@@ -1200,9 +1200,9 @@
</li>
<li class="chapter " data-level="4.64" data-path="../../types/classes/_metadata_.outerdispatchmetadata.html">
<li class="chapter " data-level="4.64" data-path="../../types/classes/_metadata_.outerdispatchmetadata.md">
<a href="../../types/classes/_metadata_.outerdispatchmetadata.html">
<span>
hidden
@@ -1213,9 +1213,9 @@
</li>
<li class="chapter " data-level="4.65" data-path="../../types/classes/_metadata_.outereventmetadata.html">
<li class="chapter " data-level="4.65" data-path="../../types/classes/_metadata_.outereventmetadata.md">
<a href="../../types/classes/_metadata_.outereventmetadata.html">
<span>
hidden
@@ -1226,9 +1226,9 @@
</li>
<li class="chapter " data-level="4.66" data-path="../../types/classes/_metadata_.outereventmetadataevent.html">
<li class="chapter " data-level="4.66" data-path="../../types/classes/_metadata_.outereventmetadataevent.md">
<a href="../../types/classes/_metadata_.outereventmetadataevent.html">
<span>
hidden
@@ -1252,9 +1252,9 @@
</li>
<li class="chapter " data-level="4.68" data-path="../../types/classes/_metadata_.runtimemodulemetadata.html">
<li class="chapter " data-level="4.68" data-path="../../types/classes/_metadata_.runtimemodulemetadata.md">
<a href="../../types/classes/_metadata_.runtimemodulemetadata.html">
<span>
hidden
@@ -1265,9 +1265,9 @@
</li>
<li class="chapter " data-level="4.69" data-path="../../types/classes/_metadata_.storagefunctionmetadata.html">
<li class="chapter " data-level="4.69" data-path="../../types/classes/_metadata_.storagefunctionmetadata.md">
<a href="../../types/classes/_metadata_.storagefunctionmetadata.html">
<span>
hidden
@@ -1278,9 +1278,9 @@
</li>
<li class="chapter " data-level="4.70" data-path="../../types/classes/_metadata_.storagefunctionmodifier.html">
<li class="chapter " data-level="4.70" data-path="../../types/classes/_metadata_.storagefunctionmodifier.md">
<a href="../../types/classes/_metadata_.storagefunctionmodifier.html">
<span>
hidden
@@ -1291,9 +1291,9 @@
</li>
<li class="chapter " data-level="4.71" data-path="../../types/classes/_metadata_.storagefunctiontype.html">
<li class="chapter " data-level="4.71" data-path="../../types/classes/_metadata_.storagefunctiontype.md">
<a href="../../types/classes/_metadata_.storagefunctiontype.html">
<span>
hidden
@@ -1304,9 +1304,9 @@
</li>
<li class="chapter " data-level="4.72" data-path="../../types/classes/_metadata_.storagefunctiontype_map.html">
<li class="chapter " data-level="4.72" data-path="../../types/classes/_metadata_.storagefunctiontype_map.md">
<a href="../../types/classes/_metadata_.storagefunctiontype_map.html">
<span>
hidden
@@ -1317,9 +1317,9 @@
</li>
<li class="chapter " data-level="4.73" data-path="../../types/classes/_metadata_.storagemetadata.html">
<li class="chapter " data-level="4.73" data-path="../../types/classes/_metadata_.storagemetadata.md">
<a href="../../types/classes/_metadata_.storagemetadata.html">
<span>
hidden
@@ -2047,7 +2047,7 @@
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new ApiRx</strong>(options?: <em> <a href="../interfaces/_types_.apioptions.md">ApiOptions</a> | <code>ProviderInterface</code></em>): <a href="_rx_index_.apirx.html">ApiRx</a></p>
<p><em>Overrides <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#constructor">constructor</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/rx/index.ts#L144" target="_blank">rx/index.ts:144</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/api/src/rx/index.ts#L144" target="_blank">rx/index.ts:144</a></em></p>
<p><em><strong>description</strong></em>: Create an instance of the ApiRx class</p>
<p><em><strong>example</strong></em>: </p>
<pre><code class="lang-javascript"><div class="sunlight-container sunlight-theme-gitbook"><div class="sunlight-code-container"><pre class="sunlight-highlight-javascript sunlight-highlighted"><span class="sunlight-javascript"><span class="sunlight-reservedWord">import</span>&#xA0;<span class="sunlight-ident">Api</span>&#xA0;<span class="sunlight-ident">from</span>&#xA0;<span class="sunlight-string">&apos;@polkadot/api/rx&apos;</span><span class="sunlight-punctuation">;</span>
@@ -2082,7 +2082,7 @@
<h2 id="genesishash">genesisHash</h2>
<p>getgenesisHash(): <code>Hash</code></p>
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#genesishash">genesisHash</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/Base.ts#L79" target="_blank">Base.ts:79</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/api/src/Base.ts#L79" target="_blank">Base.ts:79</a></em></p>
<p><em><strong>description</strong></em>: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions.</p>
<p><strong>Returns:</strong> <code>Hash</code></p>
<hr>
@@ -2090,21 +2090,21 @@
<h2 id="hassubscriptions">hasSubscriptions</h2>
<p>gethasSubscriptions(): <code>boolean</code></p>
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#hassubscriptions">hasSubscriptions</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/Base.ts#L88" target="_blank">Base.ts:88</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/api/src/Base.ts#L88" target="_blank">Base.ts:88</a></em></p>
<p><em><strong>description</strong></em>: <code>true</code> when subscriptions are supported</p>
<p><strong>Returns:</strong> <code>boolean</code></p>
<hr>
<p><a id="isconnected"></a></p>
<h2 id="isconnected">isConnected</h2>
<p>getisConnected(): <code>Observable</code>&lt;<code>boolean</code>&gt;</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/rx/index.ts#L182" target="_blank">rx/index.ts:182</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/api/src/rx/index.ts#L182" target="_blank">rx/index.ts:182</a></em></p>
<p><em><strong>description</strong></em>: Observable that carries the connected state for the provider. Results in a boolean flag that is true/false based on the connectivity.</p>
<p><strong>Returns:</strong> <code>Observable</code>&lt;<code>boolean</code>&gt;</p>
<hr>
<p><a id="isready"></a></p>
<h2 id="isready">isReady</h2>
<p>getisReady(): <code>Observable</code>&lt;<a href="_rx_index_.apirx.html">ApiRx</a>&gt;</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/rx/index.ts#L189" target="_blank">rx/index.ts:189</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/api/src/rx/index.ts#L189" target="_blank">rx/index.ts:189</a></em></p>
<p><em><strong>description</strong></em>: Observable that returns the first time we are connected and loaded</p>
<p><strong>Returns:</strong> <code>Observable</code>&lt;<a href="_rx_index_.apirx.html">ApiRx</a>&gt;</p>
<hr>
@@ -2112,7 +2112,7 @@
<h2 id="query">query</h2>
<p>getquery(): <a href="../interfaces/_rx_types_.queryablestorage.md">QueryableStorage</a></p>
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#query">query</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/Base.ts#L124" target="_blank">Base.ts:124</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/api/src/Base.ts#L124" target="_blank">Base.ts:124</a></em></p>
<p><em><strong>description</strong></em>: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.</p>
<p>All calls inside the namespace, is denoted by <code>section</code>.<code>method</code> and may take an optional query parameter. As an example, <code>api.query.timestamp.now()</code> (current block timestamp) does not take parameters, while <code>api.query.system.accountNonce(&lt;accountId&gt;)</code> (retrieving the associated nonce for an account), takes the <code>AccountId</code> as a parameter.</p>
<p><em><strong>example</strong></em>: </p>
@@ -2126,7 +2126,7 @@
<h2 id="rpc">rpc</h2>
<p>getrpc(): <code>RpcRx</code></p>
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#rpc">rpc</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/Base.ts#L144" target="_blank">Base.ts:144</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/api/src/Base.ts#L144" target="_blank">Base.ts:144</a></em></p>
<p><em><strong>description</strong></em>: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic <code>api.query</code> and <code>api.tx</code> sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime.</p>
<p>RPC endpoints available here allow for the query of chain, node and system information, in addition to providing interfaces for the raw queries of state (usine known keys) and the submission of transactions.</p>
<p><em><strong>example</strong></em>: </p>
@@ -2140,7 +2140,7 @@
<h2 id="runtimemetadata">runtimeMetadata</h2>
<p>getruntimeMetadata(): <code>RuntimeMetadata</code></p>
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#runtimemetadata">runtimeMetadata</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/Base.ts#L95" target="_blank">Base.ts:95</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/api/src/Base.ts#L95" target="_blank">Base.ts:95</a></em></p>
<p><em><strong>description</strong></em>: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics &amp; storage, but is useful for current runtime inspection.</p>
<p><strong>Returns:</strong> <code>RuntimeMetadata</code></p>
<hr>
@@ -2148,7 +2148,7 @@
<h2 id="runtimeversion">runtimeVersion</h2>
<p>getruntimeVersion(): <code>RuntimeVersion</code></p>
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#runtimeversion">runtimeVersion</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/Base.ts#L104" target="_blank">Base.ts:104</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/api/src/Base.ts#L104" target="_blank">Base.ts:104</a></em></p>
<p><em><strong>description</strong></em>: Contains the version information for the current runtime.</p>
<p><strong>Returns:</strong> <code>RuntimeVersion</code></p>
<hr>
@@ -2156,7 +2156,7 @@
<h2 id="tx">tx</h2>
<p>gettx(): <a href="../interfaces/_rx_types_.submittableextrinsics.md">SubmittableExtrinsics</a></p>
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#tx">tx</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/Base.ts#L163" target="_blank">Base.ts:163</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/api/src/Base.ts#L163" target="_blank">Base.ts:163</a></em></p>
<p><em><strong>description</strong></em>: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata.</p>
<p><em><strong>example</strong></em>: </p>
<pre><code class="lang-javascript"><div class="sunlight-container sunlight-theme-gitbook"><div class="sunlight-code-container"><pre class="sunlight-highlight-javascript sunlight-highlighted"><span class="sunlight-javascript"><span class="sunlight-ident">api</span><span class="sunlight-operator">.</span><span class="sunlight-ident">tx</span><span class="sunlight-operator">.</span><span class="sunlight-ident">balances</span>
@@ -2173,7 +2173,7 @@
<h2 id="on">on</h2>
<p>&#x25B8; <strong>on</strong>(type: <em><a href="../modules/_types_.md#apiinterface_events">ApiInterface$Events</a></em>, handler: <em><code>function</code></em>): <code>void</code></p>
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#on">on</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/Base.ts#L188" target="_blank">Base.ts:188</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/api/src/Base.ts#L188" target="_blank">Base.ts:188</a></em></p>
<p><em><strong>description</strong></em>: Attach an eventemitter handler to listen to a specific event</p>
<p><em><strong>example</strong></em>: </p>
<pre><code class="lang-javascript"><div class="sunlight-container sunlight-theme-gitbook"><div class="sunlight-code-container"><pre class="sunlight-highlight-javascript sunlight-highlighted"><span class="sunlight-javascript"><span class="sunlight-ident">api</span><span class="sunlight-operator">.</span><span class="sunlight-ident">on</span><span class="sunlight-punctuation">(</span><span class="sunlight-string">&apos;disconnected&apos;</span><span class="sunlight-punctuation">,</span>&#xA0;<span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">)</span>&#xA0;<span class="sunlight-operator">=</span><span class="sunlight-operator">&gt;</span>&#xA0;<span class="sunlight-punctuation">{</span>
@@ -2211,7 +2211,7 @@
<p><a id="create"></a></p>
<h2 id="static-create"><code>&lt;Static&gt;</code> create</h2>
<p>&#x25B8; <strong>create</strong>(options?: <em> <a href="../interfaces/_types_.apioptions.md">ApiOptions</a> | <code>ProviderInterface</code></em>): <code>Observable</code>&lt;<a href="_rx_index_.apirx.html">ApiRx</a>&gt;</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/rx/index.ts#L142" target="_blank">rx/index.ts:142</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/api/src/rx/index.ts#L142" target="_blank">rx/index.ts:142</a></em></p>
<p><em><strong>description</strong></em>: Creates an ApiRx instance using the supplied provider. Returns an Observable containing the actual Api instance.</p>
<p><em><strong>example</strong></em>: </p>
<pre><code class="lang-javascript"><div class="sunlight-container sunlight-theme-gitbook"><div class="sunlight-code-container"><pre class="sunlight-highlight-javascript sunlight-highlighted"><span class="sunlight-javascript"><span class="sunlight-reservedWord">import</span>&#xA0;<span class="sunlight-ident">Api</span>&#xA0;<span class="sunlight-ident">from</span>&#xA0;<span class="sunlight-string">&apos;@polkadot/api/rx&apos;</span><span class="sunlight-punctuation">;</span>
@@ -2284,7 +2284,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"ApiRx","level":"1.2.2","depth":2,"next":{"title":"rpc-provider","level":"1.3","depth":1,"path":"rpc-provider/README.md","ref":"rpc-provider/README.md","articles":[{"title":"HttpProvider","level":"1.3.1","depth":2,"path":"rpc-provider/classes/_http_index_.httpprovider.md","ref":"rpc-provider/classes/_http_index_.httpprovider.md","articles":[]},{"title":"WsProvider","level":"1.3.2","depth":2,"path":"rpc-provider/classes/_ws_index_.wsprovider.md","ref":"rpc-provider/classes/_ws_index_.wsprovider.md","articles":[]}]},"previous":{"title":"ApiPromise","level":"1.2.1","depth":2,"path":"api/classes/_promise_index_.apipromise.md","ref":"api/classes/_promise_index_.apipromise.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"api/classes/_rx_index_.apirx.md","mtime":"2018-12-07T11:33:16.119Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-07T11:34:45.610Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"ApiRx","level":"1.2.2","depth":2,"next":{"title":"rpc-provider","level":"1.3","depth":1,"path":"rpc-provider/README.md","ref":"rpc-provider/README.md","articles":[{"title":"HttpProvider","level":"1.3.1","depth":2,"path":"rpc-provider/classes/_http_index_.httpprovider.md","ref":"rpc-provider/classes/_http_index_.httpprovider.md","articles":[]},{"title":"WsProvider","level":"1.3.2","depth":2,"path":"rpc-provider/classes/_ws_index_.wsprovider.md","ref":"rpc-provider/classes/_ws_index_.wsprovider.md","articles":[]}]},"previous":{"title":"ApiPromise","level":"1.2.1","depth":2,"path":"api/classes/_promise_index_.apipromise.md","ref":"api/classes/_promise_index_.apipromise.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"api/classes/_rx_index_.apirx.md","mtime":"2018-12-08T14:34:52.939Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-08T14:36:23.372Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/api/classes/_rx_index_.apirx.md
+12 -12
View File
@@ -117,7 +117,7 @@ api.query.system
*Overrides [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
*Defined in [rx/index.ts:144](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/rx/index.ts#L144)*
*Defined in [rx/index.ts:144](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/rx/index.ts#L144)*
*__description__*: Create an instance of the ApiRx class
@@ -153,7 +153,7 @@ getgenesisHash(): `Hash`
*Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)*
*Defined in [Base.ts:79](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/Base.ts#L79)*
*Defined in [Base.ts:79](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/Base.ts#L79)*
*__description__*: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions.
@@ -168,7 +168,7 @@ gethasSubscriptions(): `boolean`
*Inherited from [ApiBase](_base_.apibase.md).[hasSubscriptions](_base_.apibase.md#hassubscriptions)*
*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/Base.ts#L88)*
*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/Base.ts#L88)*
*__description__*: `true` when subscriptions are supported
@@ -181,7 +181,7 @@ ___
getisConnected(): `Observable`<`boolean`>
*Defined in [rx/index.ts:182](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/rx/index.ts#L182)*
*Defined in [rx/index.ts:182](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/rx/index.ts#L182)*
*__description__*: Observable that carries the connected state for the provider. Results in a boolean flag that is true/false based on the connectivity.
@@ -194,7 +194,7 @@ ___
getisReady(): `Observable`<[ApiRx](_rx_index_.apirx.md)>
*Defined in [rx/index.ts:189](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/rx/index.ts#L189)*
*Defined in [rx/index.ts:189](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/rx/index.ts#L189)*
*__description__*: Observable that returns the first time we are connected and loaded
@@ -209,7 +209,7 @@ getquery(): [QueryableStorage](../interfaces/_rx_types_.queryablestorage.md)
*Inherited from [ApiBase](_base_.apibase.md).[query](_base_.apibase.md#query)*
*Defined in [Base.ts:124](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/Base.ts#L124)*
*Defined in [Base.ts:124](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/Base.ts#L124)*
*__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.
@@ -234,7 +234,7 @@ getrpc(): `RpcRx`
*Inherited from [ApiBase](_base_.apibase.md).[rpc](_base_.apibase.md#rpc)*
*Defined in [Base.ts:144](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/Base.ts#L144)*
*Defined in [Base.ts:144](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/Base.ts#L144)*
*__description__*: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic `api.query` and `api.tx` sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime.
@@ -259,7 +259,7 @@ getruntimeMetadata(): `RuntimeMetadata`
*Inherited from [ApiBase](_base_.apibase.md).[runtimeMetadata](_base_.apibase.md#runtimemetadata)*
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/Base.ts#L95)*
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/Base.ts#L95)*
*__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.
@@ -274,7 +274,7 @@ getruntimeVersion(): `RuntimeVersion`
*Inherited from [ApiBase](_base_.apibase.md).[runtimeVersion](_base_.apibase.md#runtimeversion)*
*Defined in [Base.ts:104](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/Base.ts#L104)*
*Defined in [Base.ts:104](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/Base.ts#L104)*
*__description__*: Contains the version information for the current runtime.
@@ -289,7 +289,7 @@ gettx(): [SubmittableExtrinsics](../interfaces/_rx_types_.submittableextrinsics.
*Inherited from [ApiBase](_base_.apibase.md).[tx](_base_.apibase.md#tx)*
*Defined in [Base.ts:163](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/Base.ts#L163)*
*Defined in [Base.ts:163](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/Base.ts#L163)*
*__description__*: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata.
@@ -318,7 +318,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[on](_base_.apibase.md#on)*
*Defined in [Base.ts:188](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/Base.ts#L188)*
*Defined in [Base.ts:188](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/Base.ts#L188)*
*__description__*: Attach an eventemitter handler to listen to a specific event
@@ -350,7 +350,7 @@ ___
▸ **create**(options?: * [ApiOptions](../interfaces/_types_.apioptions.md) &#124; `ProviderInterface`*): `Observable`<[ApiRx](_rx_index_.apirx.md)>
*Defined in [rx/index.ts:142](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/rx/index.ts#L142)*
*Defined in [rx/index.ts:142](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/rx/index.ts#L142)*
*__description__*: Creates an ApiRx instance using the supplied provider. Returns an Observable containing the actual Api instance.
docs/api/classes/_rx_submittableextrinsic_.submittableextrinsic.md
+24 -24
View File
@@ -25,7 +25,7 @@
*Overrides Extrinsic.__constructor*
*Defined in [rx/SubmittableExtrinsic.ts:13](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/rx/SubmittableExtrinsic.ts#L13)*
*Defined in [rx/SubmittableExtrinsic.ts:13](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/rx/SubmittableExtrinsic.ts#L13)*
**Parameters:**
@@ -73,7 +73,7 @@ getType(): `E`
*Inherited from Struct.Type*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L133)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L127)*
*__description__*: Returns the Type description to sthe structure
@@ -88,7 +88,7 @@ getargs(): `Array`<`Codec`>
*Inherited from Extrinsic.args*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:69](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Extrinsic.ts#L69)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:69](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Extrinsic.ts#L69)*
*__description__*: The arguments passed to for the call, exposes args so it is compatible with \[\[Method\]\]
@@ -103,7 +103,7 @@ getcallIndex(): `Uint8Array`
*Inherited from Extrinsic.callIndex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:76](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Extrinsic.ts#L76)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:76](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Extrinsic.ts#L76)*
*__description__*: The actual `[sectionIndex, methodIndex]` as used in the Method
@@ -118,7 +118,7 @@ getdata(): `Uint8Array`
*Inherited from Extrinsic.data*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:83](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Extrinsic.ts#L83)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:83](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Extrinsic.ts#L83)*
*__description__*: The actual data for the Method
@@ -135,7 +135,7 @@ getencodedLength(): `number`
*Overrides Struct.encodedLength*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:90](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Extrinsic.ts#L90)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:90](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Extrinsic.ts#L90)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -150,7 +150,7 @@ gethash(): `Hash`
*Inherited from Extrinsic.hash*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:99](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Extrinsic.ts#L99)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:99](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Extrinsic.ts#L99)*
*__description__*: Convernience function, encodes the extrinsic and returns the actual hash
@@ -165,7 +165,7 @@ getisSigned(): `boolean`
*Inherited from Extrinsic.isSigned*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:108](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Extrinsic.ts#L108)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:108](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Extrinsic.ts#L108)*
*__description__*: `true` id the extrinsic is signed
@@ -180,7 +180,7 @@ getlength(): `number`
*Inherited from Extrinsic.length*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:115](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Extrinsic.ts#L115)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:115](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Extrinsic.ts#L115)*
*__description__*: The length of the encoded value
@@ -195,7 +195,7 @@ getmeta(): `FunctionMetadata`
*Inherited from Extrinsic.meta*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:122](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Extrinsic.ts#L122)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:122](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Extrinsic.ts#L122)*
*__description__*: The \[\[FunctionMetadata\]\] that describes the extrinsic
@@ -210,7 +210,7 @@ getmethod(): `Method`
*Inherited from Extrinsic.method*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:129](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Extrinsic.ts#L129)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:129](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Extrinsic.ts#L129)*
*__description__*: The \[\[Method\]\] this extrinsic wraps
@@ -225,7 +225,7 @@ getsignature(): `ExtrinsicSignature`
*Inherited from Extrinsic.signature*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:136](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Extrinsic.ts#L136)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:136](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Extrinsic.ts#L136)*
*__description__*: The \[\[ExtrinsicSignature\]\]
@@ -258,7 +258,7 @@ ___
*Inherited from Extrinsic.addSignature*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:143](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Extrinsic.ts#L143)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:143](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Extrinsic.ts#L143)*
*__description__*: Add an \[\[ExtrinsicSignature\]\] to the extrinsic (already generated)
@@ -351,7 +351,7 @@ ___
*Overrides Map.get*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:150](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L150)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:144](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L144)*
*__description__*: Returns a specific names entry in the structure
@@ -372,7 +372,7 @@ ___
*Inherited from Struct.getAtIndex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:157](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L157)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:151](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L151)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
@@ -425,7 +425,7 @@ ___
▸ **send**(): `Observable`<`ExtrinsicStatus`>
*Defined in [rx/SubmittableExtrinsic.ts:21](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/rx/SubmittableExtrinsic.ts#L21)*
*Defined in [rx/SubmittableExtrinsic.ts:21](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/rx/SubmittableExtrinsic.ts#L21)*
**Returns:** `Observable`<`ExtrinsicStatus`>
@@ -458,7 +458,7 @@ ___
*Overrides Extrinsic.sign*
*Defined in [rx/SubmittableExtrinsic.ts:25](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/rx/SubmittableExtrinsic.ts#L25)*
*Defined in [rx/SubmittableExtrinsic.ts:25](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/rx/SubmittableExtrinsic.ts#L25)*
**Parameters:**
@@ -479,7 +479,7 @@ ___
*Inherited from Struct.toArray*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:164](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L164)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L158)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -496,7 +496,7 @@ ___
*Overrides Struct.toHex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:161](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Extrinsic.ts#L161)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:161](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Extrinsic.ts#L161)*
*__description__*: Returns a hex string representation of the value
@@ -513,7 +513,7 @@ ___
*Overrides Struct.toJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:168](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Extrinsic.ts#L168)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:168](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Extrinsic.ts#L168)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -528,7 +528,7 @@ ___
*Inherited from Struct.toString*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:192](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L192)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:186](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L186)*
*__description__*: Returns the string representation of the value
@@ -545,7 +545,7 @@ ___
*Overrides Struct.toU8a*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:176](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Extrinsic.ts#L176)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:176](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Extrinsic.ts#L176)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -581,7 +581,7 @@ ___
*Inherited from Extrinsic.decodeExtrinsic*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:44](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Extrinsic.ts#L44)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:44](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Extrinsic.ts#L44)*
**Parameters:**
@@ -600,7 +600,7 @@ ___
*Inherited from Struct.with*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L113)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:107](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L107)*
**Type parameters:**
docs/api/index.html
+31 -31
View File
@@ -1122,9 +1122,9 @@
</li>
<li class="chapter " data-level="4.58" data-path="../types/classes/_metadata_.callmetadata.html">
<li class="chapter " data-level="4.58" data-path="../types/classes/_metadata_.callmetadata.md">
<a href="../types/classes/_metadata_.callmetadata.html">
<span>
hidden
@@ -1135,9 +1135,9 @@
</li>
<li class="chapter " data-level="4.59" data-path="../types/classes/_metadata_.eventmetadata.html">
<li class="chapter " data-level="4.59" data-path="../types/classes/_metadata_.eventmetadata.md">
<a href="../types/classes/_metadata_.eventmetadata.html">
<span>
hidden
@@ -1148,9 +1148,9 @@
</li>
<li class="chapter " data-level="4.60" data-path="../types/classes/_metadata_.functionargumentmetadata.html">
<li class="chapter " data-level="4.60" data-path="../types/classes/_metadata_.functionargumentmetadata.md">
<a href="../types/classes/_metadata_.functionargumentmetadata.html">
<span>
hidden
@@ -1161,9 +1161,9 @@
</li>
<li class="chapter " data-level="4.61" data-path="../types/classes/_metadata_.functionmetadata.html">
<li class="chapter " data-level="4.61" data-path="../types/classes/_metadata_.functionmetadata.md">
<a href="../types/classes/_metadata_.functionmetadata.html">
<span>
hidden
@@ -1174,9 +1174,9 @@
</li>
<li class="chapter " data-level="4.62" data-path="../types/classes/_metadata_.modulemetadata.html">
<li class="chapter " data-level="4.62" data-path="../types/classes/_metadata_.modulemetadata.md">
<a href="../types/classes/_metadata_.modulemetadata.html">
<span>
hidden
@@ -1187,9 +1187,9 @@
</li>
<li class="chapter " data-level="4.63" data-path="../types/classes/_metadata_.outerdispatchcall.html">
<li class="chapter " data-level="4.63" data-path="../types/classes/_metadata_.outerdispatchcall.md">
<a href="../types/classes/_metadata_.outerdispatchcall.html">
<span>
hidden
@@ -1200,9 +1200,9 @@
</li>
<li class="chapter " data-level="4.64" data-path="../types/classes/_metadata_.outerdispatchmetadata.html">
<li class="chapter " data-level="4.64" data-path="../types/classes/_metadata_.outerdispatchmetadata.md">
<a href="../types/classes/_metadata_.outerdispatchmetadata.html">
<span>
hidden
@@ -1213,9 +1213,9 @@
</li>
<li class="chapter " data-level="4.65" data-path="../types/classes/_metadata_.outereventmetadata.html">
<li class="chapter " data-level="4.65" data-path="../types/classes/_metadata_.outereventmetadata.md">
<a href="../types/classes/_metadata_.outereventmetadata.html">
<span>
hidden
@@ -1226,9 +1226,9 @@
</li>
<li class="chapter " data-level="4.66" data-path="../types/classes/_metadata_.outereventmetadataevent.html">
<li class="chapter " data-level="4.66" data-path="../types/classes/_metadata_.outereventmetadataevent.md">
<a href="../types/classes/_metadata_.outereventmetadataevent.html">
<span>
hidden
@@ -1252,9 +1252,9 @@
</li>
<li class="chapter " data-level="4.68" data-path="../types/classes/_metadata_.runtimemodulemetadata.html">
<li class="chapter " data-level="4.68" data-path="../types/classes/_metadata_.runtimemodulemetadata.md">
<a href="../types/classes/_metadata_.runtimemodulemetadata.html">
<span>
hidden
@@ -1265,9 +1265,9 @@
</li>
<li class="chapter " data-level="4.69" data-path="../types/classes/_metadata_.storagefunctionmetadata.html">
<li class="chapter " data-level="4.69" data-path="../types/classes/_metadata_.storagefunctionmetadata.md">
<a href="../types/classes/_metadata_.storagefunctionmetadata.html">
<span>
hidden
@@ -1278,9 +1278,9 @@
</li>
<li class="chapter " data-level="4.70" data-path="../types/classes/_metadata_.storagefunctionmodifier.html">
<li class="chapter " data-level="4.70" data-path="../types/classes/_metadata_.storagefunctionmodifier.md">
<a href="../types/classes/_metadata_.storagefunctionmodifier.html">
<span>
hidden
@@ -1291,9 +1291,9 @@
</li>
<li class="chapter " data-level="4.71" data-path="../types/classes/_metadata_.storagefunctiontype.html">
<li class="chapter " data-level="4.71" data-path="../types/classes/_metadata_.storagefunctiontype.md">
<a href="../types/classes/_metadata_.storagefunctiontype.html">
<span>
hidden
@@ -1304,9 +1304,9 @@
</li>
<li class="chapter " data-level="4.72" data-path="../types/classes/_metadata_.storagefunctiontype_map.html">
<li class="chapter " data-level="4.72" data-path="../types/classes/_metadata_.storagefunctiontype_map.md">
<a href="../types/classes/_metadata_.storagefunctiontype_map.html">
<span>
hidden
@@ -1317,9 +1317,9 @@
</li>
<li class="chapter " data-level="4.73" data-path="../types/classes/_metadata_.storagemetadata.html">
<li class="chapter " data-level="4.73" data-path="../types/classes/_metadata_.storagemetadata.md">
<a href="../types/classes/_metadata_.storagemetadata.html">
<span>
hidden
@@ -2062,7 +2062,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"api","level":"1.2","depth":1,"next":{"title":"ApiPromise","level":"1.2.1","depth":2,"path":"api/classes/_promise_index_.apipromise.md","ref":"api/classes/_promise_index_.apipromise.md","articles":[]},"previous":{"title":"Introduction","level":"1.1","depth":1,"path":"README.md","ref":"README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"api/README.md","mtime":"2018-12-07T11:33:15.535Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-07T11:34:45.610Z"},"basePath":"..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"api","level":"1.2","depth":1,"next":{"title":"ApiPromise","level":"1.2.1","depth":2,"path":"api/classes/_promise_index_.apipromise.md","ref":"api/classes/_promise_index_.apipromise.md","articles":[]},"previous":{"title":"Introduction","level":"1.1","depth":1,"path":"README.md","ref":"README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"api/README.md","mtime":"2018-12-08T14:34:52.308Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-08T14:36:23.372Z"},"basePath":"..","book":{"language":""}});
});
</script>
</div>
docs/api/interfaces/_promise_types_.apipromiseinterface.md
+9 -9
View File
@@ -20,7 +20,7 @@
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[genesisHash](_types_.apibaseinterface.md#genesishash)*
*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/types.ts#L13)*
*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/types.ts#L13)*
___
<a id="hassubscriptions"></a>
@@ -31,7 +31,7 @@ ___
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[hasSubscriptions](_types_.apibaseinterface.md#hassubscriptions)*
*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/types.ts#L14)*
*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/types.ts#L14)*
___
<a id="isready"></a>
@@ -40,7 +40,7 @@ ___
**● isReady**: *`Promise`<[ApiPromiseInterface](_promise_types_.apipromiseinterface.md)>*
*Defined in [promise/types.ts:39](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/promise/types.ts#L39)*
*Defined in [promise/types.ts:39](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/promise/types.ts#L39)*
___
<a id="on"></a>
@@ -51,7 +51,7 @@ ___
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[on](_types_.apibaseinterface.md#on)*
*Defined in [types.ts:21](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/types.ts#L21)*
*Defined in [types.ts:21](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/types.ts#L21)*
#### Type declaration
▸(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `void`
@@ -74,7 +74,7 @@ ___
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[query](_types_.apibaseinterface.md#query)*
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/types.ts#L17)*
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/types.ts#L17)*
___
<a id="rpc"></a>
@@ -85,7 +85,7 @@ ___
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[rpc](_types_.apibaseinterface.md#rpc)*
*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/types.ts#L18)*
*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/types.ts#L18)*
___
<a id="runtimemetadata"></a>
@@ -96,7 +96,7 @@ ___
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[runtimeMetadata](_types_.apibaseinterface.md#runtimemetadata)*
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/types.ts#L15)*
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/types.ts#L15)*
___
<a id="runtimeversion"></a>
@@ -107,7 +107,7 @@ ___
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[runtimeVersion](_types_.apibaseinterface.md#runtimeversion)*
*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/types.ts#L16)*
*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/types.ts#L16)*
___
<a id="tx"></a>
@@ -118,7 +118,7 @@ ___
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[tx](_types_.apibaseinterface.md#tx)*
*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/types.ts#L19)*
*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/types.ts#L19)*
___
docs/api/interfaces/_promise_types_.queryablestoragefunction.md
+6 -6
View File
@@ -11,7 +11,7 @@
▸ **__call**(arg?: *`any`*): `Uint8Array`
*Defined in [promise/types.ts:14](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/promise/types.ts#L14)*
*Defined in [promise/types.ts:14](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/promise/types.ts#L14)*
**Parameters:**
@@ -21,7 +21,7 @@
**Returns:** `Promise`< `Codec` &#124; `null` &#124; `undefined`>
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:12](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/StorageKey.ts#L12)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:12](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/StorageKey.ts#L12)*
**Parameters:**
@@ -41,7 +41,7 @@
*Inherited from StorageFunction.meta*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:14](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/StorageKey.ts#L14)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:14](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/StorageKey.ts#L14)*
___
<a id="method"></a>
@@ -52,7 +52,7 @@ ___
*Inherited from StorageFunction.method*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:15](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/StorageKey.ts#L15)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:15](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/StorageKey.ts#L15)*
___
<a id="section"></a>
@@ -63,7 +63,7 @@ ___
*Inherited from StorageFunction.section*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:16](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/StorageKey.ts#L16)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:16](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/StorageKey.ts#L16)*
___
<a id="tojson"></a>
@@ -74,7 +74,7 @@ ___
*Inherited from StorageFunction.toJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:17](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/StorageKey.ts#L17)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:17](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/StorageKey.ts#L17)*
#### Type declaration
▸(): `any`
docs/api/interfaces/_promise_types_.submittableextrinsicfunction.md
+7 -7
View File
@@ -11,7 +11,7 @@
▸ **__call**(...args: *`any`[]*): `Extrinsic`
*Defined in [promise/types.ts:26](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/promise/types.ts#L26)*
*Defined in [promise/types.ts:26](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/promise/types.ts#L26)*
**Parameters:**
@@ -21,7 +21,7 @@
**Returns:** [SubmittableExtrinsic](../classes/_promise_submittableextrinsic_.submittableextrinsic.md)
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:34](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Method.ts#L34)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:34](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Method.ts#L34)*
**Parameters:**
@@ -41,7 +41,7 @@
*Inherited from ExtrinsicFunction.callIndex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:36](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Method.ts#L36)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:36](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Method.ts#L36)*
___
<a id="meta"></a>
@@ -52,7 +52,7 @@ ___
*Inherited from ExtrinsicFunction.meta*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:37](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Method.ts#L37)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:37](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Method.ts#L37)*
___
<a id="method"></a>
@@ -63,7 +63,7 @@ ___
*Inherited from ExtrinsicFunction.method*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:38](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Method.ts#L38)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:38](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Method.ts#L38)*
___
<a id="section"></a>
@@ -74,7 +74,7 @@ ___
*Inherited from ExtrinsicFunction.section*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:39](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Method.ts#L39)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:39](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Method.ts#L39)*
___
<a id="tojson"></a>
@@ -85,7 +85,7 @@ ___
*Inherited from ExtrinsicFunction.toJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:40](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Method.ts#L40)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:40](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Method.ts#L40)*
#### Type declaration
▸(): `any`
docs/api/interfaces/_rx_types_.apirxinterface.md
+10 -10
View File
@@ -20,7 +20,7 @@
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[genesisHash](_types_.apibaseinterface.md#genesishash)*
*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/types.ts#L13)*
*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/types.ts#L13)*
___
<a id="hassubscriptions"></a>
@@ -31,7 +31,7 @@ ___
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[hasSubscriptions](_types_.apibaseinterface.md#hassubscriptions)*
*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/types.ts#L14)*
*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/types.ts#L14)*
___
<a id="isconnected"></a>
@@ -40,7 +40,7 @@ ___
**● isConnected**: *`Observable`<`boolean`>*
*Defined in [rx/types.ts:40](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/rx/types.ts#L40)*
*Defined in [rx/types.ts:40](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/rx/types.ts#L40)*
___
<a id="isready"></a>
@@ -49,7 +49,7 @@ ___
**● isReady**: *`Observable`<[ApiRxInterface](_rx_types_.apirxinterface.md)>*
*Defined in [rx/types.ts:41](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/rx/types.ts#L41)*
*Defined in [rx/types.ts:41](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/rx/types.ts#L41)*
___
<a id="on"></a>
@@ -60,7 +60,7 @@ ___
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[on](_types_.apibaseinterface.md#on)*
*Defined in [types.ts:21](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/types.ts#L21)*
*Defined in [types.ts:21](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/types.ts#L21)*
#### Type declaration
▸(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `void`
@@ -83,7 +83,7 @@ ___
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[query](_types_.apibaseinterface.md#query)*
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/types.ts#L17)*
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/types.ts#L17)*
___
<a id="rpc"></a>
@@ -94,7 +94,7 @@ ___
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[rpc](_types_.apibaseinterface.md#rpc)*
*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/types.ts#L18)*
*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/types.ts#L18)*
___
<a id="runtimemetadata"></a>
@@ -105,7 +105,7 @@ ___
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[runtimeMetadata](_types_.apibaseinterface.md#runtimemetadata)*
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/types.ts#L15)*
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/types.ts#L15)*
___
<a id="runtimeversion"></a>
@@ -116,7 +116,7 @@ ___
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[runtimeVersion](_types_.apibaseinterface.md#runtimeversion)*
*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/types.ts#L16)*
*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/types.ts#L16)*
___
<a id="tx"></a>
@@ -127,7 +127,7 @@ ___
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[tx](_types_.apibaseinterface.md#tx)*
*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/types.ts#L19)*
*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/types.ts#L19)*
___
docs/api/interfaces/_rx_types_.queryablestoragefunction.md
+6 -6
View File
@@ -11,7 +11,7 @@
▸ **__call**(arg?: *`any`*): `Uint8Array`
*Defined in [rx/types.ts:15](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/rx/types.ts#L15)*
*Defined in [rx/types.ts:15](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/rx/types.ts#L15)*
**Parameters:**
@@ -21,7 +21,7 @@
**Returns:** `Observable`< `Codec` &#124; `null` &#124; `undefined`>
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:12](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/StorageKey.ts#L12)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:12](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/StorageKey.ts#L12)*
**Parameters:**
@@ -41,7 +41,7 @@
*Inherited from StorageFunction.meta*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:14](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/StorageKey.ts#L14)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:14](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/StorageKey.ts#L14)*
___
<a id="method"></a>
@@ -52,7 +52,7 @@ ___
*Inherited from StorageFunction.method*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:15](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/StorageKey.ts#L15)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:15](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/StorageKey.ts#L15)*
___
<a id="section"></a>
@@ -63,7 +63,7 @@ ___
*Inherited from StorageFunction.section*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:16](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/StorageKey.ts#L16)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:16](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/StorageKey.ts#L16)*
___
<a id="tojson"></a>
@@ -74,7 +74,7 @@ ___
*Inherited from StorageFunction.toJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:17](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/StorageKey.ts#L17)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:17](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/StorageKey.ts#L17)*
#### Type declaration
▸(): `any`
docs/api/interfaces/_rx_types_.submittableextrinsicfunction.md
+7 -7
View File
@@ -11,7 +11,7 @@
▸ **__call**(...args: *`any`[]*): `Extrinsic`
*Defined in [rx/types.ts:27](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/rx/types.ts#L27)*
*Defined in [rx/types.ts:27](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/rx/types.ts#L27)*
**Parameters:**
@@ -21,7 +21,7 @@
**Returns:** [SubmittableExtrinsic](../classes/_rx_submittableextrinsic_.submittableextrinsic.md)
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:34](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Method.ts#L34)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:34](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Method.ts#L34)*
**Parameters:**
@@ -41,7 +41,7 @@
*Inherited from ExtrinsicFunction.callIndex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:36](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Method.ts#L36)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:36](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Method.ts#L36)*
___
<a id="meta"></a>
@@ -52,7 +52,7 @@ ___
*Inherited from ExtrinsicFunction.meta*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:37](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Method.ts#L37)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:37](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Method.ts#L37)*
___
<a id="method"></a>
@@ -63,7 +63,7 @@ ___
*Inherited from ExtrinsicFunction.method*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:38](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Method.ts#L38)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:38](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Method.ts#L38)*
___
<a id="section"></a>
@@ -74,7 +74,7 @@ ___
*Inherited from ExtrinsicFunction.section*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:39](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Method.ts#L39)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:39](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Method.ts#L39)*
___
<a id="tojson"></a>
@@ -85,7 +85,7 @@ ___
*Inherited from ExtrinsicFunction.toJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:40](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Method.ts#L40)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:40](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Method.ts#L40)*
#### Type declaration
▸(): `any`
docs/api/interfaces/_types_.apibaseinterface.md
+8 -8
View File
@@ -26,7 +26,7 @@
**● genesisHash**: *`Hash`*
*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/types.ts#L13)*
*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/types.ts#L13)*
___
<a id="hassubscriptions"></a>
@@ -35,7 +35,7 @@ ___
**● hasSubscriptions**: *`boolean`*
*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/types.ts#L14)*
*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/types.ts#L14)*
___
<a id="on"></a>
@@ -44,7 +44,7 @@ ___
**● on**: *`function`*
*Defined in [types.ts:21](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/types.ts#L21)*
*Defined in [types.ts:21](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/types.ts#L21)*
#### Type declaration
▸(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `void`
@@ -65,7 +65,7 @@ ___
**● query**: *`S`*
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/types.ts#L17)*
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/types.ts#L17)*
___
<a id="rpc"></a>
@@ -74,7 +74,7 @@ ___
**● rpc**: *`R`*
*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/types.ts#L18)*
*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/types.ts#L18)*
___
<a id="runtimemetadata"></a>
@@ -83,7 +83,7 @@ ___
**● runtimeMetadata**: *`Metadata`*
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/types.ts#L15)*
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/types.ts#L15)*
___
<a id="runtimeversion"></a>
@@ -92,7 +92,7 @@ ___
**● runtimeVersion**: *`RuntimeVersion`*
*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/types.ts#L16)*
*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/types.ts#L16)*
___
<a id="tx"></a>
@@ -101,7 +101,7 @@ ___
**● tx**: *`E`*
*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/types.ts#L19)*
*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/types.ts#L19)*
___
docs/api/interfaces/_types_.apioptions.md
+2 -2
View File
@@ -12,7 +12,7 @@
**● provider**: *`ProviderInterface`*
*Defined in [types.ts:29](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/types.ts#L29)*
*Defined in [types.ts:29](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/types.ts#L29)*
*__description__*: Transport Provider from rpc-provider. If not specified, it will default to connecting to a WsProvider connecting localhost with the default port, i.e. `ws://127.0.0.1:9944`
@@ -24,7 +24,7 @@ ___
**● types**: * `undefined` &#124; `object`
*
*Defined in [types.ts:34](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/types.ts#L34)*
*Defined in [types.ts:34](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/types.ts#L34)*
*__description__*: Additional types used by runtime modules. This is nessusary if the runtime modules uses types not available in the base Substrate runtime.
docs/api/modules/_promise_combinator_.md
+2 -2
View File
@@ -21,7 +21,7 @@
**Ƭ CombinatorCallback**: *`function`*
*Defined in [promise/Combinator.ts:7](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/promise/Combinator.ts#L7)*
*Defined in [promise/Combinator.ts:7](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/promise/Combinator.ts#L7)*
#### Type declaration
▸(value: *`Array`<`any`>*): `any`
@@ -41,7 +41,7 @@ ___
**Ƭ CombinatorFunction**: *`function`*
*Defined in [promise/Combinator.ts:8](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/promise/Combinator.ts#L8)*
*Defined in [promise/Combinator.ts:8](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/promise/Combinator.ts#L8)*
#### Type declaration
▸(cb: *`function`*): `any`
docs/api/modules/_types_.md
+1 -1
View File
@@ -22,7 +22,7 @@
**Ƭ ApiInterface$Events**: * `RpcRxInterface$Events` &#124; "ready"
*
*Defined in [types.ts:10](https://github.com/polkadot-js/api/blob/69f6850/packages/api/src/types.ts#L10)*
*Defined in [types.ts:10](https://github.com/polkadot-js/api/blob/448a729/packages/api/src/types.ts#L10)*
___
docs/examples/promise/01_simple_connect/index.html
+31 -31
View File
@@ -1122,9 +1122,9 @@
</li>
<li class="chapter " data-level="4.58" data-path="../../../types/classes/_metadata_.callmetadata.html">
<li class="chapter " data-level="4.58" data-path="../../../types/classes/_metadata_.callmetadata.md">
<a href="../../../types/classes/_metadata_.callmetadata.html">
<span>
hidden
@@ -1135,9 +1135,9 @@
</li>
<li class="chapter " data-level="4.59" data-path="../../../types/classes/_metadata_.eventmetadata.html">
<li class="chapter " data-level="4.59" data-path="../../../types/classes/_metadata_.eventmetadata.md">
<a href="../../../types/classes/_metadata_.eventmetadata.html">
<span>
hidden
@@ -1148,9 +1148,9 @@
</li>
<li class="chapter " data-level="4.60" data-path="../../../types/classes/_metadata_.functionargumentmetadata.html">
<li class="chapter " data-level="4.60" data-path="../../../types/classes/_metadata_.functionargumentmetadata.md">
<a href="../../../types/classes/_metadata_.functionargumentmetadata.html">
<span>
hidden
@@ -1161,9 +1161,9 @@
</li>
<li class="chapter " data-level="4.61" data-path="../../../types/classes/_metadata_.functionmetadata.html">
<li class="chapter " data-level="4.61" data-path="../../../types/classes/_metadata_.functionmetadata.md">
<a href="../../../types/classes/_metadata_.functionmetadata.html">
<span>
hidden
@@ -1174,9 +1174,9 @@
</li>
<li class="chapter " data-level="4.62" data-path="../../../types/classes/_metadata_.modulemetadata.html">
<li class="chapter " data-level="4.62" data-path="../../../types/classes/_metadata_.modulemetadata.md">
<a href="../../../types/classes/_metadata_.modulemetadata.html">
<span>
hidden
@@ -1187,9 +1187,9 @@
</li>
<li class="chapter " data-level="4.63" data-path="../../../types/classes/_metadata_.outerdispatchcall.html">
<li class="chapter " data-level="4.63" data-path="../../../types/classes/_metadata_.outerdispatchcall.md">
<a href="../../../types/classes/_metadata_.outerdispatchcall.html">
<span>
hidden
@@ -1200,9 +1200,9 @@
</li>
<li class="chapter " data-level="4.64" data-path="../../../types/classes/_metadata_.outerdispatchmetadata.html">
<li class="chapter " data-level="4.64" data-path="../../../types/classes/_metadata_.outerdispatchmetadata.md">
<a href="../../../types/classes/_metadata_.outerdispatchmetadata.html">
<span>
hidden
@@ -1213,9 +1213,9 @@
</li>
<li class="chapter " data-level="4.65" data-path="../../../types/classes/_metadata_.outereventmetadata.html">
<li class="chapter " data-level="4.65" data-path="../../../types/classes/_metadata_.outereventmetadata.md">
<a href="../../../types/classes/_metadata_.outereventmetadata.html">
<span>
hidden
@@ -1226,9 +1226,9 @@
</li>
<li class="chapter " data-level="4.66" data-path="../../../types/classes/_metadata_.outereventmetadataevent.html">
<li class="chapter " data-level="4.66" data-path="../../../types/classes/_metadata_.outereventmetadataevent.md">
<a href="../../../types/classes/_metadata_.outereventmetadataevent.html">
<span>
hidden
@@ -1252,9 +1252,9 @@
</li>
<li class="chapter " data-level="4.68" data-path="../../../types/classes/_metadata_.runtimemodulemetadata.html">
<li class="chapter " data-level="4.68" data-path="../../../types/classes/_metadata_.runtimemodulemetadata.md">
<a href="../../../types/classes/_metadata_.runtimemodulemetadata.html">
<span>
hidden
@@ -1265,9 +1265,9 @@
</li>
<li class="chapter " data-level="4.69" data-path="../../../types/classes/_metadata_.storagefunctionmetadata.html">
<li class="chapter " data-level="4.69" data-path="../../../types/classes/_metadata_.storagefunctionmetadata.md">
<a href="../../../types/classes/_metadata_.storagefunctionmetadata.html">
<span>
hidden
@@ -1278,9 +1278,9 @@
</li>
<li class="chapter " data-level="4.70" data-path="../../../types/classes/_metadata_.storagefunctionmodifier.html">
<li class="chapter " data-level="4.70" data-path="../../../types/classes/_metadata_.storagefunctionmodifier.md">
<a href="../../../types/classes/_metadata_.storagefunctionmodifier.html">
<span>
hidden
@@ -1291,9 +1291,9 @@
</li>
<li class="chapter " data-level="4.71" data-path="../../../types/classes/_metadata_.storagefunctiontype.html">
<li class="chapter " data-level="4.71" data-path="../../../types/classes/_metadata_.storagefunctiontype.md">
<a href="../../../types/classes/_metadata_.storagefunctiontype.html">
<span>
hidden
@@ -1304,9 +1304,9 @@
</li>
<li class="chapter " data-level="4.72" data-path="../../../types/classes/_metadata_.storagefunctiontype_map.html">
<li class="chapter " data-level="4.72" data-path="../../../types/classes/_metadata_.storagefunctiontype_map.md">
<a href="../../../types/classes/_metadata_.storagefunctiontype_map.html">
<span>
hidden
@@ -1317,9 +1317,9 @@
</li>
<li class="chapter " data-level="4.73" data-path="../../../types/classes/_metadata_.storagemetadata.html">
<li class="chapter " data-level="4.73" data-path="../../../types/classes/_metadata_.storagemetadata.md">
<a href="../../../types/classes/_metadata_.storagemetadata.html">
<span>
hidden
@@ -2028,7 +2028,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Simple connect","level":"3.1.1","depth":2,"next":{"title":"Listen to blocks","level":"3.1.2","depth":2,"path":"examples/promise/02_listen_to_blocks/README.md","ref":"examples/promise/02_listen_to_blocks/README.md","articles":[]},"previous":{"title":"ApiPromise","level":"3.1","depth":1,"path":"examples/promise/README.md","ref":"examples/promise/README.md","articles":[{"title":"Simple connect","level":"3.1.1","depth":2,"path":"examples/promise/01_simple_connect/README.md","ref":"examples/promise/01_simple_connect/README.md","articles":[]},{"title":"Listen to blocks","level":"3.1.2","depth":2,"path":"examples/promise/02_listen_to_blocks/README.md","ref":"examples/promise/02_listen_to_blocks/README.md","articles":[]},{"title":"Listen to balance change","level":"3.1.3","depth":2,"path":"examples/promise/03_listen_to_balance_change/README.md","ref":"examples/promise/03_listen_to_balance_change/README.md","articles":[]},{"title":"Read chain state","level":"3.1.4","depth":2,"path":"examples/promise/05_read_storage/README.md","ref":"examples/promise/05_read_storage/README.md","articles":[]},{"title":"Make a transfer","level":"3.1.5","depth":2,"path":"examples/promise/07_transfer_dots/README.md","ref":"examples/promise/07_transfer_dots/README.md","articles":[]},{"title":"Display system events","level":"3.1.6","depth":2,"path":"examples/promise/08_system_events/README.md","ref":"examples/promise/08_system_events/README.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/01_simple_connect/README.md","mtime":"2018-12-07T11:31:10.050Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-07T11:34:45.610Z"},"basePath":"../../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"Simple connect","level":"3.1.1","depth":2,"next":{"title":"Listen to blocks","level":"3.1.2","depth":2,"path":"examples/promise/02_listen_to_blocks/README.md","ref":"examples/promise/02_listen_to_blocks/README.md","articles":[]},"previous":{"title":"ApiPromise","level":"3.1","depth":1,"path":"examples/promise/README.md","ref":"examples/promise/README.md","articles":[{"title":"Simple connect","level":"3.1.1","depth":2,"path":"examples/promise/01_simple_connect/README.md","ref":"examples/promise/01_simple_connect/README.md","articles":[]},{"title":"Listen to blocks","level":"3.1.2","depth":2,"path":"examples/promise/02_listen_to_blocks/README.md","ref":"examples/promise/02_listen_to_blocks/README.md","articles":[]},{"title":"Listen to balance change","level":"3.1.3","depth":2,"path":"examples/promise/03_listen_to_balance_change/README.md","ref":"examples/promise/03_listen_to_balance_change/README.md","articles":[]},{"title":"Read chain state","level":"3.1.4","depth":2,"path":"examples/promise/05_read_storage/README.md","ref":"examples/promise/05_read_storage/README.md","articles":[]},{"title":"Make a transfer","level":"3.1.5","depth":2,"path":"examples/promise/07_transfer_dots/README.md","ref":"examples/promise/07_transfer_dots/README.md","articles":[]},{"title":"Display system events","level":"3.1.6","depth":2,"path":"examples/promise/08_system_events/README.md","ref":"examples/promise/08_system_events/README.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/01_simple_connect/README.md","mtime":"2018-12-08T14:32:44.450Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-08T14:36:23.372Z"},"basePath":"../../..","book":{"language":""}});
});
</script>
</div>
docs/examples/promise/02_listen_to_blocks/index.html
+31 -31
View File
@@ -1122,9 +1122,9 @@
</li>
<li class="chapter " data-level="4.58" data-path="../../../types/classes/_metadata_.callmetadata.html">
<li class="chapter " data-level="4.58" data-path="../../../types/classes/_metadata_.callmetadata.md">
<a href="../../../types/classes/_metadata_.callmetadata.html">
<span>
hidden
@@ -1135,9 +1135,9 @@
</li>
<li class="chapter " data-level="4.59" data-path="../../../types/classes/_metadata_.eventmetadata.html">
<li class="chapter " data-level="4.59" data-path="../../../types/classes/_metadata_.eventmetadata.md">
<a href="../../../types/classes/_metadata_.eventmetadata.html">
<span>
hidden
@@ -1148,9 +1148,9 @@
</li>
<li class="chapter " data-level="4.60" data-path="../../../types/classes/_metadata_.functionargumentmetadata.html">
<li class="chapter " data-level="4.60" data-path="../../../types/classes/_metadata_.functionargumentmetadata.md">
<a href="../../../types/classes/_metadata_.functionargumentmetadata.html">
<span>
hidden
@@ -1161,9 +1161,9 @@
</li>
<li class="chapter " data-level="4.61" data-path="../../../types/classes/_metadata_.functionmetadata.html">
<li class="chapter " data-level="4.61" data-path="../../../types/classes/_metadata_.functionmetadata.md">
<a href="../../../types/classes/_metadata_.functionmetadata.html">
<span>
hidden
@@ -1174,9 +1174,9 @@
</li>
<li class="chapter " data-level="4.62" data-path="../../../types/classes/_metadata_.modulemetadata.html">
<li class="chapter " data-level="4.62" data-path="../../../types/classes/_metadata_.modulemetadata.md">
<a href="../../../types/classes/_metadata_.modulemetadata.html">
<span>
hidden
@@ -1187,9 +1187,9 @@
</li>
<li class="chapter " data-level="4.63" data-path="../../../types/classes/_metadata_.outerdispatchcall.html">
<li class="chapter " data-level="4.63" data-path="../../../types/classes/_metadata_.outerdispatchcall.md">
<a href="../../../types/classes/_metadata_.outerdispatchcall.html">
<span>
hidden
@@ -1200,9 +1200,9 @@
</li>
<li class="chapter " data-level="4.64" data-path="../../../types/classes/_metadata_.outerdispatchmetadata.html">
<li class="chapter " data-level="4.64" data-path="../../../types/classes/_metadata_.outerdispatchmetadata.md">
<a href="../../../types/classes/_metadata_.outerdispatchmetadata.html">
<span>
hidden
@@ -1213,9 +1213,9 @@
</li>
<li class="chapter " data-level="4.65" data-path="../../../types/classes/_metadata_.outereventmetadata.html">
<li class="chapter " data-level="4.65" data-path="../../../types/classes/_metadata_.outereventmetadata.md">
<a href="../../../types/classes/_metadata_.outereventmetadata.html">
<span>
hidden
@@ -1226,9 +1226,9 @@
</li>
<li class="chapter " data-level="4.66" data-path="../../../types/classes/_metadata_.outereventmetadataevent.html">
<li class="chapter " data-level="4.66" data-path="../../../types/classes/_metadata_.outereventmetadataevent.md">
<a href="../../../types/classes/_metadata_.outereventmetadataevent.html">
<span>
hidden
@@ -1252,9 +1252,9 @@
</li>
<li class="chapter " data-level="4.68" data-path="../../../types/classes/_metadata_.runtimemodulemetadata.html">
<li class="chapter " data-level="4.68" data-path="../../../types/classes/_metadata_.runtimemodulemetadata.md">
<a href="../../../types/classes/_metadata_.runtimemodulemetadata.html">
<span>
hidden
@@ -1265,9 +1265,9 @@
</li>
<li class="chapter " data-level="4.69" data-path="../../../types/classes/_metadata_.storagefunctionmetadata.html">
<li class="chapter " data-level="4.69" data-path="../../../types/classes/_metadata_.storagefunctionmetadata.md">
<a href="../../../types/classes/_metadata_.storagefunctionmetadata.html">
<span>
hidden
@@ -1278,9 +1278,9 @@
</li>
<li class="chapter " data-level="4.70" data-path="../../../types/classes/_metadata_.storagefunctionmodifier.html">
<li class="chapter " data-level="4.70" data-path="../../../types/classes/_metadata_.storagefunctionmodifier.md">
<a href="../../../types/classes/_metadata_.storagefunctionmodifier.html">
<span>
hidden
@@ -1291,9 +1291,9 @@
</li>
<li class="chapter " data-level="4.71" data-path="../../../types/classes/_metadata_.storagefunctiontype.html">
<li class="chapter " data-level="4.71" data-path="../../../types/classes/_metadata_.storagefunctiontype.md">
<a href="../../../types/classes/_metadata_.storagefunctiontype.html">
<span>
hidden
@@ -1304,9 +1304,9 @@
</li>
<li class="chapter " data-level="4.72" data-path="../../../types/classes/_metadata_.storagefunctiontype_map.html">
<li class="chapter " data-level="4.72" data-path="../../../types/classes/_metadata_.storagefunctiontype_map.md">
<a href="../../../types/classes/_metadata_.storagefunctiontype_map.html">
<span>
hidden
@@ -1317,9 +1317,9 @@
</li>
<li class="chapter " data-level="4.73" data-path="../../../types/classes/_metadata_.storagemetadata.html">
<li class="chapter " data-level="4.73" data-path="../../../types/classes/_metadata_.storagemetadata.md">
<a href="../../../types/classes/_metadata_.storagemetadata.html">
<span>
hidden
@@ -2030,7 +2030,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Listen to blocks","level":"3.1.2","depth":2,"next":{"title":"Listen to balance change","level":"3.1.3","depth":2,"path":"examples/promise/03_listen_to_balance_change/README.md","ref":"examples/promise/03_listen_to_balance_change/README.md","articles":[]},"previous":{"title":"Simple connect","level":"3.1.1","depth":2,"path":"examples/promise/01_simple_connect/README.md","ref":"examples/promise/01_simple_connect/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/02_listen_to_blocks/README.md","mtime":"2018-12-07T11:31:10.050Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-07T11:34:45.610Z"},"basePath":"../../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"Listen to blocks","level":"3.1.2","depth":2,"next":{"title":"Listen to balance change","level":"3.1.3","depth":2,"path":"examples/promise/03_listen_to_balance_change/README.md","ref":"examples/promise/03_listen_to_balance_change/README.md","articles":[]},"previous":{"title":"Simple connect","level":"3.1.1","depth":2,"path":"examples/promise/01_simple_connect/README.md","ref":"examples/promise/01_simple_connect/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/02_listen_to_blocks/README.md","mtime":"2018-12-08T14:32:44.450Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-08T14:36:23.372Z"},"basePath":"../../..","book":{"language":""}});
});
</script>
</div>
docs/examples/promise/03_listen_to_balance_change/index.html
+31 -31
View File
@@ -1122,9 +1122,9 @@
</li>
<li class="chapter " data-level="4.58" data-path="../../../types/classes/_metadata_.callmetadata.html">
<li class="chapter " data-level="4.58" data-path="../../../types/classes/_metadata_.callmetadata.md">
<a href="../../../types/classes/_metadata_.callmetadata.html">
<span>
hidden
@@ -1135,9 +1135,9 @@
</li>
<li class="chapter " data-level="4.59" data-path="../../../types/classes/_metadata_.eventmetadata.html">
<li class="chapter " data-level="4.59" data-path="../../../types/classes/_metadata_.eventmetadata.md">
<a href="../../../types/classes/_metadata_.eventmetadata.html">
<span>
hidden
@@ -1148,9 +1148,9 @@
</li>
<li class="chapter " data-level="4.60" data-path="../../../types/classes/_metadata_.functionargumentmetadata.html">
<li class="chapter " data-level="4.60" data-path="../../../types/classes/_metadata_.functionargumentmetadata.md">
<a href="../../../types/classes/_metadata_.functionargumentmetadata.html">
<span>
hidden
@@ -1161,9 +1161,9 @@
</li>
<li class="chapter " data-level="4.61" data-path="../../../types/classes/_metadata_.functionmetadata.html">
<li class="chapter " data-level="4.61" data-path="../../../types/classes/_metadata_.functionmetadata.md">
<a href="../../../types/classes/_metadata_.functionmetadata.html">
<span>
hidden
@@ -1174,9 +1174,9 @@
</li>
<li class="chapter " data-level="4.62" data-path="../../../types/classes/_metadata_.modulemetadata.html">
<li class="chapter " data-level="4.62" data-path="../../../types/classes/_metadata_.modulemetadata.md">
<a href="../../../types/classes/_metadata_.modulemetadata.html">
<span>
hidden
@@ -1187,9 +1187,9 @@
</li>
<li class="chapter " data-level="4.63" data-path="../../../types/classes/_metadata_.outerdispatchcall.html">
<li class="chapter " data-level="4.63" data-path="../../../types/classes/_metadata_.outerdispatchcall.md">
<a href="../../../types/classes/_metadata_.outerdispatchcall.html">
<span>
hidden
@@ -1200,9 +1200,9 @@
</li>
<li class="chapter " data-level="4.64" data-path="../../../types/classes/_metadata_.outerdispatchmetadata.html">
<li class="chapter " data-level="4.64" data-path="../../../types/classes/_metadata_.outerdispatchmetadata.md">
<a href="../../../types/classes/_metadata_.outerdispatchmetadata.html">
<span>
hidden
@@ -1213,9 +1213,9 @@
</li>
<li class="chapter " data-level="4.65" data-path="../../../types/classes/_metadata_.outereventmetadata.html">
<li class="chapter " data-level="4.65" data-path="../../../types/classes/_metadata_.outereventmetadata.md">
<a href="../../../types/classes/_metadata_.outereventmetadata.html">
<span>
hidden
@@ -1226,9 +1226,9 @@
</li>
<li class="chapter " data-level="4.66" data-path="../../../types/classes/_metadata_.outereventmetadataevent.html">
<li class="chapter " data-level="4.66" data-path="../../../types/classes/_metadata_.outereventmetadataevent.md">
<a href="../../../types/classes/_metadata_.outereventmetadataevent.html">
<span>
hidden
@@ -1252,9 +1252,9 @@
</li>
<li class="chapter " data-level="4.68" data-path="../../../types/classes/_metadata_.runtimemodulemetadata.html">
<li class="chapter " data-level="4.68" data-path="../../../types/classes/_metadata_.runtimemodulemetadata.md">
<a href="../../../types/classes/_metadata_.runtimemodulemetadata.html">
<span>
hidden
@@ -1265,9 +1265,9 @@
</li>
<li class="chapter " data-level="4.69" data-path="../../../types/classes/_metadata_.storagefunctionmetadata.html">
<li class="chapter " data-level="4.69" data-path="../../../types/classes/_metadata_.storagefunctionmetadata.md">
<a href="../../../types/classes/_metadata_.storagefunctionmetadata.html">
<span>
hidden
@@ -1278,9 +1278,9 @@
</li>
<li class="chapter " data-level="4.70" data-path="../../../types/classes/_metadata_.storagefunctionmodifier.html">
<li class="chapter " data-level="4.70" data-path="../../../types/classes/_metadata_.storagefunctionmodifier.md">
<a href="../../../types/classes/_metadata_.storagefunctionmodifier.html">
<span>
hidden
@@ -1291,9 +1291,9 @@
</li>
<li class="chapter " data-level="4.71" data-path="../../../types/classes/_metadata_.storagefunctiontype.html">
<li class="chapter " data-level="4.71" data-path="../../../types/classes/_metadata_.storagefunctiontype.md">
<a href="../../../types/classes/_metadata_.storagefunctiontype.html">
<span>
hidden
@@ -1304,9 +1304,9 @@
</li>
<li class="chapter " data-level="4.72" data-path="../../../types/classes/_metadata_.storagefunctiontype_map.html">
<li class="chapter " data-level="4.72" data-path="../../../types/classes/_metadata_.storagefunctiontype_map.md">
<a href="../../../types/classes/_metadata_.storagefunctiontype_map.html">
<span>
hidden
@@ -1317,9 +1317,9 @@
</li>
<li class="chapter " data-level="4.73" data-path="../../../types/classes/_metadata_.storagemetadata.html">
<li class="chapter " data-level="4.73" data-path="../../../types/classes/_metadata_.storagemetadata.md">
<a href="../../../types/classes/_metadata_.storagemetadata.html">
<span>
hidden
@@ -2041,7 +2041,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Listen to balance change","level":"3.1.3","depth":2,"next":{"title":"Read chain state","level":"3.1.4","depth":2,"path":"examples/promise/05_read_storage/README.md","ref":"examples/promise/05_read_storage/README.md","articles":[]},"previous":{"title":"Listen to blocks","level":"3.1.2","depth":2,"path":"examples/promise/02_listen_to_blocks/README.md","ref":"examples/promise/02_listen_to_blocks/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/03_listen_to_balance_change/README.md","mtime":"2018-12-07T11:31:10.054Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-07T11:34:45.610Z"},"basePath":"../../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"Listen to balance change","level":"3.1.3","depth":2,"next":{"title":"Read chain state","level":"3.1.4","depth":2,"path":"examples/promise/05_read_storage/README.md","ref":"examples/promise/05_read_storage/README.md","articles":[]},"previous":{"title":"Listen to blocks","level":"3.1.2","depth":2,"path":"examples/promise/02_listen_to_blocks/README.md","ref":"examples/promise/02_listen_to_blocks/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/03_listen_to_balance_change/README.md","mtime":"2018-12-08T14:32:44.450Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-08T14:36:23.372Z"},"basePath":"../../..","book":{"language":""}});
});
</script>
</div>
docs/examples/promise/05_read_storage/index.html
+31 -31
View File
@@ -1122,9 +1122,9 @@
</li>
<li class="chapter " data-level="4.58" data-path="../../../types/classes/_metadata_.callmetadata.html">
<li class="chapter " data-level="4.58" data-path="../../../types/classes/_metadata_.callmetadata.md">
<a href="../../../types/classes/_metadata_.callmetadata.html">
<span>
hidden
@@ -1135,9 +1135,9 @@
</li>
<li class="chapter " data-level="4.59" data-path="../../../types/classes/_metadata_.eventmetadata.html">
<li class="chapter " data-level="4.59" data-path="../../../types/classes/_metadata_.eventmetadata.md">
<a href="../../../types/classes/_metadata_.eventmetadata.html">
<span>
hidden
@@ -1148,9 +1148,9 @@
</li>
<li class="chapter " data-level="4.60" data-path="../../../types/classes/_metadata_.functionargumentmetadata.html">
<li class="chapter " data-level="4.60" data-path="../../../types/classes/_metadata_.functionargumentmetadata.md">
<a href="../../../types/classes/_metadata_.functionargumentmetadata.html">
<span>
hidden
@@ -1161,9 +1161,9 @@
</li>
<li class="chapter " data-level="4.61" data-path="../../../types/classes/_metadata_.functionmetadata.html">
<li class="chapter " data-level="4.61" data-path="../../../types/classes/_metadata_.functionmetadata.md">
<a href="../../../types/classes/_metadata_.functionmetadata.html">
<span>
hidden
@@ -1174,9 +1174,9 @@
</li>
<li class="chapter " data-level="4.62" data-path="../../../types/classes/_metadata_.modulemetadata.html">
<li class="chapter " data-level="4.62" data-path="../../../types/classes/_metadata_.modulemetadata.md">
<a href="../../../types/classes/_metadata_.modulemetadata.html">
<span>
hidden
@@ -1187,9 +1187,9 @@
</li>
<li class="chapter " data-level="4.63" data-path="../../../types/classes/_metadata_.outerdispatchcall.html">
<li class="chapter " data-level="4.63" data-path="../../../types/classes/_metadata_.outerdispatchcall.md">
<a href="../../../types/classes/_metadata_.outerdispatchcall.html">
<span>
hidden
@@ -1200,9 +1200,9 @@
</li>
<li class="chapter " data-level="4.64" data-path="../../../types/classes/_metadata_.outerdispatchmetadata.html">
<li class="chapter " data-level="4.64" data-path="../../../types/classes/_metadata_.outerdispatchmetadata.md">
<a href="../../../types/classes/_metadata_.outerdispatchmetadata.html">
<span>
hidden
@@ -1213,9 +1213,9 @@
</li>
<li class="chapter " data-level="4.65" data-path="../../../types/classes/_metadata_.outereventmetadata.html">
<li class="chapter " data-level="4.65" data-path="../../../types/classes/_metadata_.outereventmetadata.md">
<a href="../../../types/classes/_metadata_.outereventmetadata.html">
<span>
hidden
@@ -1226,9 +1226,9 @@
</li>
<li class="chapter " data-level="4.66" data-path="../../../types/classes/_metadata_.outereventmetadataevent.html">
<li class="chapter " data-level="4.66" data-path="../../../types/classes/_metadata_.outereventmetadataevent.md">
<a href="../../../types/classes/_metadata_.outereventmetadataevent.html">
<span>
hidden
@@ -1252,9 +1252,9 @@
</li>
<li class="chapter " data-level="4.68" data-path="../../../types/classes/_metadata_.runtimemodulemetadata.html">
<li class="chapter " data-level="4.68" data-path="../../../types/classes/_metadata_.runtimemodulemetadata.md">
<a href="../../../types/classes/_metadata_.runtimemodulemetadata.html">
<span>
hidden
@@ -1265,9 +1265,9 @@
</li>
<li class="chapter " data-level="4.69" data-path="../../../types/classes/_metadata_.storagefunctionmetadata.html">
<li class="chapter " data-level="4.69" data-path="../../../types/classes/_metadata_.storagefunctionmetadata.md">
<a href="../../../types/classes/_metadata_.storagefunctionmetadata.html">
<span>
hidden
@@ -1278,9 +1278,9 @@
</li>
<li class="chapter " data-level="4.70" data-path="../../../types/classes/_metadata_.storagefunctionmodifier.html">
<li class="chapter " data-level="4.70" data-path="../../../types/classes/_metadata_.storagefunctionmodifier.md">
<a href="../../../types/classes/_metadata_.storagefunctionmodifier.html">
<span>
hidden
@@ -1291,9 +1291,9 @@
</li>
<li class="chapter " data-level="4.71" data-path="../../../types/classes/_metadata_.storagefunctiontype.html">
<li class="chapter " data-level="4.71" data-path="../../../types/classes/_metadata_.storagefunctiontype.md">
<a href="../../../types/classes/_metadata_.storagefunctiontype.html">
<span>
hidden
@@ -1304,9 +1304,9 @@
</li>
<li class="chapter " data-level="4.72" data-path="../../../types/classes/_metadata_.storagefunctiontype_map.html">
<li class="chapter " data-level="4.72" data-path="../../../types/classes/_metadata_.storagefunctiontype_map.md">
<a href="../../../types/classes/_metadata_.storagefunctiontype_map.html">
<span>
hidden
@@ -1317,9 +1317,9 @@
</li>
<li class="chapter " data-level="4.73" data-path="../../../types/classes/_metadata_.storagemetadata.html">
<li class="chapter " data-level="4.73" data-path="../../../types/classes/_metadata_.storagemetadata.md">
<a href="../../../types/classes/_metadata_.storagemetadata.html">
<span>
hidden
@@ -2040,7 +2040,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Read chain state","level":"3.1.4","depth":2,"next":{"title":"Make a transfer","level":"3.1.5","depth":2,"path":"examples/promise/07_transfer_dots/README.md","ref":"examples/promise/07_transfer_dots/README.md","articles":[]},"previous":{"title":"Listen to balance change","level":"3.1.3","depth":2,"path":"examples/promise/03_listen_to_balance_change/README.md","ref":"examples/promise/03_listen_to_balance_change/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/05_read_storage/README.md","mtime":"2018-12-07T11:31:10.054Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-07T11:34:45.610Z"},"basePath":"../../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"Read chain state","level":"3.1.4","depth":2,"next":{"title":"Make a transfer","level":"3.1.5","depth":2,"path":"examples/promise/07_transfer_dots/README.md","ref":"examples/promise/07_transfer_dots/README.md","articles":[]},"previous":{"title":"Listen to balance change","level":"3.1.3","depth":2,"path":"examples/promise/03_listen_to_balance_change/README.md","ref":"examples/promise/03_listen_to_balance_change/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/05_read_storage/README.md","mtime":"2018-12-08T14:32:44.450Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-08T14:36:23.372Z"},"basePath":"../../..","book":{"language":""}});
});
</script>
</div>
docs/examples/promise/07_transfer_dots/index.html
+31 -31
View File
@@ -1122,9 +1122,9 @@
</li>
<li class="chapter " data-level="4.58" data-path="../../../types/classes/_metadata_.callmetadata.html">
<li class="chapter " data-level="4.58" data-path="../../../types/classes/_metadata_.callmetadata.md">
<a href="../../../types/classes/_metadata_.callmetadata.html">
<span>
hidden
@@ -1135,9 +1135,9 @@
</li>
<li class="chapter " data-level="4.59" data-path="../../../types/classes/_metadata_.eventmetadata.html">
<li class="chapter " data-level="4.59" data-path="../../../types/classes/_metadata_.eventmetadata.md">
<a href="../../../types/classes/_metadata_.eventmetadata.html">
<span>
hidden
@@ -1148,9 +1148,9 @@
</li>
<li class="chapter " data-level="4.60" data-path="../../../types/classes/_metadata_.functionargumentmetadata.html">
<li class="chapter " data-level="4.60" data-path="../../../types/classes/_metadata_.functionargumentmetadata.md">
<a href="../../../types/classes/_metadata_.functionargumentmetadata.html">
<span>
hidden
@@ -1161,9 +1161,9 @@
</li>
<li class="chapter " data-level="4.61" data-path="../../../types/classes/_metadata_.functionmetadata.html">
<li class="chapter " data-level="4.61" data-path="../../../types/classes/_metadata_.functionmetadata.md">
<a href="../../../types/classes/_metadata_.functionmetadata.html">
<span>
hidden
@@ -1174,9 +1174,9 @@
</li>
<li class="chapter " data-level="4.62" data-path="../../../types/classes/_metadata_.modulemetadata.html">
<li class="chapter " data-level="4.62" data-path="../../../types/classes/_metadata_.modulemetadata.md">
<a href="../../../types/classes/_metadata_.modulemetadata.html">
<span>
hidden
@@ -1187,9 +1187,9 @@
</li>
<li class="chapter " data-level="4.63" data-path="../../../types/classes/_metadata_.outerdispatchcall.html">
<li class="chapter " data-level="4.63" data-path="../../../types/classes/_metadata_.outerdispatchcall.md">
<a href="../../../types/classes/_metadata_.outerdispatchcall.html">
<span>
hidden
@@ -1200,9 +1200,9 @@
</li>
<li class="chapter " data-level="4.64" data-path="../../../types/classes/_metadata_.outerdispatchmetadata.html">
<li class="chapter " data-level="4.64" data-path="../../../types/classes/_metadata_.outerdispatchmetadata.md">
<a href="../../../types/classes/_metadata_.outerdispatchmetadata.html">
<span>
hidden
@@ -1213,9 +1213,9 @@
</li>
<li class="chapter " data-level="4.65" data-path="../../../types/classes/_metadata_.outereventmetadata.html">
<li class="chapter " data-level="4.65" data-path="../../../types/classes/_metadata_.outereventmetadata.md">
<a href="../../../types/classes/_metadata_.outereventmetadata.html">
<span>
hidden
@@ -1226,9 +1226,9 @@
</li>
<li class="chapter " data-level="4.66" data-path="../../../types/classes/_metadata_.outereventmetadataevent.html">
<li class="chapter " data-level="4.66" data-path="../../../types/classes/_metadata_.outereventmetadataevent.md">
<a href="../../../types/classes/_metadata_.outereventmetadataevent.html">
<span>
hidden
@@ -1252,9 +1252,9 @@
</li>
<li class="chapter " data-level="4.68" data-path="../../../types/classes/_metadata_.runtimemodulemetadata.html">
<li class="chapter " data-level="4.68" data-path="../../../types/classes/_metadata_.runtimemodulemetadata.md">
<a href="../../../types/classes/_metadata_.runtimemodulemetadata.html">
<span>
hidden
@@ -1265,9 +1265,9 @@
</li>
<li class="chapter " data-level="4.69" data-path="../../../types/classes/_metadata_.storagefunctionmetadata.html">
<li class="chapter " data-level="4.69" data-path="../../../types/classes/_metadata_.storagefunctionmetadata.md">
<a href="../../../types/classes/_metadata_.storagefunctionmetadata.html">
<span>
hidden
@@ -1278,9 +1278,9 @@
</li>
<li class="chapter " data-level="4.70" data-path="../../../types/classes/_metadata_.storagefunctionmodifier.html">
<li class="chapter " data-level="4.70" data-path="../../../types/classes/_metadata_.storagefunctionmodifier.md">
<a href="../../../types/classes/_metadata_.storagefunctionmodifier.html">
<span>
hidden
@@ -1291,9 +1291,9 @@
</li>
<li class="chapter " data-level="4.71" data-path="../../../types/classes/_metadata_.storagefunctiontype.html">
<li class="chapter " data-level="4.71" data-path="../../../types/classes/_metadata_.storagefunctiontype.md">
<a href="../../../types/classes/_metadata_.storagefunctiontype.html">
<span>
hidden
@@ -1304,9 +1304,9 @@
</li>
<li class="chapter " data-level="4.72" data-path="../../../types/classes/_metadata_.storagefunctiontype_map.html">
<li class="chapter " data-level="4.72" data-path="../../../types/classes/_metadata_.storagefunctiontype_map.md">
<a href="../../../types/classes/_metadata_.storagefunctiontype_map.html">
<span>
hidden
@@ -1317,9 +1317,9 @@
</li>
<li class="chapter " data-level="4.73" data-path="../../../types/classes/_metadata_.storagemetadata.html">
<li class="chapter " data-level="4.73" data-path="../../../types/classes/_metadata_.storagemetadata.md">
<a href="../../../types/classes/_metadata_.storagemetadata.html">
<span>
hidden
@@ -2042,7 +2042,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Make a transfer","level":"3.1.5","depth":2,"next":{"title":"Display system events","level":"3.1.6","depth":2,"path":"examples/promise/08_system_events/README.md","ref":"examples/promise/08_system_events/README.md","articles":[]},"previous":{"title":"Read chain state","level":"3.1.4","depth":2,"path":"examples/promise/05_read_storage/README.md","ref":"examples/promise/05_read_storage/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/07_transfer_dots/README.md","mtime":"2018-12-07T11:31:10.054Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-07T11:34:45.610Z"},"basePath":"../../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"Make a transfer","level":"3.1.5","depth":2,"next":{"title":"Display system events","level":"3.1.6","depth":2,"path":"examples/promise/08_system_events/README.md","ref":"examples/promise/08_system_events/README.md","articles":[]},"previous":{"title":"Read chain state","level":"3.1.4","depth":2,"path":"examples/promise/05_read_storage/README.md","ref":"examples/promise/05_read_storage/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/07_transfer_dots/README.md","mtime":"2018-12-08T14:32:44.450Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-08T14:36:23.372Z"},"basePath":"../../..","book":{"language":""}});
});
</script>
</div>
docs/examples/promise/08_system_events/index.html
+31 -31
View File
@@ -1122,9 +1122,9 @@
</li>
<li class="chapter " data-level="4.58" data-path="../../../types/classes/_metadata_.callmetadata.html">
<li class="chapter " data-level="4.58" data-path="../../../types/classes/_metadata_.callmetadata.md">
<a href="../../../types/classes/_metadata_.callmetadata.html">
<span>
hidden
@@ -1135,9 +1135,9 @@
</li>
<li class="chapter " data-level="4.59" data-path="../../../types/classes/_metadata_.eventmetadata.html">
<li class="chapter " data-level="4.59" data-path="../../../types/classes/_metadata_.eventmetadata.md">
<a href="../../../types/classes/_metadata_.eventmetadata.html">
<span>
hidden
@@ -1148,9 +1148,9 @@
</li>
<li class="chapter " data-level="4.60" data-path="../../../types/classes/_metadata_.functionargumentmetadata.html">
<li class="chapter " data-level="4.60" data-path="../../../types/classes/_metadata_.functionargumentmetadata.md">
<a href="../../../types/classes/_metadata_.functionargumentmetadata.html">
<span>
hidden
@@ -1161,9 +1161,9 @@
</li>
<li class="chapter " data-level="4.61" data-path="../../../types/classes/_metadata_.functionmetadata.html">
<li class="chapter " data-level="4.61" data-path="../../../types/classes/_metadata_.functionmetadata.md">
<a href="../../../types/classes/_metadata_.functionmetadata.html">
<span>
hidden
@@ -1174,9 +1174,9 @@
</li>
<li class="chapter " data-level="4.62" data-path="../../../types/classes/_metadata_.modulemetadata.html">
<li class="chapter " data-level="4.62" data-path="../../../types/classes/_metadata_.modulemetadata.md">
<a href="../../../types/classes/_metadata_.modulemetadata.html">
<span>
hidden
@@ -1187,9 +1187,9 @@
</li>
<li class="chapter " data-level="4.63" data-path="../../../types/classes/_metadata_.outerdispatchcall.html">
<li class="chapter " data-level="4.63" data-path="../../../types/classes/_metadata_.outerdispatchcall.md">
<a href="../../../types/classes/_metadata_.outerdispatchcall.html">
<span>
hidden
@@ -1200,9 +1200,9 @@
</li>
<li class="chapter " data-level="4.64" data-path="../../../types/classes/_metadata_.outerdispatchmetadata.html">
<li class="chapter " data-level="4.64" data-path="../../../types/classes/_metadata_.outerdispatchmetadata.md">
<a href="../../../types/classes/_metadata_.outerdispatchmetadata.html">
<span>
hidden
@@ -1213,9 +1213,9 @@
</li>
<li class="chapter " data-level="4.65" data-path="../../../types/classes/_metadata_.outereventmetadata.html">
<li class="chapter " data-level="4.65" data-path="../../../types/classes/_metadata_.outereventmetadata.md">
<a href="../../../types/classes/_metadata_.outereventmetadata.html">
<span>
hidden
@@ -1226,9 +1226,9 @@
</li>
<li class="chapter " data-level="4.66" data-path="../../../types/classes/_metadata_.outereventmetadataevent.html">
<li class="chapter " data-level="4.66" data-path="../../../types/classes/_metadata_.outereventmetadataevent.md">
<a href="../../../types/classes/_metadata_.outereventmetadataevent.html">
<span>
hidden
@@ -1252,9 +1252,9 @@
</li>
<li class="chapter " data-level="4.68" data-path="../../../types/classes/_metadata_.runtimemodulemetadata.html">
<li class="chapter " data-level="4.68" data-path="../../../types/classes/_metadata_.runtimemodulemetadata.md">
<a href="../../../types/classes/_metadata_.runtimemodulemetadata.html">
<span>
hidden
@@ -1265,9 +1265,9 @@
</li>
<li class="chapter " data-level="4.69" data-path="../../../types/classes/_metadata_.storagefunctionmetadata.html">
<li class="chapter " data-level="4.69" data-path="../../../types/classes/_metadata_.storagefunctionmetadata.md">
<a href="../../../types/classes/_metadata_.storagefunctionmetadata.html">
<span>
hidden
@@ -1278,9 +1278,9 @@
</li>
<li class="chapter " data-level="4.70" data-path="../../../types/classes/_metadata_.storagefunctionmodifier.html">
<li class="chapter " data-level="4.70" data-path="../../../types/classes/_metadata_.storagefunctionmodifier.md">
<a href="../../../types/classes/_metadata_.storagefunctionmodifier.html">
<span>
hidden
@@ -1291,9 +1291,9 @@
</li>
<li class="chapter " data-level="4.71" data-path="../../../types/classes/_metadata_.storagefunctiontype.html">
<li class="chapter " data-level="4.71" data-path="../../../types/classes/_metadata_.storagefunctiontype.md">
<a href="../../../types/classes/_metadata_.storagefunctiontype.html">
<span>
hidden
@@ -1304,9 +1304,9 @@
</li>
<li class="chapter " data-level="4.72" data-path="../../../types/classes/_metadata_.storagefunctiontype_map.html">
<li class="chapter " data-level="4.72" data-path="../../../types/classes/_metadata_.storagefunctiontype_map.md">
<a href="../../../types/classes/_metadata_.storagefunctiontype_map.html">
<span>
hidden
@@ -1317,9 +1317,9 @@
</li>
<li class="chapter " data-level="4.73" data-path="../../../types/classes/_metadata_.storagemetadata.html">
<li class="chapter " data-level="4.73" data-path="../../../types/classes/_metadata_.storagemetadata.md">
<a href="../../../types/classes/_metadata_.storagemetadata.html">
<span>
hidden
@@ -2039,7 +2039,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Display system events","level":"3.1.6","depth":2,"next":{"title":"hidden","level":"4.1","depth":1,"path":"types/classes/_accountid_.accountid.md","ref":"types/classes/_accountid_.accountid.md","articles":[]},"previous":{"title":"Make a transfer","level":"3.1.5","depth":2,"path":"examples/promise/07_transfer_dots/README.md","ref":"examples/promise/07_transfer_dots/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/08_system_events/README.md","mtime":"2018-12-07T11:31:10.054Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-07T11:34:45.610Z"},"basePath":"../../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"Display system events","level":"3.1.6","depth":2,"next":{"title":"hidden","level":"4.1","depth":1,"path":"types/classes/_accountid_.accountid.md","ref":"types/classes/_accountid_.accountid.md","articles":[]},"previous":{"title":"Make a transfer","level":"3.1.5","depth":2,"path":"examples/promise/07_transfer_dots/README.md","ref":"examples/promise/07_transfer_dots/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/08_system_events/README.md","mtime":"2018-12-08T14:32:44.450Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-08T14:36:23.372Z"},"basePath":"../../..","book":{"language":""}});
});
</script>
</div>
docs/examples/promise/index.html
+31 -31
View File
@@ -1122,9 +1122,9 @@
</li>
<li class="chapter " data-level="4.58" data-path="../../types/classes/_metadata_.callmetadata.html">
<li class="chapter " data-level="4.58" data-path="../../types/classes/_metadata_.callmetadata.md">
<a href="../../types/classes/_metadata_.callmetadata.html">
<span>
hidden
@@ -1135,9 +1135,9 @@
</li>
<li class="chapter " data-level="4.59" data-path="../../types/classes/_metadata_.eventmetadata.html">
<li class="chapter " data-level="4.59" data-path="../../types/classes/_metadata_.eventmetadata.md">
<a href="../../types/classes/_metadata_.eventmetadata.html">
<span>
hidden
@@ -1148,9 +1148,9 @@
</li>
<li class="chapter " data-level="4.60" data-path="../../types/classes/_metadata_.functionargumentmetadata.html">
<li class="chapter " data-level="4.60" data-path="../../types/classes/_metadata_.functionargumentmetadata.md">
<a href="../../types/classes/_metadata_.functionargumentmetadata.html">
<span>
hidden
@@ -1161,9 +1161,9 @@
</li>
<li class="chapter " data-level="4.61" data-path="../../types/classes/_metadata_.functionmetadata.html">
<li class="chapter " data-level="4.61" data-path="../../types/classes/_metadata_.functionmetadata.md">
<a href="../../types/classes/_metadata_.functionmetadata.html">
<span>
hidden
@@ -1174,9 +1174,9 @@
</li>
<li class="chapter " data-level="4.62" data-path="../../types/classes/_metadata_.modulemetadata.html">
<li class="chapter " data-level="4.62" data-path="../../types/classes/_metadata_.modulemetadata.md">
<a href="../../types/classes/_metadata_.modulemetadata.html">
<span>
hidden
@@ -1187,9 +1187,9 @@
</li>
<li class="chapter " data-level="4.63" data-path="../../types/classes/_metadata_.outerdispatchcall.html">
<li class="chapter " data-level="4.63" data-path="../../types/classes/_metadata_.outerdispatchcall.md">
<a href="../../types/classes/_metadata_.outerdispatchcall.html">
<span>
hidden
@@ -1200,9 +1200,9 @@
</li>
<li class="chapter " data-level="4.64" data-path="../../types/classes/_metadata_.outerdispatchmetadata.html">
<li class="chapter " data-level="4.64" data-path="../../types/classes/_metadata_.outerdispatchmetadata.md">
<a href="../../types/classes/_metadata_.outerdispatchmetadata.html">
<span>
hidden
@@ -1213,9 +1213,9 @@
</li>
<li class="chapter " data-level="4.65" data-path="../../types/classes/_metadata_.outereventmetadata.html">
<li class="chapter " data-level="4.65" data-path="../../types/classes/_metadata_.outereventmetadata.md">
<a href="../../types/classes/_metadata_.outereventmetadata.html">
<span>
hidden
@@ -1226,9 +1226,9 @@
</li>
<li class="chapter " data-level="4.66" data-path="../../types/classes/_metadata_.outereventmetadataevent.html">
<li class="chapter " data-level="4.66" data-path="../../types/classes/_metadata_.outereventmetadataevent.md">
<a href="../../types/classes/_metadata_.outereventmetadataevent.html">
<span>
hidden
@@ -1252,9 +1252,9 @@
</li>
<li class="chapter " data-level="4.68" data-path="../../types/classes/_metadata_.runtimemodulemetadata.html">
<li class="chapter " data-level="4.68" data-path="../../types/classes/_metadata_.runtimemodulemetadata.md">
<a href="../../types/classes/_metadata_.runtimemodulemetadata.html">
<span>
hidden
@@ -1265,9 +1265,9 @@
</li>
<li class="chapter " data-level="4.69" data-path="../../types/classes/_metadata_.storagefunctionmetadata.html">
<li class="chapter " data-level="4.69" data-path="../../types/classes/_metadata_.storagefunctionmetadata.md">
<a href="../../types/classes/_metadata_.storagefunctionmetadata.html">
<span>
hidden
@@ -1278,9 +1278,9 @@
</li>
<li class="chapter " data-level="4.70" data-path="../../types/classes/_metadata_.storagefunctionmodifier.html">
<li class="chapter " data-level="4.70" data-path="../../types/classes/_metadata_.storagefunctionmodifier.md">
<a href="../../types/classes/_metadata_.storagefunctionmodifier.html">
<span>
hidden
@@ -1291,9 +1291,9 @@
</li>
<li class="chapter " data-level="4.71" data-path="../../types/classes/_metadata_.storagefunctiontype.html">
<li class="chapter " data-level="4.71" data-path="../../types/classes/_metadata_.storagefunctiontype.md">
<a href="../../types/classes/_metadata_.storagefunctiontype.html">
<span>
hidden
@@ -1304,9 +1304,9 @@
</li>
<li class="chapter " data-level="4.72" data-path="../../types/classes/_metadata_.storagefunctiontype_map.html">
<li class="chapter " data-level="4.72" data-path="../../types/classes/_metadata_.storagefunctiontype_map.md">
<a href="../../types/classes/_metadata_.storagefunctiontype_map.html">
<span>
hidden
@@ -1317,9 +1317,9 @@
</li>
<li class="chapter " data-level="4.73" data-path="../../types/classes/_metadata_.storagemetadata.html">
<li class="chapter " data-level="4.73" data-path="../../types/classes/_metadata_.storagemetadata.md">
<a href="../../types/classes/_metadata_.storagemetadata.html">
<span>
hidden
@@ -2018,7 +2018,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"ApiPromise","level":"3.1","depth":1,"next":{"title":"Simple connect","level":"3.1.1","depth":2,"path":"examples/promise/01_simple_connect/README.md","ref":"examples/promise/01_simple_connect/README.md","articles":[]},"previous":{"title":"Events (runtime)","level":"2.4","depth":1,"path":"METHODS_EVENTS.md","ref":"METHODS_EVENTS.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/README.md","mtime":"2018-12-07T11:31:10.054Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-07T11:34:45.610Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"ApiPromise","level":"3.1","depth":1,"next":{"title":"Simple connect","level":"3.1.1","depth":2,"path":"examples/promise/01_simple_connect/README.md","ref":"examples/promise/01_simple_connect/README.md","articles":[]},"previous":{"title":"Events (runtime)","level":"2.4","depth":1,"path":"METHODS_EVENTS.md","ref":"METHODS_EVENTS.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/README.md","mtime":"2018-12-08T14:32:44.450Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-08T14:36:23.372Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/index.html
+31 -31
View File
@@ -1120,9 +1120,9 @@
</li>
<li class="chapter " data-level="4.58" data-path="types/classes/_metadata_.callmetadata.html">
<li class="chapter " data-level="4.58" data-path="types/classes/_metadata_.callmetadata.md">
<a href="types/classes/_metadata_.callmetadata.html">
<span>
hidden
@@ -1133,9 +1133,9 @@
</li>
<li class="chapter " data-level="4.59" data-path="types/classes/_metadata_.eventmetadata.html">
<li class="chapter " data-level="4.59" data-path="types/classes/_metadata_.eventmetadata.md">
<a href="types/classes/_metadata_.eventmetadata.html">
<span>
hidden
@@ -1146,9 +1146,9 @@
</li>
<li class="chapter " data-level="4.60" data-path="types/classes/_metadata_.functionargumentmetadata.html">
<li class="chapter " data-level="4.60" data-path="types/classes/_metadata_.functionargumentmetadata.md">
<a href="types/classes/_metadata_.functionargumentmetadata.html">
<span>
hidden
@@ -1159,9 +1159,9 @@
</li>
<li class="chapter " data-level="4.61" data-path="types/classes/_metadata_.functionmetadata.html">
<li class="chapter " data-level="4.61" data-path="types/classes/_metadata_.functionmetadata.md">
<a href="types/classes/_metadata_.functionmetadata.html">
<span>
hidden
@@ -1172,9 +1172,9 @@
</li>
<li class="chapter " data-level="4.62" data-path="types/classes/_metadata_.modulemetadata.html">
<li class="chapter " data-level="4.62" data-path="types/classes/_metadata_.modulemetadata.md">
<a href="types/classes/_metadata_.modulemetadata.html">
<span>
hidden
@@ -1185,9 +1185,9 @@
</li>
<li class="chapter " data-level="4.63" data-path="types/classes/_metadata_.outerdispatchcall.html">
<li class="chapter " data-level="4.63" data-path="types/classes/_metadata_.outerdispatchcall.md">
<a href="types/classes/_metadata_.outerdispatchcall.html">
<span>
hidden
@@ -1198,9 +1198,9 @@
</li>
<li class="chapter " data-level="4.64" data-path="types/classes/_metadata_.outerdispatchmetadata.html">
<li class="chapter " data-level="4.64" data-path="types/classes/_metadata_.outerdispatchmetadata.md">
<a href="types/classes/_metadata_.outerdispatchmetadata.html">
<span>
hidden
@@ -1211,9 +1211,9 @@
</li>
<li class="chapter " data-level="4.65" data-path="types/classes/_metadata_.outereventmetadata.html">
<li class="chapter " data-level="4.65" data-path="types/classes/_metadata_.outereventmetadata.md">
<a href="types/classes/_metadata_.outereventmetadata.html">
<span>
hidden
@@ -1224,9 +1224,9 @@
</li>
<li class="chapter " data-level="4.66" data-path="types/classes/_metadata_.outereventmetadataevent.html">
<li class="chapter " data-level="4.66" data-path="types/classes/_metadata_.outereventmetadataevent.md">
<a href="types/classes/_metadata_.outereventmetadataevent.html">
<span>
hidden
@@ -1250,9 +1250,9 @@
</li>
<li class="chapter " data-level="4.68" data-path="types/classes/_metadata_.runtimemodulemetadata.html">
<li class="chapter " data-level="4.68" data-path="types/classes/_metadata_.runtimemodulemetadata.md">
<a href="types/classes/_metadata_.runtimemodulemetadata.html">
<span>
hidden
@@ -1263,9 +1263,9 @@
</li>
<li class="chapter " data-level="4.69" data-path="types/classes/_metadata_.storagefunctionmetadata.html">
<li class="chapter " data-level="4.69" data-path="types/classes/_metadata_.storagefunctionmetadata.md">
<a href="types/classes/_metadata_.storagefunctionmetadata.html">
<span>
hidden
@@ -1276,9 +1276,9 @@
</li>
<li class="chapter " data-level="4.70" data-path="types/classes/_metadata_.storagefunctionmodifier.html">
<li class="chapter " data-level="4.70" data-path="types/classes/_metadata_.storagefunctionmodifier.md">
<a href="types/classes/_metadata_.storagefunctionmodifier.html">
<span>
hidden
@@ -1289,9 +1289,9 @@
</li>
<li class="chapter " data-level="4.71" data-path="types/classes/_metadata_.storagefunctiontype.html">
<li class="chapter " data-level="4.71" data-path="types/classes/_metadata_.storagefunctiontype.md">
<a href="types/classes/_metadata_.storagefunctiontype.html">
<span>
hidden
@@ -1302,9 +1302,9 @@
</li>
<li class="chapter " data-level="4.72" data-path="types/classes/_metadata_.storagefunctiontype_map.html">
<li class="chapter " data-level="4.72" data-path="types/classes/_metadata_.storagefunctiontype_map.md">
<a href="types/classes/_metadata_.storagefunctiontype_map.html">
<span>
hidden
@@ -1315,9 +1315,9 @@
</li>
<li class="chapter " data-level="4.73" data-path="types/classes/_metadata_.storagemetadata.html">
<li class="chapter " data-level="4.73" data-path="types/classes/_metadata_.storagemetadata.md">
<a href="types/classes/_metadata_.storagemetadata.html">
<span>
hidden
@@ -2011,7 +2011,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Introduction","level":"1.1","depth":1,"next":{"title":"api","level":"1.2","depth":1,"path":"api/README.md","ref":"api/README.md","articles":[{"title":"ApiPromise","level":"1.2.1","depth":2,"path":"api/classes/_promise_index_.apipromise.md","ref":"api/classes/_promise_index_.apipromise.md","articles":[]},{"title":"ApiRx","level":"1.2.2","depth":2,"path":"api/classes/_rx_index_.apirx.md","ref":"api/classes/_rx_index_.apirx.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"README.md","mtime":"2018-12-07T11:31:10.042Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-07T11:34:45.610Z"},"basePath":".","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"Introduction","level":"1.1","depth":1,"next":{"title":"api","level":"1.2","depth":1,"path":"api/README.md","ref":"api/README.md","articles":[{"title":"ApiPromise","level":"1.2.1","depth":2,"path":"api/classes/_promise_index_.apipromise.md","ref":"api/classes/_promise_index_.apipromise.md","articles":[]},{"title":"ApiRx","level":"1.2.2","depth":2,"path":"api/classes/_rx_index_.apirx.md","ref":"api/classes/_rx_index_.apirx.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"README.md","mtime":"2018-12-08T14:32:44.438Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-08T14:36:23.372Z"},"basePath":".","book":{"language":""}});
});
</script>
</div>
docs/rpc-core/classes/_index_.rpc.md
+7 -7
View File
@@ -38,7 +38,7 @@ const api = new Api(provider);
⊕ **new Rpc**(provider?: *`ProviderInterface`*): [Rpc](_index_.rpc.md)
*Defined in [index.ts:46](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-core/src/index.ts#L46)*
*Defined in [index.ts:46](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-core/src/index.ts#L46)*
*__constructor__*: Default constructor for the Api Object
@@ -60,7 +60,7 @@ ___
**● _provider**: *`ProviderInterface`*
*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-core/src/index.ts#L42)*
*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-core/src/index.ts#L42)*
___
<a id="author"></a>
@@ -71,7 +71,7 @@ ___
*Implementation of [RpcInterface](../interfaces/_types_.rpcinterface.md).[author](../interfaces/_types_.rpcinterface.md#author)*
*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-core/src/index.ts#L43)*
*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-core/src/index.ts#L43)*
___
<a id="chain"></a>
@@ -82,7 +82,7 @@ ___
*Implementation of [RpcInterface](../interfaces/_types_.rpcinterface.md).[chain](../interfaces/_types_.rpcinterface.md#chain)*
*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-core/src/index.ts#L44)*
*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-core/src/index.ts#L44)*
___
<a id="state"></a>
@@ -93,7 +93,7 @@ ___
*Implementation of [RpcInterface](../interfaces/_types_.rpcinterface.md).[state](../interfaces/_types_.rpcinterface.md#state)*
*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-core/src/index.ts#L45)*
*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-core/src/index.ts#L45)*
___
<a id="system"></a>
@@ -104,7 +104,7 @@ ___
*Implementation of [RpcInterface](../interfaces/_types_.rpcinterface.md).[system](../interfaces/_types_.rpcinterface.md#system)*
*Defined in [index.ts:46](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-core/src/index.ts#L46)*
*Defined in [index.ts:46](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-core/src/index.ts#L46)*
___
@@ -116,7 +116,7 @@ ___
▸ **signature**(__namedParameters: *`object`*): `string`
*Defined in [index.ts:79](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-core/src/index.ts#L79)*
*Defined in [index.ts:79](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-core/src/index.ts#L79)*
*__name__*: signature
docs/rpc-core/interfaces/_types_.rpcinterface.md
+4 -4
View File
@@ -16,7 +16,7 @@
**● author**: *[RpcInterface$Section](../modules/_types_.md#rpcinterface_section)*
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-core/src/types.ts#L17)*
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-core/src/types.ts#L17)*
___
<a id="chain"></a>
@@ -25,7 +25,7 @@ ___
**● chain**: *[RpcInterface$Section](../modules/_types_.md#rpcinterface_section)*
*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-core/src/types.ts#L18)*
*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-core/src/types.ts#L18)*
___
<a id="state"></a>
@@ -34,7 +34,7 @@ ___
**● state**: *[RpcInterface$Section](../modules/_types_.md#rpcinterface_section)*
*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-core/src/types.ts#L19)*
*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-core/src/types.ts#L19)*
___
<a id="system"></a>
@@ -43,7 +43,7 @@ ___
**● system**: *[RpcInterface$Section](../modules/_types_.md#rpcinterface_section)*
*Defined in [types.ts:20](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-core/src/types.ts#L20)*
*Defined in [types.ts:20](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-core/src/types.ts#L20)*
___
docs/rpc-core/interfaces/_types_.rpcinterface_section_method.md
+3 -3
View File
@@ -7,7 +7,7 @@
# Callable
▸ **__call**(...params: *`Array`<`any`>*): `Promise`<`any`>
*Defined in [types.ts:5](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-core/src/types.ts#L5)*
*Defined in [types.ts:5](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-core/src/types.ts#L5)*
**Parameters:**
@@ -25,7 +25,7 @@
**● subscription**: *`string`*
*Defined in [types.ts:8](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-core/src/types.ts#L8)*
*Defined in [types.ts:8](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-core/src/types.ts#L8)*
___
<a id="unsubscribe"></a>
@@ -34,7 +34,7 @@ ___
**● unsubscribe**: *`function`*
*Defined in [types.ts:9](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-core/src/types.ts#L9)*
*Defined in [types.ts:9](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-core/src/types.ts#L9)*
#### Type declaration
▸(id: *`number`*): `Promise`<`any`>
docs/rpc-core/modules/_types_.md
+1 -1
View File
@@ -21,7 +21,7 @@
**Ƭ RpcInterface$Section**: *`object`*
*Defined in [types.ts:12](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-core/src/types.ts#L12)*
*Defined in [types.ts:12](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-core/src/types.ts#L12)*
#### Type declaration
docs/rpc-provider/classes/_coder_index_.rpccoder.md
+4 -4
View File
@@ -12,7 +12,7 @@
▸ **decodeResponse**(response: *[JsonRpcResponse](../modules/_types_.md#jsonrpcresponse)*): `any`
*Defined in [coder/index.ts:12](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/coder/index.ts#L12)*
*Defined in [coder/index.ts:12](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/coder/index.ts#L12)*
**Parameters:**
@@ -29,7 +29,7 @@ ___
▸ **encodeJson**(method: *`string`*, params: * `any` &#124; `Array`<`any`>*): `string`
*Defined in [coder/index.ts:33](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/coder/index.ts#L33)*
*Defined in [coder/index.ts:33](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/coder/index.ts#L33)*
**Parameters:**
@@ -47,7 +47,7 @@ ___
▸ **encodeObject**(method: *`string`*, params: * `any` &#124; `Array`<`any`>*): [JsonRpcRequest](../modules/_types_.md#jsonrpcrequest)
*Defined in [coder/index.ts:39](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/coder/index.ts#L39)*
*Defined in [coder/index.ts:39](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/coder/index.ts#L39)*
**Parameters:**
@@ -65,7 +65,7 @@ ___
▸ **getId**(): `number`
*Defined in [coder/index.ts:48](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/coder/index.ts#L48)*
*Defined in [coder/index.ts:48](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/coder/index.ts#L48)*
**Returns:** `number`
docs/rpc-provider/classes/_http_index_.httpprovider.html
+38 -38
View File
@@ -1122,9 +1122,9 @@
</li>
<li class="chapter " data-level="4.58" data-path="../../types/classes/_metadata_.callmetadata.html">
<li class="chapter " data-level="4.58" data-path="../../types/classes/_metadata_.callmetadata.md">
<a href="../../types/classes/_metadata_.callmetadata.html">
<span>
hidden
@@ -1135,9 +1135,9 @@
</li>
<li class="chapter " data-level="4.59" data-path="../../types/classes/_metadata_.eventmetadata.html">
<li class="chapter " data-level="4.59" data-path="../../types/classes/_metadata_.eventmetadata.md">
<a href="../../types/classes/_metadata_.eventmetadata.html">
<span>
hidden
@@ -1148,9 +1148,9 @@
</li>
<li class="chapter " data-level="4.60" data-path="../../types/classes/_metadata_.functionargumentmetadata.html">
<li class="chapter " data-level="4.60" data-path="../../types/classes/_metadata_.functionargumentmetadata.md">
<a href="../../types/classes/_metadata_.functionargumentmetadata.html">
<span>
hidden
@@ -1161,9 +1161,9 @@
</li>
<li class="chapter " data-level="4.61" data-path="../../types/classes/_metadata_.functionmetadata.html">
<li class="chapter " data-level="4.61" data-path="../../types/classes/_metadata_.functionmetadata.md">
<a href="../../types/classes/_metadata_.functionmetadata.html">
<span>
hidden
@@ -1174,9 +1174,9 @@
</li>
<li class="chapter " data-level="4.62" data-path="../../types/classes/_metadata_.modulemetadata.html">
<li class="chapter " data-level="4.62" data-path="../../types/classes/_metadata_.modulemetadata.md">
<a href="../../types/classes/_metadata_.modulemetadata.html">
<span>
hidden
@@ -1187,9 +1187,9 @@
</li>
<li class="chapter " data-level="4.63" data-path="../../types/classes/_metadata_.outerdispatchcall.html">
<li class="chapter " data-level="4.63" data-path="../../types/classes/_metadata_.outerdispatchcall.md">
<a href="../../types/classes/_metadata_.outerdispatchcall.html">
<span>
hidden
@@ -1200,9 +1200,9 @@
</li>
<li class="chapter " data-level="4.64" data-path="../../types/classes/_metadata_.outerdispatchmetadata.html">
<li class="chapter " data-level="4.64" data-path="../../types/classes/_metadata_.outerdispatchmetadata.md">
<a href="../../types/classes/_metadata_.outerdispatchmetadata.html">
<span>
hidden
@@ -1213,9 +1213,9 @@
</li>
<li class="chapter " data-level="4.65" data-path="../../types/classes/_metadata_.outereventmetadata.html">
<li class="chapter " data-level="4.65" data-path="../../types/classes/_metadata_.outereventmetadata.md">
<a href="../../types/classes/_metadata_.outereventmetadata.html">
<span>
hidden
@@ -1226,9 +1226,9 @@
</li>
<li class="chapter " data-level="4.66" data-path="../../types/classes/_metadata_.outereventmetadataevent.html">
<li class="chapter " data-level="4.66" data-path="../../types/classes/_metadata_.outereventmetadataevent.md">
<a href="../../types/classes/_metadata_.outereventmetadataevent.html">
<span>
hidden
@@ -1252,9 +1252,9 @@
</li>
<li class="chapter " data-level="4.68" data-path="../../types/classes/_metadata_.runtimemodulemetadata.html">
<li class="chapter " data-level="4.68" data-path="../../types/classes/_metadata_.runtimemodulemetadata.md">
<a href="../../types/classes/_metadata_.runtimemodulemetadata.html">
<span>
hidden
@@ -1265,9 +1265,9 @@
</li>
<li class="chapter " data-level="4.69" data-path="../../types/classes/_metadata_.storagefunctionmetadata.html">
<li class="chapter " data-level="4.69" data-path="../../types/classes/_metadata_.storagefunctionmetadata.md">
<a href="../../types/classes/_metadata_.storagefunctionmetadata.html">
<span>
hidden
@@ -1278,9 +1278,9 @@
</li>
<li class="chapter " data-level="4.70" data-path="../../types/classes/_metadata_.storagefunctionmodifier.html">
<li class="chapter " data-level="4.70" data-path="../../types/classes/_metadata_.storagefunctionmodifier.md">
<a href="../../types/classes/_metadata_.storagefunctionmodifier.html">
<span>
hidden
@@ -1291,9 +1291,9 @@
</li>
<li class="chapter " data-level="4.71" data-path="../../types/classes/_metadata_.storagefunctiontype.html">
<li class="chapter " data-level="4.71" data-path="../../types/classes/_metadata_.storagefunctiontype.md">
<a href="../../types/classes/_metadata_.storagefunctiontype.html">
<span>
hidden
@@ -1304,9 +1304,9 @@
</li>
<li class="chapter " data-level="4.72" data-path="../../types/classes/_metadata_.storagefunctiontype_map.html">
<li class="chapter " data-level="4.72" data-path="../../types/classes/_metadata_.storagefunctiontype_map.md">
<a href="../../types/classes/_metadata_.storagefunctiontype_map.html">
<span>
hidden
@@ -1317,9 +1317,9 @@
</li>
<li class="chapter " data-level="4.73" data-path="../../types/classes/_metadata_.storagemetadata.html">
<li class="chapter " data-level="4.73" data-path="../../types/classes/_metadata_.storagemetadata.md">
<a href="../../types/classes/_metadata_.storagemetadata.html">
<span>
hidden
@@ -1981,7 +1981,7 @@
<p><a id="constructor"></a></p>
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new HttpProvider</strong>(endpoint?: <em><code>string</code></em>): <a href="_http_index_.httpprovider.html">HttpProvider</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/http/index.ts#L40" target="_blank">http/index.ts:40</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/http/index.ts#L40" target="_blank">http/index.ts:40</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2007,7 +2007,7 @@
<p><a id="hassubscriptions"></a></p>
<h2 id="hassubscriptions">hasSubscriptions</h2>
<p>gethasSubscriptions(): <code>boolean</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/http/index.ts#L55" target="_blank">http/index.ts:55</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/http/index.ts#L55" target="_blank">http/index.ts:55</a></em></p>
<p><em><strong>summary</strong></em>: <code>true</code> when this provider supports subscriptions</p>
<p><strong>Returns:</strong> <code>boolean</code></p>
<hr>
@@ -2016,7 +2016,7 @@
<h2 id="isconnected">isConnected</h2>
<p>&#x25B8; <strong>isConnected</strong>(): <code>boolean</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.providerinterface.md">ProviderInterface</a>.<a href="../interfaces/_types_.providerinterface.md#isconnected">isConnected</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/http/index.ts#L63" target="_blank">http/index.ts:63</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/http/index.ts#L63" target="_blank">http/index.ts:63</a></em></p>
<p><em><strong>summary</strong></em>: Whether the node is connected or not.</p>
<p><strong>Returns:</strong> <code>boolean</code>
true if connected</p>
@@ -2025,7 +2025,7 @@ true if connected</p>
<h2 id="on">on</h2>
<p>&#x25B8; <strong>on</strong>(type: <em><a href="../modules/_types_.md#providerinterface_emitted">ProviderInterface$Emitted</a></em>, sub: <em><a href="../modules/_types_.md#providerinterface_emitcb">ProviderInterface$EmitCb</a></em>): <code>void</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.providerinterface.md">ProviderInterface</a>.<a href="../interfaces/_types_.providerinterface.md#on">on</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/http/index.ts#L71" target="_blank">http/index.ts:71</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/http/index.ts#L71" target="_blank">http/index.ts:71</a></em></p>
<p><em><strong>summary</strong></em>: Events are not supported with the HttpProvider, see <a href="_ws_index_.wsprovider.html">WsProvider</a>.</p>
<p><em><strong>description</strong></em>: HTTP Provider does not have &apos;on&apos; emitters. WebSockets should be used instead.</p>
<p><strong>Parameters:</strong></p>
@@ -2053,7 +2053,7 @@ true if connected</p>
<h2 id="send">send</h2>
<p>&#x25B8; <strong>send</strong>(method: <em><code>string</code></em>, params: <em><code>Array</code>&lt;<code>any</code>&gt;</em>): <code>Promise</code>&lt;<code>any</code>&gt;</p>
<p><em>Implementation of <a href="../interfaces/_types_.providerinterface.md">ProviderInterface</a>.<a href="../interfaces/_types_.providerinterface.md#send">send</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/http/index.ts#L78" target="_blank">http/index.ts:78</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/http/index.ts#L78" target="_blank">http/index.ts:78</a></em></p>
<p><em><strong>summary</strong></em>: Send HTTP POST Request with Body to configured HTTP Endpoint.</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2080,7 +2080,7 @@ true if connected</p>
<h2 id="subscribe">subscribe</h2>
<p>&#x25B8; <strong>subscribe</strong>(types: <em><code>string</code></em>, method: <em><code>string</code></em>, params: <em><code>Array</code>&lt;<code>any</code>&gt;</em>, cb: <em><a href="../modules/_types_.md#providerinterface_callback">ProviderInterface$Callback</a></em>): <code>Promise</code>&lt;<code>number</code>&gt;</p>
<p><em>Implementation of <a href="../interfaces/_types_.providerinterface.md">ProviderInterface</a>.<a href="../interfaces/_types_.providerinterface.md#subscribe">subscribe</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/http/index.ts#L100" target="_blank">http/index.ts:100</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/http/index.ts#L100" target="_blank">http/index.ts:100</a></em></p>
<p><em><strong>summary</strong></em>: Subscriptions are not supported with the HttpProvider, see <a href="_ws_index_.wsprovider.html">WsProvider</a>.</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2115,7 +2115,7 @@ true if connected</p>
<h2 id="unsubscribe">unsubscribe</h2>
<p>&#x25B8; <strong>unsubscribe</strong>(type: <em><code>string</code></em>, method: <em><code>string</code></em>, id: <em><code>number</code></em>): <code>Promise</code>&lt;<code>boolean</code>&gt;</p>
<p><em>Implementation of <a href="../interfaces/_types_.providerinterface.md">ProviderInterface</a>.<a href="../interfaces/_types_.providerinterface.md#unsubscribe">unsubscribe</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/http/index.ts#L109" target="_blank">http/index.ts:109</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/http/index.ts#L109" target="_blank">http/index.ts:109</a></em></p>
<p><em><strong>summary</strong></em>: Subscriptions are not supported with the HttpProvider, see <a href="_ws_index_.wsprovider.html">WsProvider</a>.</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2185,7 +2185,7 @@ true if connected</p>
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"HttpProvider","level":"1.3.1","depth":2,"next":{"title":"WsProvider","level":"1.3.2","depth":2,"path":"rpc-provider/classes/_ws_index_.wsprovider.md","ref":"rpc-provider/classes/_ws_index_.wsprovider.md","articles":[]},"previous":{"title":"rpc-provider","level":"1.3","depth":1,"path":"rpc-provider/README.md","ref":"rpc-provider/README.md","articles":[{"title":"HttpProvider","level":"1.3.1","depth":2,"path":"rpc-provider/classes/_http_index_.httpprovider.md","ref":"rpc-provider/classes/_http_index_.httpprovider.md","articles":[]},{"title":"WsProvider","level":"1.3.2","depth":2,"path":"rpc-provider/classes/_ws_index_.wsprovider.md","ref":"rpc-provider/classes/_ws_index_.wsprovider.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"rpc-provider/classes/_http_index_.httpprovider.md","mtime":"2018-12-07T11:33:33.559Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-07T11:34:45.610Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"HttpProvider","level":"1.3.1","depth":2,"next":{"title":"WsProvider","level":"1.3.2","depth":2,"path":"rpc-provider/classes/_ws_index_.wsprovider.md","ref":"rpc-provider/classes/_ws_index_.wsprovider.md","articles":[]},"previous":{"title":"rpc-provider","level":"1.3","depth":1,"path":"rpc-provider/README.md","ref":"rpc-provider/README.md","articles":[{"title":"HttpProvider","level":"1.3.1","depth":2,"path":"rpc-provider/classes/_http_index_.httpprovider.md","ref":"rpc-provider/classes/_http_index_.httpprovider.md","articles":[]},{"title":"WsProvider","level":"1.3.2","depth":2,"path":"rpc-provider/classes/_ws_index_.wsprovider.md","ref":"rpc-provider/classes/_ws_index_.wsprovider.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"rpc-provider/classes/_http_index_.httpprovider.md","mtime":"2018-12-08T14:35:11.227Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-08T14:36:23.372Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/rpc-provider/classes/_http_index_.httpprovider.md
+7 -7
View File
@@ -34,7 +34,7 @@ const api = new Api(provider);
⊕ **new HttpProvider**(endpoint?: *`string`*): [HttpProvider](_http_index_.httpprovider.md)
*Defined in [http/index.ts:40](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/http/index.ts#L40)*
*Defined in [http/index.ts:40](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/http/index.ts#L40)*
**Parameters:**
@@ -54,7 +54,7 @@ ___
gethasSubscriptions(): `boolean`
*Defined in [http/index.ts:55](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/http/index.ts#L55)*
*Defined in [http/index.ts:55](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/http/index.ts#L55)*
*__summary__*: `true` when this provider supports subscriptions
@@ -72,7 +72,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[isConnected](../interfaces/_types_.providerinterface.md#isconnected)*
*Defined in [http/index.ts:63](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/http/index.ts#L63)*
*Defined in [http/index.ts:63](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/http/index.ts#L63)*
*__summary__*: Whether the node is connected or not.
@@ -88,7 +88,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[on](../interfaces/_types_.providerinterface.md#on)*
*Defined in [http/index.ts:71](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/http/index.ts#L71)*
*Defined in [http/index.ts:71](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/http/index.ts#L71)*
*__summary__*: Events are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md).
@@ -112,7 +112,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[send](../interfaces/_types_.providerinterface.md#send)*
*Defined in [http/index.ts:78](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/http/index.ts#L78)*
*Defined in [http/index.ts:78](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/http/index.ts#L78)*
*__summary__*: Send HTTP POST Request with Body to configured HTTP Endpoint.
@@ -134,7 +134,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[subscribe](../interfaces/_types_.providerinterface.md#subscribe)*
*Defined in [http/index.ts:100](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/http/index.ts#L100)*
*Defined in [http/index.ts:100](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/http/index.ts#L100)*
*__summary__*: Subscriptions are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md).
@@ -158,7 +158,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[unsubscribe](../interfaces/_types_.providerinterface.md#unsubscribe)*
*Defined in [http/index.ts:109](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/http/index.ts#L109)*
*Defined in [http/index.ts:109](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/http/index.ts#L109)*
*__summary__*: Subscriptions are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md).
docs/rpc-provider/classes/_mock_index_.mock.md
+9 -9
View File
@@ -19,7 +19,7 @@ A mock provider mainly used for testing.
⊕ **new Mock**(): [Mock](_mock_index_.mock.md)
*Defined in [mock/index.ts:64](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/mock/index.ts#L64)*
*Defined in [mock/index.ts:64](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/mock/index.ts#L64)*
**Returns:** [Mock](_mock_index_.mock.md)
@@ -33,7 +33,7 @@ ___
**● isUpdating**: *`boolean`* = true
*Defined in [mock/index.ts:42](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/mock/index.ts#L42)*
*Defined in [mock/index.ts:42](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/mock/index.ts#L42)*
___
<a id="subscriptions"></a>
@@ -49,7 +49,7 @@ ___
return subs;
}, ({} as MockState$Subscriptions))
*Defined in [mock/index.ts:53](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/mock/index.ts#L53)*
*Defined in [mock/index.ts:53](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/mock/index.ts#L53)*
___
@@ -61,7 +61,7 @@ ___
gethasSubscriptions(): `boolean`
*Defined in [mock/index.ts:70](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/mock/index.ts#L70)*
*Defined in [mock/index.ts:70](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/mock/index.ts#L70)*
**Returns:** `boolean`
@@ -77,7 +77,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[isConnected](../interfaces/_types_.providerinterface.md#isconnected)*
*Defined in [mock/index.ts:74](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/mock/index.ts#L74)*
*Defined in [mock/index.ts:74](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/mock/index.ts#L74)*
**Returns:** `boolean`
@@ -90,7 +90,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[on](../interfaces/_types_.providerinterface.md#on)*
*Defined in [mock/index.ts:78](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/mock/index.ts#L78)*
*Defined in [mock/index.ts:78](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/mock/index.ts#L78)*
**Parameters:**
@@ -110,7 +110,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[send](../interfaces/_types_.providerinterface.md#send)*
*Defined in [mock/index.ts:82](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/mock/index.ts#L82)*
*Defined in [mock/index.ts:82](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/mock/index.ts#L82)*
**Parameters:**
@@ -128,7 +128,7 @@ ___
▸ **subscribe**(type: *`string`*, method: *`string`*, ...params: *`Array`<`any`>*): `Promise`<`number`>
*Defined in [mock/index.ts:90](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/mock/index.ts#L90)*
*Defined in [mock/index.ts:90](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/mock/index.ts#L90)*
**Parameters:**
@@ -149,7 +149,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[unsubscribe](../interfaces/_types_.providerinterface.md#unsubscribe)*
*Defined in [mock/index.ts:110](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/mock/index.ts#L110)*
*Defined in [mock/index.ts:110](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/mock/index.ts#L110)*
**Parameters:**
docs/rpc-provider/classes/_ws_index_.wsprovider.html
+39 -39
View File
@@ -1122,9 +1122,9 @@
</li>
<li class="chapter " data-level="4.58" data-path="../../types/classes/_metadata_.callmetadata.html">
<li class="chapter " data-level="4.58" data-path="../../types/classes/_metadata_.callmetadata.md">
<a href="../../types/classes/_metadata_.callmetadata.html">
<span>
hidden
@@ -1135,9 +1135,9 @@
</li>
<li class="chapter " data-level="4.59" data-path="../../types/classes/_metadata_.eventmetadata.html">
<li class="chapter " data-level="4.59" data-path="../../types/classes/_metadata_.eventmetadata.md">
<a href="../../types/classes/_metadata_.eventmetadata.html">
<span>
hidden
@@ -1148,9 +1148,9 @@
</li>
<li class="chapter " data-level="4.60" data-path="../../types/classes/_metadata_.functionargumentmetadata.html">
<li class="chapter " data-level="4.60" data-path="../../types/classes/_metadata_.functionargumentmetadata.md">
<a href="../../types/classes/_metadata_.functionargumentmetadata.html">
<span>
hidden
@@ -1161,9 +1161,9 @@
</li>
<li class="chapter " data-level="4.61" data-path="../../types/classes/_metadata_.functionmetadata.html">
<li class="chapter " data-level="4.61" data-path="../../types/classes/_metadata_.functionmetadata.md">
<a href="../../types/classes/_metadata_.functionmetadata.html">
<span>
hidden
@@ -1174,9 +1174,9 @@
</li>
<li class="chapter " data-level="4.62" data-path="../../types/classes/_metadata_.modulemetadata.html">
<li class="chapter " data-level="4.62" data-path="../../types/classes/_metadata_.modulemetadata.md">
<a href="../../types/classes/_metadata_.modulemetadata.html">
<span>
hidden
@@ -1187,9 +1187,9 @@
</li>
<li class="chapter " data-level="4.63" data-path="../../types/classes/_metadata_.outerdispatchcall.html">
<li class="chapter " data-level="4.63" data-path="../../types/classes/_metadata_.outerdispatchcall.md">
<a href="../../types/classes/_metadata_.outerdispatchcall.html">
<span>
hidden
@@ -1200,9 +1200,9 @@
</li>
<li class="chapter " data-level="4.64" data-path="../../types/classes/_metadata_.outerdispatchmetadata.html">
<li class="chapter " data-level="4.64" data-path="../../types/classes/_metadata_.outerdispatchmetadata.md">
<a href="../../types/classes/_metadata_.outerdispatchmetadata.html">
<span>
hidden
@@ -1213,9 +1213,9 @@
</li>
<li class="chapter " data-level="4.65" data-path="../../types/classes/_metadata_.outereventmetadata.html">
<li class="chapter " data-level="4.65" data-path="../../types/classes/_metadata_.outereventmetadata.md">
<a href="../../types/classes/_metadata_.outereventmetadata.html">
<span>
hidden
@@ -1226,9 +1226,9 @@
</li>
<li class="chapter " data-level="4.66" data-path="../../types/classes/_metadata_.outereventmetadataevent.html">
<li class="chapter " data-level="4.66" data-path="../../types/classes/_metadata_.outereventmetadataevent.md">
<a href="../../types/classes/_metadata_.outereventmetadataevent.html">
<span>
hidden
@@ -1252,9 +1252,9 @@
</li>
<li class="chapter " data-level="4.68" data-path="../../types/classes/_metadata_.runtimemodulemetadata.html">
<li class="chapter " data-level="4.68" data-path="../../types/classes/_metadata_.runtimemodulemetadata.md">
<a href="../../types/classes/_metadata_.runtimemodulemetadata.html">
<span>
hidden
@@ -1265,9 +1265,9 @@
</li>
<li class="chapter " data-level="4.69" data-path="../../types/classes/_metadata_.storagefunctionmetadata.html">
<li class="chapter " data-level="4.69" data-path="../../types/classes/_metadata_.storagefunctionmetadata.md">
<a href="../../types/classes/_metadata_.storagefunctionmetadata.html">
<span>
hidden
@@ -1278,9 +1278,9 @@
</li>
<li class="chapter " data-level="4.70" data-path="../../types/classes/_metadata_.storagefunctionmodifier.html">
<li class="chapter " data-level="4.70" data-path="../../types/classes/_metadata_.storagefunctionmodifier.md">
<a href="../../types/classes/_metadata_.storagefunctionmodifier.html">
<span>
hidden
@@ -1291,9 +1291,9 @@
</li>
<li class="chapter " data-level="4.71" data-path="../../types/classes/_metadata_.storagefunctiontype.html">
<li class="chapter " data-level="4.71" data-path="../../types/classes/_metadata_.storagefunctiontype.md">
<a href="../../types/classes/_metadata_.storagefunctiontype.html">
<span>
hidden
@@ -1304,9 +1304,9 @@
</li>
<li class="chapter " data-level="4.72" data-path="../../types/classes/_metadata_.storagefunctiontype_map.html">
<li class="chapter " data-level="4.72" data-path="../../types/classes/_metadata_.storagefunctiontype_map.md">
<a href="../../types/classes/_metadata_.storagefunctiontype_map.html">
<span>
hidden
@@ -1317,9 +1317,9 @@
</li>
<li class="chapter " data-level="4.73" data-path="../../types/classes/_metadata_.storagemetadata.html">
<li class="chapter " data-level="4.73" data-path="../../types/classes/_metadata_.storagemetadata.md">
<a href="../../types/classes/_metadata_.storagemetadata.html">
<span>
hidden
@@ -1981,7 +1981,7 @@
<p><a id="constructor"></a></p>
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new WsProvider</strong>(endpoint?: <em><code>string</code></em>, autoConnect?: <em><code>boolean</code></em>): <a href="_ws_index_.wsprovider.html">WsProvider</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/ws/index.ts#L75" target="_blank">ws/index.ts:75</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/ws/index.ts#L75" target="_blank">ws/index.ts:75</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2013,7 +2013,7 @@
<p><a id="hassubscriptions"></a></p>
<h2 id="hassubscriptions">hasSubscriptions</h2>
<p>gethasSubscriptions(): <code>boolean</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/ws/index.ts#L101" target="_blank">ws/index.ts:101</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/ws/index.ts#L101" target="_blank">ws/index.ts:101</a></em></p>
<p><em><strong>summary</strong></em>: <code>true</code> when this provider supports subscriptions</p>
<p><strong>Returns:</strong> <code>boolean</code></p>
<hr>
@@ -2021,7 +2021,7 @@
<p><a id="connect"></a></p>
<h2 id="connect">connect</h2>
<p>&#x25B8; <strong>connect</strong>(): <code>void</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/ws/index.ts#L110" target="_blank">ws/index.ts:110</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/ws/index.ts#L110" target="_blank">ws/index.ts:110</a></em></p>
<p><em><strong>summary</strong></em>: Manually connect</p>
<p><em><strong>description</strong></em>: The <a href="_ws_index_.wsprovider.html">WsProvider</a> connects automatically by default, however if you decided otherwise, you may connect manually using this method.</p>
<p><strong>Returns:</strong> <code>void</code></p>
@@ -2029,7 +2029,7 @@
<p><a id="isconnected"></a></p>
<h2 id="isconnected">isConnected</h2>
<p>&#x25B8; <strong>isConnected</strong>(): <code>boolean</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/ws/index.ts#L127" target="_blank">ws/index.ts:127</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/ws/index.ts#L127" target="_blank">ws/index.ts:127</a></em></p>
<p><em><strong>summary</strong></em>: Whether the node is connected or not.</p>
<p><strong>Returns:</strong> <code>boolean</code>
true if connected</p>
@@ -2037,7 +2037,7 @@ true if connected</p>
<p><a id="on"></a></p>
<h2 id="on">on</h2>
<p>&#x25B8; <strong>on</strong>(type: <em><a href="../modules/_types_.md#providerinterface_emitted">ProviderInterface$Emitted</a></em>, sub: <em><a href="../modules/_types_.md#providerinterface_emitcb">ProviderInterface$EmitCb</a></em>): <code>void</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/ws/index.ts#L136" target="_blank">ws/index.ts:136</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/ws/index.ts#L136" target="_blank">ws/index.ts:136</a></em></p>
<p><em><strong>summary</strong></em>: Listens on events after having subscribed using the <a href="_ws_index_.wsprovider.html#subscribe">subscribe</a> function.</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2066,7 +2066,7 @@ true if connected</p>
<p><a id="send"></a></p>
<h2 id="send">send</h2>
<p>&#x25B8; <strong>send</strong>(method: <em><code>string</code></em>, params: <em><code>Array</code>&lt;<code>any</code>&gt;</em>, subscription?: <em><code>SubscriptionHandler</code></em>): <code>Promise</code>&lt;<code>any</code>&gt;</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/ws/index.ts#L146" target="_blank">ws/index.ts:146</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/ws/index.ts#L146" target="_blank">ws/index.ts:146</a></em></p>
<p><em><strong>summary</strong></em>: Send JSON data using WebSockets to configured HTTP Endpoint or queue.</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2100,7 +2100,7 @@ true if connected</p>
<p><a id="subscribe"></a></p>
<h2 id="subscribe">subscribe</h2>
<p>&#x25B8; <strong>subscribe</strong>(type: <em><code>string</code></em>, method: <em><code>string</code></em>, params: <em><code>Array</code>&lt;<code>any</code>&gt;</em>, callback: <em><a href="../modules/_types_.md#providerinterface_callback">ProviderInterface$Callback</a></em>): <code>Promise</code>&lt;<code>number</code>&gt;</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/ws/index.ts#L202" target="_blank">ws/index.ts:202</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/ws/index.ts#L200" target="_blank">ws/index.ts:200</a></em></p>
<p><em><strong>name</strong></em>: subscribe</p>
<p><em><strong>summary</strong></em>: Allows subscribing to a specific event.</p>
<p><em><strong>example</strong></em>: </p>
@@ -2151,7 +2151,7 @@ Promise resolving to the dd of the subscription you can use with [[unsubscribe]]
<p><a id="unsubscribe"></a></p>
<h2 id="unsubscribe">unsubscribe</h2>
<p>&#x25B8; <strong>unsubscribe</strong>(type: <em><code>string</code></em>, method: <em><code>string</code></em>, id: <em><code>number</code></em>): <code>Promise</code>&lt;<code>boolean</code>&gt;</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/ws/index.ts#L211" target="_blank">ws/index.ts:211</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/ws/index.ts#L209" target="_blank">ws/index.ts:209</a></em></p>
<p><em><strong>summary</strong></em>: Allows unsubscribing to subscriptions made with <a href="_ws_index_.wsprovider.html#subscribe">subscribe</a>.</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2221,7 +2221,7 @@ Promise resolving to the dd of the subscription you can use with [[unsubscribe]]
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"WsProvider","level":"1.3.2","depth":2,"next":{"title":"types (codec implementation)","level":"1.4","depth":1,"path":"types/README.md","ref":"types/README.md","articles":[]},"previous":{"title":"HttpProvider","level":"1.3.1","depth":2,"path":"rpc-provider/classes/_http_index_.httpprovider.md","ref":"rpc-provider/classes/_http_index_.httpprovider.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"rpc-provider/classes/_ws_index_.wsprovider.md","mtime":"2018-12-07T11:33:33.659Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-07T11:34:45.610Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"WsProvider","level":"1.3.2","depth":2,"next":{"title":"types (codec implementation)","level":"1.4","depth":1,"path":"types/README.md","ref":"types/README.md","articles":[]},"previous":{"title":"HttpProvider","level":"1.3.1","depth":2,"path":"rpc-provider/classes/_http_index_.httpprovider.md","ref":"rpc-provider/classes/_http_index_.httpprovider.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"rpc-provider/classes/_ws_index_.wsprovider.md","mtime":"2018-12-08T14:35:11.355Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-08T14:36:23.372Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/rpc-provider/classes/_ws_index_.wsprovider.md
+8 -8
View File
@@ -34,7 +34,7 @@ const api = new Api(provider);
⊕ **new WsProvider**(endpoint?: *`string`*, autoConnect?: *`boolean`*): [WsProvider](_ws_index_.wsprovider.md)
*Defined in [ws/index.ts:75](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/ws/index.ts#L75)*
*Defined in [ws/index.ts:75](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/ws/index.ts#L75)*
**Parameters:**
@@ -55,7 +55,7 @@ ___
gethasSubscriptions(): `boolean`
*Defined in [ws/index.ts:101](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/ws/index.ts#L101)*
*Defined in [ws/index.ts:101](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/ws/index.ts#L101)*
*__summary__*: `true` when this provider supports subscriptions
@@ -71,7 +71,7 @@ ___
▸ **connect**(): `void`
*Defined in [ws/index.ts:110](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/ws/index.ts#L110)*
*Defined in [ws/index.ts:110](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/ws/index.ts#L110)*
*__summary__*: Manually connect
@@ -86,7 +86,7 @@ ___
▸ **isConnected**(): `boolean`
*Defined in [ws/index.ts:127](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/ws/index.ts#L127)*
*Defined in [ws/index.ts:127](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/ws/index.ts#L127)*
*__summary__*: Whether the node is connected or not.
@@ -100,7 +100,7 @@ ___
▸ **on**(type: *[ProviderInterface$Emitted](../modules/_types_.md#providerinterface_emitted)*, sub: *[ProviderInterface$EmitCb](../modules/_types_.md#providerinterface_emitcb)*): `void`
*Defined in [ws/index.ts:136](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/ws/index.ts#L136)*
*Defined in [ws/index.ts:136](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/ws/index.ts#L136)*
*__summary__*: Listens on events after having subscribed using the [subscribe](_ws_index_.wsprovider.md#subscribe) function.
@@ -120,7 +120,7 @@ ___
▸ **send**(method: *`string`*, params: *`Array`<`any`>*, subscription?: *`SubscriptionHandler`*): `Promise`<`any`>
*Defined in [ws/index.ts:146](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/ws/index.ts#L146)*
*Defined in [ws/index.ts:146](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/ws/index.ts#L146)*
*__summary__*: Send JSON data using WebSockets to configured HTTP Endpoint or queue.
@@ -141,7 +141,7 @@ ___
▸ **subscribe**(type: *`string`*, method: *`string`*, params: *`Array`<`any`>*, callback: *[ProviderInterface$Callback](../modules/_types_.md#providerinterface_callback)*): `Promise`<`number`>
*Defined in [ws/index.ts:202](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/ws/index.ts#L202)*
*Defined in [ws/index.ts:200](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/ws/index.ts#L200)*
*__name__*: subscribe
@@ -179,7 +179,7 @@ ___
▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`>
*Defined in [ws/index.ts:211](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/ws/index.ts#L211)*
*Defined in [ws/index.ts:209](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/ws/index.ts#L209)*
*__summary__*: Allows unsubscribing to subscriptions made with [subscribe](_ws_index_.wsprovider.md#subscribe).
docs/rpc-provider/index.html
+31 -31
View File
@@ -1122,9 +1122,9 @@
</li>
<li class="chapter " data-level="4.58" data-path="../types/classes/_metadata_.callmetadata.html">
<li class="chapter " data-level="4.58" data-path="../types/classes/_metadata_.callmetadata.md">
<a href="../types/classes/_metadata_.callmetadata.html">
<span>
hidden
@@ -1135,9 +1135,9 @@
</li>
<li class="chapter " data-level="4.59" data-path="../types/classes/_metadata_.eventmetadata.html">
<li class="chapter " data-level="4.59" data-path="../types/classes/_metadata_.eventmetadata.md">
<a href="../types/classes/_metadata_.eventmetadata.html">
<span>
hidden
@@ -1148,9 +1148,9 @@
</li>
<li class="chapter " data-level="4.60" data-path="../types/classes/_metadata_.functionargumentmetadata.html">
<li class="chapter " data-level="4.60" data-path="../types/classes/_metadata_.functionargumentmetadata.md">
<a href="../types/classes/_metadata_.functionargumentmetadata.html">
<span>
hidden
@@ -1161,9 +1161,9 @@
</li>
<li class="chapter " data-level="4.61" data-path="../types/classes/_metadata_.functionmetadata.html">
<li class="chapter " data-level="4.61" data-path="../types/classes/_metadata_.functionmetadata.md">
<a href="../types/classes/_metadata_.functionmetadata.html">
<span>
hidden
@@ -1174,9 +1174,9 @@
</li>
<li class="chapter " data-level="4.62" data-path="../types/classes/_metadata_.modulemetadata.html">
<li class="chapter " data-level="4.62" data-path="../types/classes/_metadata_.modulemetadata.md">
<a href="../types/classes/_metadata_.modulemetadata.html">
<span>
hidden
@@ -1187,9 +1187,9 @@
</li>
<li class="chapter " data-level="4.63" data-path="../types/classes/_metadata_.outerdispatchcall.html">
<li class="chapter " data-level="4.63" data-path="../types/classes/_metadata_.outerdispatchcall.md">
<a href="../types/classes/_metadata_.outerdispatchcall.html">
<span>
hidden
@@ -1200,9 +1200,9 @@
</li>
<li class="chapter " data-level="4.64" data-path="../types/classes/_metadata_.outerdispatchmetadata.html">
<li class="chapter " data-level="4.64" data-path="../types/classes/_metadata_.outerdispatchmetadata.md">
<a href="../types/classes/_metadata_.outerdispatchmetadata.html">
<span>
hidden
@@ -1213,9 +1213,9 @@
</li>
<li class="chapter " data-level="4.65" data-path="../types/classes/_metadata_.outereventmetadata.html">
<li class="chapter " data-level="4.65" data-path="../types/classes/_metadata_.outereventmetadata.md">
<a href="../types/classes/_metadata_.outereventmetadata.html">
<span>
hidden
@@ -1226,9 +1226,9 @@
</li>
<li class="chapter " data-level="4.66" data-path="../types/classes/_metadata_.outereventmetadataevent.html">
<li class="chapter " data-level="4.66" data-path="../types/classes/_metadata_.outereventmetadataevent.md">
<a href="../types/classes/_metadata_.outereventmetadataevent.html">
<span>
hidden
@@ -1252,9 +1252,9 @@
</li>
<li class="chapter " data-level="4.68" data-path="../types/classes/_metadata_.runtimemodulemetadata.html">
<li class="chapter " data-level="4.68" data-path="../types/classes/_metadata_.runtimemodulemetadata.md">
<a href="../types/classes/_metadata_.runtimemodulemetadata.html">
<span>
hidden
@@ -1265,9 +1265,9 @@
</li>
<li class="chapter " data-level="4.69" data-path="../types/classes/_metadata_.storagefunctionmetadata.html">
<li class="chapter " data-level="4.69" data-path="../types/classes/_metadata_.storagefunctionmetadata.md">
<a href="../types/classes/_metadata_.storagefunctionmetadata.html">
<span>
hidden
@@ -1278,9 +1278,9 @@
</li>
<li class="chapter " data-level="4.70" data-path="../types/classes/_metadata_.storagefunctionmodifier.html">
<li class="chapter " data-level="4.70" data-path="../types/classes/_metadata_.storagefunctionmodifier.md">
<a href="../types/classes/_metadata_.storagefunctionmodifier.html">
<span>
hidden
@@ -1291,9 +1291,9 @@
</li>
<li class="chapter " data-level="4.71" data-path="../types/classes/_metadata_.storagefunctiontype.html">
<li class="chapter " data-level="4.71" data-path="../types/classes/_metadata_.storagefunctiontype.md">
<a href="../types/classes/_metadata_.storagefunctiontype.html">
<span>
hidden
@@ -1304,9 +1304,9 @@
</li>
<li class="chapter " data-level="4.72" data-path="../types/classes/_metadata_.storagefunctiontype_map.html">
<li class="chapter " data-level="4.72" data-path="../types/classes/_metadata_.storagefunctiontype_map.md">
<a href="../types/classes/_metadata_.storagefunctiontype_map.html">
<span>
hidden
@@ -1317,9 +1317,9 @@
</li>
<li class="chapter " data-level="4.73" data-path="../types/classes/_metadata_.storagemetadata.html">
<li class="chapter " data-level="4.73" data-path="../types/classes/_metadata_.storagemetadata.md">
<a href="../types/classes/_metadata_.storagemetadata.html">
<span>
hidden
@@ -2029,7 +2029,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"rpc-provider","level":"1.3","depth":1,"next":{"title":"HttpProvider","level":"1.3.1","depth":2,"path":"rpc-provider/classes/_http_index_.httpprovider.md","ref":"rpc-provider/classes/_http_index_.httpprovider.md","articles":[]},"previous":{"title":"ApiRx","level":"1.2.2","depth":2,"path":"api/classes/_rx_index_.apirx.md","ref":"api/classes/_rx_index_.apirx.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"rpc-provider/README.md","mtime":"2018-12-07T11:33:33.375Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-07T11:34:45.610Z"},"basePath":"..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"rpc-provider","level":"1.3","depth":1,"next":{"title":"HttpProvider","level":"1.3.1","depth":2,"path":"rpc-provider/classes/_http_index_.httpprovider.md","ref":"rpc-provider/classes/_http_index_.httpprovider.md","articles":[]},"previous":{"title":"ApiRx","level":"1.2.2","depth":2,"path":"api/classes/_rx_index_.apirx.md","ref":"api/classes/_rx_index_.apirx.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"rpc-provider/README.md","mtime":"2018-12-08T14:35:11.051Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-08T14:36:23.372Z"},"basePath":"..","book":{"language":""}});
});
</script>
</div>
docs/rpc-provider/interfaces/_types_.providerinterface.md
+6 -6
View File
@@ -17,7 +17,7 @@
**● hasSubscriptions**: *`boolean`*
*Defined in [types.ts:45](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/types.ts#L45)*
*Defined in [types.ts:45](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/types.ts#L45)*
___
@@ -29,7 +29,7 @@ ___
▸ **isConnected**(): `boolean`
*Defined in [types.ts:46](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/types.ts#L46)*
*Defined in [types.ts:46](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/types.ts#L46)*
**Returns:** `boolean`
@@ -40,7 +40,7 @@ ___
▸ **on**(type: *[ProviderInterface$Emitted](../modules/_types_.md#providerinterface_emitted)*, sub: *[ProviderInterface$EmitCb](../modules/_types_.md#providerinterface_emitcb)*): `void`
*Defined in [types.ts:47](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/types.ts#L47)*
*Defined in [types.ts:47](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/types.ts#L47)*
**Parameters:**
@@ -58,7 +58,7 @@ ___
▸ **send**(method: *`string`*, params: *`Array`<`any`>*): `Promise`<`any`>
*Defined in [types.ts:48](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/types.ts#L48)*
*Defined in [types.ts:48](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/types.ts#L48)*
**Parameters:**
@@ -76,7 +76,7 @@ ___
▸ **subscribe**(type: *`string`*, method: *`string`*, params: *`Array`<`any`>*, cb: *[ProviderInterface$Callback](../modules/_types_.md#providerinterface_callback)*): `Promise`<`number`>
*Defined in [types.ts:49](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/types.ts#L49)*
*Defined in [types.ts:49](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/types.ts#L49)*
**Parameters:**
@@ -96,7 +96,7 @@ ___
▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`>
*Defined in [types.ts:50](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/types.ts#L50)*
*Defined in [types.ts:50](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/types.ts#L50)*
**Parameters:**
docs/rpc-provider/modules/_http_types_.md
+1 -1
View File
@@ -8,7 +8,7 @@
**Ƭ HttpState**: *`object`*
*Defined in [http/types.ts:9](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/http/types.ts#L9)*
*Defined in [http/types.ts:9](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/http/types.ts#L9)*
#### Type declaration
docs/rpc-provider/modules/_mock_types_.md
+4 -4
View File
@@ -8,7 +8,7 @@
**Ƭ MockState$Db**: *`object`*
*Defined in [mock/types.ts:16](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/mock/types.ts#L16)*
*Defined in [mock/types.ts:16](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/mock/types.ts#L16)*
#### Type declaration
@@ -21,7 +21,7 @@ ___
**Ƭ MockState$Requests**: *`object`*
*Defined in [mock/types.ts:20](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/mock/types.ts#L20)*
*Defined in [mock/types.ts:20](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/mock/types.ts#L20)*
#### Type declaration
@@ -45,7 +45,7 @@ ___
**Ƭ MockState$Subscription$Callback**: *`function`*
*Defined in [mock/types.ts:5](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/mock/types.ts#L5)*
*Defined in [mock/types.ts:5](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/mock/types.ts#L5)*
#### Type declaration
▸(error: * `Error` &#124; `null`*, value: *`any`*): `void`
@@ -66,7 +66,7 @@ ___
**Ƭ MockState$Subscriptions**: *`object`*
*Defined in [mock/types.ts:7](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/mock/types.ts#L7)*
*Defined in [mock/types.ts:7](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/mock/types.ts#L7)*
#### Type declaration
docs/rpc-provider/modules/_types_.md
+8 -8
View File
@@ -27,7 +27,7 @@
**Ƭ JsonRpcObject**: *`object`*
*Defined in [types.ts:5](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/types.ts#L5)*
*Defined in [types.ts:5](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/types.ts#L5)*
#### Type declaration
@@ -39,7 +39,7 @@ ___
**Ƭ JsonRpcRequest**: * [JsonRpcObject](_types_.md#jsonrpcobject) & `object`
*
*Defined in [types.ts:10](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/types.ts#L10)*
*Defined in [types.ts:10](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/types.ts#L10)*
___
<a id="jsonrpcresponse"></a>
@@ -49,7 +49,7 @@ ___
**Ƭ JsonRpcResponse**: * [JsonRpcObject](_types_.md#jsonrpcobject) & [JsonRpcResponseBase](_types_.md#jsonrpcresponsebase)
*
*Defined in [types.ts:36](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/types.ts#L36)*
*Defined in [types.ts:36](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/types.ts#L36)*
___
<a id="jsonrpcresponsebase"></a>
@@ -59,7 +59,7 @@ ___
**Ƭ JsonRpcResponseBase**: * `JsonRpcResponse$Single` & `JsonRpcResponse$Subscription`
*
*Defined in [types.ts:34](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/types.ts#L34)*
*Defined in [types.ts:34](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/types.ts#L34)*
___
<a id="jsonrpcresponsebase_error"></a>
@@ -68,7 +68,7 @@ ___
**Ƭ JsonRpcResponseBase$Error**: *`object`*
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/types.ts#L15)*
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/types.ts#L15)*
#### Type declaration
@@ -79,7 +79,7 @@ ___
**Ƭ ProviderInterface$Callback**: *`function`*
*Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/types.ts#L38)*
*Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/types.ts#L38)*
#### Type declaration
▸(result: *`any`*): `void`
@@ -99,7 +99,7 @@ ___
**Ƭ ProviderInterface$EmitCb**: *`function`*
*Defined in [types.ts:42](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/types.ts#L42)*
*Defined in [types.ts:42](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/types.ts#L42)*
#### Type declaration
▸(value?: *`any`*): `any`
@@ -120,7 +120,7 @@ ___
**Ƭ ProviderInterface$Emitted**: * "connected" &#124; "disconnected"
*
*Defined in [types.ts:40](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/types.ts#L40)*
*Defined in [types.ts:40](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/types.ts#L40)*
___
docs/rpc-rx/classes/_index_.rpcrx.md
+7 -7
View File
@@ -32,7 +32,7 @@ const api = new RpcRx(provider);
⊕ **new RpcRx**(providerOrRpc?: * `Rpc` &#124; `ProviderInterface`*): [RpcRx](_index_.rpcrx.md)
*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-rx/src/index.ts#L45)*
*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-rx/src/index.ts#L45)*
**Parameters:**
@@ -52,7 +52,7 @@ ___
**● author**: *[RpcRxInterface$Section](../modules/_types_.md#rpcrxinterface_section)*
*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-rx/src/index.ts#L42)*
*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-rx/src/index.ts#L42)*
___
<a id="chain"></a>
@@ -61,7 +61,7 @@ ___
**● chain**: *[RpcRxInterface$Section](../modules/_types_.md#rpcrxinterface_section)*
*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-rx/src/index.ts#L43)*
*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-rx/src/index.ts#L43)*
___
<a id="state"></a>
@@ -70,7 +70,7 @@ ___
**● state**: *[RpcRxInterface$Section](../modules/_types_.md#rpcrxinterface_section)*
*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-rx/src/index.ts#L44)*
*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-rx/src/index.ts#L44)*
___
<a id="system"></a>
@@ -79,7 +79,7 @@ ___
**● system**: *[RpcRxInterface$Section](../modules/_types_.md#rpcrxinterface_section)*
*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-rx/src/index.ts#L45)*
*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-rx/src/index.ts#L45)*
___
@@ -91,7 +91,7 @@ ___
▸ **isConnected**(): `BehaviorSubject`<`boolean`>
*Defined in [index.ts:66](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-rx/src/index.ts#L66)*
*Defined in [index.ts:66](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-rx/src/index.ts#L66)*
**Returns:** `BehaviorSubject`<`boolean`>
@@ -102,7 +102,7 @@ ___
▸ **on**(type: *[RpcRxInterface$Events](../modules/_types_.md#rpcrxinterface_events)*, handler: *`function`*): `void`
*Defined in [index.ts:70](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-rx/src/index.ts#L70)*
*Defined in [index.ts:70](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-rx/src/index.ts#L70)*
**Parameters:**
docs/rpc-rx/modules/_types_.md
+4 -4
View File
@@ -8,7 +8,7 @@
**Ƭ RpcRxInterface**: *`object`*
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-rx/src/types.ts#L15)*
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-rx/src/types.ts#L15)*
#### Type declaration
@@ -20,7 +20,7 @@ ___
**Ƭ RpcRxInterface$Events**: * "connected" &#124; "disconnected"
*
*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-rx/src/types.ts#L13)*
*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-rx/src/types.ts#L13)*
___
<a id="rpcrxinterface_method"></a>
@@ -29,7 +29,7 @@ ___
**Ƭ RpcRxInterface$Method**: *`function`*
*Defined in [types.ts:7](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-rx/src/types.ts#L7)*
*Defined in [types.ts:7](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-rx/src/types.ts#L7)*
#### Type declaration
▸(...params: *`Array`<`any`>*): `Observable`<`any`> &#124; `ReplaySubject`<`any`>
@@ -49,7 +49,7 @@ ___
**Ƭ RpcRxInterface$Section**: *`object`*
*Defined in [types.ts:9](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-rx/src/types.ts#L9)*
*Defined in [types.ts:9](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-rx/src/types.ts#L9)*
#### Type declaration
docs/search_index.json
+1 -1
View File
File diff suppressed because one or more lines are too long
docs/type-extrinsics/SUMMARY.md
+2
View File
@@ -1,4 +1,6 @@
* [&quot;fromMetadata&quot;](modules/_frommetadata_.md)
* [&quot;fromMetadata.spec&quot;](modules/_frommetadata_spec_.md)
* [&quot;index&quot;](modules/_index_.md)
* [&quot;index.spec&quot;](modules/_index_spec_.md)
* [&quot;static&quot;](modules/_static_.md)
* [&quot;utils/createUnchecked&quot;](modules/_utils_createunchecked_.md)
docs/type-extrinsics/modules/_frommetadata_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **fromMetadata**(metadata: *`Metadata`*): `Extrinsics`
*Defined in [fromMetadata.ts:21](https://github.com/polkadot-js/api/blob/69f6850/packages/type-extrinsics/src/fromMetadata.ts#L21)*
*Defined in [fromMetadata.ts:21](https://github.com/polkadot-js/api/blob/448a729/packages/type-extrinsics/src/fromMetadata.ts#L21)*
Extend a storage object with the storage modules & module functions present in the metadata.
docs/types/modules/_metadata_rpc_.md → docs/type-extrinsics/modules/_frommetadata_spec_.md
View File
docs/types/modules/_metadata_spec_.md → docs/type-extrinsics/modules/_index_spec_.md
View File
docs/type-extrinsics/modules/_utils_createunchecked_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **createDescriptor**(section: *`string`*, method: *`string`*, index: *`number`*, meta: *`FunctionMetadata`*): `ExtrinsicFunction`
*Defined in [utils/createUnchecked.ts:16](https://github.com/polkadot-js/api/blob/69f6850/packages/type-extrinsics/src/utils/createUnchecked.ts#L16)*
*Defined in [utils/createUnchecked.ts:16](https://github.com/polkadot-js/api/blob/448a729/packages/type-extrinsics/src/utils/createUnchecked.ts#L16)*
From the metadata of a function in the module's storage, generate the function that will return the an UncheckExtrinsic.
docs/type-jsonrpc/modules/_create_method_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **createMethod**(section: *`string`*, method: *`string`*, __namedParameters: *`object`*): [RpcMethod](_types_.md#rpcmethod)
*Defined in [create/method.ts:9](https://github.com/polkadot-js/api/blob/69f6850/packages/type-jsonrpc/src/create/method.ts#L9)*
*Defined in [create/method.ts:9](https://github.com/polkadot-js/api/blob/448a729/packages/type-jsonrpc/src/create/method.ts#L9)*
**Parameters:**
docs/type-jsonrpc/modules/_create_param_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **createParam**(name: *`string`*, type: *`CodecTypes`*, __namedParameters?: *`object`*): [RpcParam](_types_.md#rpcparam)
*Defined in [create/param.ts:12](https://github.com/polkadot-js/api/blob/69f6850/packages/type-jsonrpc/src/create/param.ts#L12)*
*Defined in [create/param.ts:12](https://github.com/polkadot-js/api/blob/448a729/packages/type-jsonrpc/src/create/param.ts#L12)*
**Parameters:**
docs/type-jsonrpc/modules/_types_.md
+4 -4
View File
@@ -8,7 +8,7 @@
**Ƭ RpcMethod**: *`object`*
*Defined in [types.ts:24](https://github.com/polkadot-js/api/blob/69f6850/packages/type-jsonrpc/src/types.ts#L24)*
*Defined in [types.ts:24](https://github.com/polkadot-js/api/blob/448a729/packages/type-jsonrpc/src/types.ts#L24)*
#### Type declaration
@@ -19,7 +19,7 @@ ___
**Ƭ RpcMethodOpt**: *`object`*
*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/69f6850/packages/type-jsonrpc/src/types.ts#L13)*
*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/448a729/packages/type-jsonrpc/src/types.ts#L13)*
#### Type declaration
@@ -30,7 +30,7 @@ ___
**Ƭ RpcParam**: *`object`*
*Defined in [types.ts:7](https://github.com/polkadot-js/api/blob/69f6850/packages/type-jsonrpc/src/types.ts#L7)*
*Defined in [types.ts:7](https://github.com/polkadot-js/api/blob/448a729/packages/type-jsonrpc/src/types.ts#L7)*
#### Type declaration
@@ -41,7 +41,7 @@ ___
**Ƭ RpcSection**: *`object`*
*Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/69f6850/packages/type-jsonrpc/src/types.ts#L38)*
*Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/448a729/packages/type-jsonrpc/src/types.ts#L38)*
#### Type declaration
docs/type-storage/SUMMARY.md
+4
View File
@@ -1,10 +1,14 @@
* [&quot;fromMetadata&quot;](modules/_frommetadata_.md)
* [&quot;fromMetadata.spec&quot;](modules/_frommetadata_spec_.md)
* [&quot;index&quot;](modules/_index_.md)
* [&quot;static&quot;](modules/_static_.md)
* [&quot;storage&quot;](modules/_storage_.md)
* [&quot;storage.spec&quot;](modules/_storage_spec_.md)
* [&quot;substrate&quot;](modules/_substrate_.md)
* [&quot;substrate.spec&quot;](modules/_substrate_spec_.md)
* [&quot;types&quot;](modules/_types_.md)
* [ModuleStorage](interfaces/_types_.modulestorage.md)
* [Storage](interfaces/_types_.storage.md)
* [&quot;utils/createFunction&quot;](modules/_utils_createfunction_.md)
* [CreateItemOptions](interfaces/_utils_createfunction_.createitemoptions.md)
* [&quot;utils/createFunction.spec&quot;](modules/_utils_createfunction_spec_.md)
docs/type-storage/interfaces/_types_.storage.md
+1 -1
View File
@@ -15,7 +15,7 @@
**● substrate**: *`object`*
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/69f6850/packages/type-storage/src/types.ts#L17)*
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/448a729/packages/type-storage/src/types.ts#L17)*
#### Type declaration
docs/type-storage/interfaces/_utils_createfunction_.createitemoptions.md
+2 -2
View File
@@ -13,7 +13,7 @@
**● isUnhashed**: * `undefined` &#124; `false` &#124; `true`
*
*Defined in [utils/createFunction.ts:14](https://github.com/polkadot-js/api/blob/69f6850/packages/type-storage/src/utils/createFunction.ts#L14)*
*Defined in [utils/createFunction.ts:14](https://github.com/polkadot-js/api/blob/448a729/packages/type-storage/src/utils/createFunction.ts#L14)*
___
<a id="method"></a>
@@ -23,7 +23,7 @@ ___
**● method**: * `undefined` &#124; `string`
*
*Defined in [utils/createFunction.ts:15](https://github.com/polkadot-js/api/blob/69f6850/packages/type-storage/src/utils/createFunction.ts#L15)*
*Defined in [utils/createFunction.ts:15](https://github.com/polkadot-js/api/blob/448a729/packages/type-storage/src/utils/createFunction.ts#L15)*
___
docs/type-storage/modules/_frommetadata_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **fromMetadata**(metadata: *`Metadata`*): [Storage](../interfaces/_types_.storage.md)
*Defined in [fromMetadata.ts:20](https://github.com/polkadot-js/api/blob/69f6850/packages/type-storage/src/fromMetadata.ts#L20)*
*Defined in [fromMetadata.ts:20](https://github.com/polkadot-js/api/blob/448a729/packages/type-storage/src/fromMetadata.ts#L20)*
Extend a storage object with the storage modules & module functions present in the metadata.
docs/type-storage/modules/_frommetadata_spec_.md
+2
View File
@@ -0,0 +1,2 @@
docs/type-storage/modules/_storage_.md
+2 -2
View File
@@ -8,7 +8,7 @@
**storage**: *`object`*
*Defined in [storage.ts:8](https://github.com/polkadot-js/api/blob/69f6850/packages/type-storage/src/storage.ts#L8)*
*Defined in [storage.ts:8](https://github.com/polkadot-js/api/blob/448a729/packages/type-storage/src/storage.ts#L8)*
<a id="storage.substrate"></a>
@@ -16,7 +16,7 @@
**● substrate**: *[&quot;substrate&quot;](_substrate_.md)*
*Defined in [storage.ts:9](https://github.com/polkadot-js/api/blob/69f6850/packages/type-storage/src/storage.ts#L9)*
*Defined in [storage.ts:9](https://github.com/polkadot-js/api/blob/448a729/packages/type-storage/src/storage.ts#L9)*
___
docs/type-storage/modules/_storage_spec_.md
+2
View File
@@ -0,0 +1,2 @@
docs/type-storage/modules/_substrate_.md
+6 -6
View File
@@ -11,7 +11,7 @@
type: 'u32'
})
*Defined in [substrate.ts:45](https://github.com/polkadot-js/api/blob/69f6850/packages/type-storage/src/substrate.ts#L45)*
*Defined in [substrate.ts:45](https://github.com/polkadot-js/api/blob/448a729/packages/type-storage/src/substrate.ts#L45)*
___
<a id="authorityprefix"></a>
@@ -23,7 +23,7 @@ ___
type: 'u32'
})
*Defined in [substrate.ts:50](https://github.com/polkadot-js/api/blob/69f6850/packages/type-storage/src/substrate.ts#L50)*
*Defined in [substrate.ts:50](https://github.com/polkadot-js/api/blob/448a729/packages/type-storage/src/substrate.ts#L50)*
___
<a id="changestrieconfig"></a>
@@ -35,7 +35,7 @@ ___
type: 'u32'
})
*Defined in [substrate.ts:60](https://github.com/polkadot-js/api/blob/69f6850/packages/type-storage/src/substrate.ts#L60)*
*Defined in [substrate.ts:60](https://github.com/polkadot-js/api/blob/448a729/packages/type-storage/src/substrate.ts#L60)*
___
<a id="code"></a>
@@ -47,7 +47,7 @@ ___
type: 'Bytes'
})
*Defined in [substrate.ts:35](https://github.com/polkadot-js/api/blob/69f6850/packages/type-storage/src/substrate.ts#L35)*
*Defined in [substrate.ts:35](https://github.com/polkadot-js/api/blob/448a729/packages/type-storage/src/substrate.ts#L35)*
___
<a id="extrinsicindex"></a>
@@ -59,7 +59,7 @@ ___
type: 'u32'
})
*Defined in [substrate.ts:55](https://github.com/polkadot-js/api/blob/69f6850/packages/type-storage/src/substrate.ts#L55)*
*Defined in [substrate.ts:55](https://github.com/polkadot-js/api/blob/448a729/packages/type-storage/src/substrate.ts#L55)*
___
<a id="heappages"></a>
@@ -71,7 +71,7 @@ ___
type: 'u64'
})
*Defined in [substrate.ts:40](https://github.com/polkadot-js/api/blob/69f6850/packages/type-storage/src/substrate.ts#L40)*
*Defined in [substrate.ts:40](https://github.com/polkadot-js/api/blob/448a729/packages/type-storage/src/substrate.ts#L40)*
___
docs/type-storage/modules/_substrate_spec_.md
+2
View File
@@ -0,0 +1,2 @@
docs/type-storage/modules/_utils_createfunction_.md
+4 -4
View File
@@ -18,9 +18,9 @@
## createFunction
▸ **createFunction**(section: *`Text`*, method: *`Text`*, meta: *`StorageFunctionMetadata`*, options?: *[CreateItemOptions](../interfaces/_utils_createfunction_.createitemoptions.md)*): `StorageFunction`
▸ **createFunction**(section: * `Text` &#124; `string`*, method: * `Text` &#124; `string`*, meta: *`StorageFunctionMetadata`*, options?: *[CreateItemOptions](../interfaces/_utils_createfunction_.createitemoptions.md)*): `StorageFunction`
*Defined in [utils/createFunction.ts:28](https://github.com/polkadot-js/api/blob/69f6850/packages/type-storage/src/utils/createFunction.ts#L28)*
*Defined in [utils/createFunction.ts:28](https://github.com/polkadot-js/api/blob/448a729/packages/type-storage/src/utils/createFunction.ts#L28)*
From the schema of a function in the module's storage, generate the function that will return the correct storage key.
@@ -28,8 +28,8 @@ From the schema of a function in the module's storage, generate the function tha
| Name | Type | Default value | Description |
| ------ | ------ | ------ | ------ |
| section | `Text` | - |
| method | `Text` | - |
| section | `Text` &#124; `string`| - |
| method | `Text` &#124; `string`| - |
| meta | `StorageFunctionMetadata` | - |
| `Default value` options | [CreateItemOptions](../interfaces/_utils_createfunction_.createitemoptions.md) | {} | Additional options when creating the function. These options are not known at runtime (from state\_getMetadata), they need to be supplied by us manually at compile time. |
docs/type-storage/modules/_utils_createfunction_spec_.md
+2
View File
@@ -0,0 +1,2 @@
docs/types/README.md
+1 -1
View File
@@ -7,7 +7,7 @@ Implementation of the types and their (de-)serialisation via [parity-codec](http
Substrate types
---------------
These types implement specific types that are found as part of the Substrate base: [AccountId](classes/_accountid_.accountid.md), [AccountIndex](classes/_accountindex_.accountindex.md), [Address](classes/_address_.address.md), [AuthorityId](classes/_authorityid_.authorityid.md), [Balance](classes/_balance_.balance.md), [Block](classes/_block_.block.md), [BlockNumber](classes/_blocknumber_.blocknumber.md), [Bool](classes/_bool_.bool.md), [Bytes](classes/_bytes_.bytes.md), [ChainProperties](classes/_chainproperties_.chainproperties.md) [Data](classes/_data_.data.md), [Digest](classes/_digest_.digest.md), [Event](classes/_event_.event.md), [EventRecord](classes/_eventrecord_.eventrecord.md), [Extrinsic](classes/_extrinsic_.extrinsic.md), [Extrinsics](interfaces/_method_.extrinsics.md), [ExtrinsicEra](classes/_extrinsicera_.extrinsicera.md), [ExtrinsicSignature](classes/_extrinsicsignature_.extrinsicsignature.md), [ExtrinsicStatus](classes/_extrinsicstatus_.extrinsicstatus.md), [Gas](classes/_gas_.gas.md), [H256](classes/_h256_.h256.md), [H512](classes/_h512_.h512.md), [Hash](classes/_hash_.hash.md), [Header](classes/_header_.header.md), [Justification](classes/_justification_.justification.md), [KeyValue](classes/_keyvalue_.keyvalue.md), [Metadata](classes/_metadata_.metadata.md), [Method](classes/_method_.method.md), [MisbehaviorReport](classes/_misbehaviorreport_.misbehaviorreport.md), [Moment](classes/_moment_.moment.md), [NewAccountOutcome](classes/_newaccountoutcome_.newaccountoutcome.md), [Nonce](classes/_nonce_.nonce.md), [Null](classes/_null_.null.md), [Origin](classes/_origin_.origin.md), [ParachainId](classes/_parachainid_.parachainid.md), [PendingExtrinsics](classes/_pendingextrinsics_.pendingextrinsics.md), [Perbill](classes/_perbill_.perbill.md), [Permill](classes/_permill_.permill.md), [PropIndex](classes/_propindex_.propindex.md), [Proposal](classes/_proposal_.proposal.md), [ProposalIndex](classes/_proposalindex_.proposalindex.md), [ReferendumIndex](classes/_referendumindex_.referendumindex.md), [RuntimeVersion](classes/_runtimeversion_.runtimeversion.md), [SessionKey](classes/_sessionkey_.sessionkey.md), [Signature](classes/_signature_.signature.md), [SignaturePayload](classes/_signaturepayload_.signaturepayload.md), [SignedBlock](classes/_signedblock_.signedblock.md), [StorageChangeSet](classes/_storagechangeset_.storagechangeset.md), [StorageData](classes/_storagedata_.storagedata.md), [StorageKey](classes/_storagekey_.storagekey.md), [StoredPendingChange](classes/_storedpendingchange_.storedpendingchange.md), [Text](classes/_text_.text.md), [Type](classes/_codec_struct_.struct.md#type), [U8](classes/_u8_.u8.md), [U16](classes/_u16_.u16.md), [U32](classes/_u32_.u32.md), [U64](classes/_u64_.u64.md), [U128](classes/_u128_.u128.md), [U256](classes/_u256_.u256.md), [ValidatorPrefs](classes/_validatorprefs_.validatorprefs.md), [VoteIndex](classes/_voteindex_.voteindex.md), [VoteThreshold](classes/_votethreshold_.votethreshold.md)
These types implement specific types that are found as part of the Substrate base: [AccountId](classes/_accountid_.accountid.md), [AccountIndex](classes/_accountindex_.accountindex.md), [Address](classes/_address_.address.md), [AuthorityId](classes/_authorityid_.authorityid.md), [Balance](classes/_balance_.balance.md), [Block](classes/_block_.block.md), [BlockNumber](classes/_blocknumber_.blocknumber.md), [Bool](classes/_bool_.bool.md), [Bytes](classes/_bytes_.bytes.md), [ChainProperties](classes/_chainproperties_.chainproperties.md) [Data](classes/_data_.data.md), [Digest](classes/_digest_.digest.md), [Event](classes/_event_.event.md), [EventRecord](classes/_eventrecord_.eventrecord.md), [Extrinsic](classes/_extrinsic_.extrinsic.md), [Extrinsics](interfaces/_method_.extrinsics.md), [ExtrinsicEra](classes/_extrinsicera_.extrinsicera.md), [ExtrinsicSignature](classes/_extrinsicsignature_.extrinsicsignature.md), [ExtrinsicStatus](classes/_extrinsicstatus_.extrinsicstatus.md), [Gas](classes/_gas_.gas.md), [H256](classes/_h256_.h256.md), [H512](classes/_h512_.h512.md), [Hash](classes/_hash_.hash.md), [Header](classes/_header_.header.md), [Justification](classes/_justification_.justification.md), [KeyValue](classes/_keyvalue_.keyvalue.md), [Metadata](classes/_metadata_index_.metadata.md), [Method](classes/_method_.method.md), [MisbehaviorReport](classes/_misbehaviorreport_.misbehaviorreport.md), [Moment](classes/_moment_.moment.md), [NewAccountOutcome](classes/_newaccountoutcome_.newaccountoutcome.md), [Nonce](classes/_nonce_.nonce.md), [Null](classes/_null_.null.md), [Origin](classes/_origin_.origin.md), [ParachainId](classes/_parachainid_.parachainid.md), [PendingExtrinsics](classes/_pendingextrinsics_.pendingextrinsics.md), [Perbill](classes/_perbill_.perbill.md), [Permill](classes/_permill_.permill.md), [PropIndex](classes/_propindex_.propindex.md), [Proposal](classes/_proposal_.proposal.md), [ProposalIndex](classes/_proposalindex_.proposalindex.md), [ReferendumIndex](classes/_referendumindex_.referendumindex.md), [RuntimeVersion](classes/_runtimeversion_.runtimeversion.md), [SessionKey](classes/_sessionkey_.sessionkey.md), [Signature](classes/_signature_.signature.md), [SignaturePayload](classes/_signaturepayload_.signaturepayload.md), [SignedBlock](classes/_signedblock_.signedblock.md), [StorageChangeSet](classes/_storagechangeset_.storagechangeset.md), [StorageData](classes/_storagedata_.storagedata.md), [StorageKey](classes/_storagekey_.storagekey.md), [StoredPendingChange](classes/_storedpendingchange_.storedpendingchange.md), [Text](classes/_text_.text.md), [Type](classes/_codec_struct_.struct.md#type), [U8](classes/_u8_.u8.md), [U16](classes/_u16_.u16.md), [U32](classes/_u32_.u32.md), [U64](classes/_u64_.u64.md), [U128](classes/_u128_.u128.md), [U256](classes/_u256_.u256.md), [ValidatorPrefs](classes/_validatorprefs_.validatorprefs.md), [VoteIndex](classes/_voteindex_.voteindex.md), [VoteThreshold](classes/_votethreshold_.votethreshold.md)
Codec types
-----------
docs/types/SUMMARY.md
+22 -19
View File
@@ -82,25 +82,28 @@
* [KeyValue](classes/_keyvalue_.keyvalue.md)
* [KeyValueOption](classes/_keyvalue_.keyvalueoption.md)
* [&quot;KeyValue.spec&quot;](modules/_keyvalue_spec_.md)
* [&quot;Metadata&quot;](modules/_metadata_.md)
* [CallMetadata](classes/_metadata_.callmetadata.md)
* [EventMetadata](classes/_metadata_.eventmetadata.md)
* [FunctionArgumentMetadata](classes/_metadata_.functionargumentmetadata.md)
* [FunctionMetadata](classes/_metadata_.functionmetadata.md)
* [Metadata](classes/_metadata_.metadata.md)
* [ModuleMetadata](classes/_metadata_.modulemetadata.md)
* [OuterDispatchCall](classes/_metadata_.outerdispatchcall.md)
* [OuterDispatchMetadata](classes/_metadata_.outerdispatchmetadata.md)
* [OuterEventMetadata](classes/_metadata_.outereventmetadata.md)
* [OuterEventMetadataEvent](classes/_metadata_.outereventmetadataevent.md)
* [RuntimeModuleMetadata](classes/_metadata_.runtimemodulemetadata.md)
* [StorageFunctionMetadata](classes/_metadata_.storagefunctionmetadata.md)
* [StorageFunctionModifier](classes/_metadata_.storagefunctionmodifier.md)
* [StorageFunctionType](classes/_metadata_.storagefunctiontype.md)
* [StorageFunctionType$Map](classes/_metadata_.storagefunctiontype_map.md)
* [StorageMetadata](classes/_metadata_.storagemetadata.md)
* [&quot;Metadata.rpc&quot;](modules/_metadata_rpc_.md)
* [&quot;Metadata.spec&quot;](modules/_metadata_spec_.md)
* [&quot;Metadata/Calls&quot;](modules/_metadata_calls_.md)
* [OuterDispatchCall](classes/_metadata_calls_.outerdispatchcall.md)
* [OuterDispatchMetadata](classes/_metadata_calls_.outerdispatchmetadata.md)
* [&quot;Metadata/Events&quot;](modules/_metadata_events_.md)
* [EventMetadata](classes/_metadata_events_.eventmetadata.md)
* [OuterEventMetadata](classes/_metadata_events_.outereventmetadata.md)
* [OuterEventMetadataEvent](classes/_metadata_events_.outereventmetadataevent.md)
* [&quot;Metadata/Metadata.spec&quot;](modules/_metadata_metadata_spec_.md)
* [&quot;Metadata/Modules&quot;](modules/_metadata_modules_.md)
* [CallMetadata](classes/_metadata_modules_.callmetadata.md)
* [FunctionArgumentMetadata](classes/_metadata_modules_.functionargumentmetadata.md)
* [FunctionMetadata](classes/_metadata_modules_.functionmetadata.md)
* [ModuleMetadata](classes/_metadata_modules_.modulemetadata.md)
* [RuntimeModuleMetadata](classes/_metadata_modules_.runtimemodulemetadata.md)
* [StorageFunctionMetadata](classes/_metadata_modules_.storagefunctionmetadata.md)
* [StorageFunctionModifier](classes/_metadata_modules_.storagefunctionmodifier.md)
* [StorageFunctionType](classes/_metadata_modules_.storagefunctiontype.md)
* [StorageFunctionType$Map](classes/_metadata_modules_.storagefunctiontype_map.md)
* [StorageMetadata](classes/_metadata_modules_.storagemetadata.md)
* [&quot;Metadata/index&quot;](modules/_metadata_index_.md)
* [Metadata](classes/_metadata_index_.metadata.md)
* [&quot;Metadata/static&quot;](modules/_metadata_static_.md)
* [&quot;Method&quot;](modules/_method_.md)
* [Method](classes/_method_.method.md)
* [MethodIndex](classes/_method_.methodindex.md)
docs/types/classes/_accountid_.accountid.html
+41 -41
View File
@@ -1122,9 +1122,9 @@
</li>
<li class="chapter " data-level="4.58" data-path="_metadata_.callmetadata.html">
<li class="chapter " data-level="4.58" data-path="_metadata_.callmetadata.md">
<a href="_metadata_.callmetadata.html">
<span>
hidden
@@ -1135,9 +1135,9 @@
</li>
<li class="chapter " data-level="4.59" data-path="_metadata_.eventmetadata.html">
<li class="chapter " data-level="4.59" data-path="_metadata_.eventmetadata.md">
<a href="_metadata_.eventmetadata.html">
<span>
hidden
@@ -1148,9 +1148,9 @@
</li>
<li class="chapter " data-level="4.60" data-path="_metadata_.functionargumentmetadata.html">
<li class="chapter " data-level="4.60" data-path="_metadata_.functionargumentmetadata.md">
<a href="_metadata_.functionargumentmetadata.html">
<span>
hidden
@@ -1161,9 +1161,9 @@
</li>
<li class="chapter " data-level="4.61" data-path="_metadata_.functionmetadata.html">
<li class="chapter " data-level="4.61" data-path="_metadata_.functionmetadata.md">
<a href="_metadata_.functionmetadata.html">
<span>
hidden
@@ -1174,9 +1174,9 @@
</li>
<li class="chapter " data-level="4.62" data-path="_metadata_.modulemetadata.html">
<li class="chapter " data-level="4.62" data-path="_metadata_.modulemetadata.md">
<a href="_metadata_.modulemetadata.html">
<span>
hidden
@@ -1187,9 +1187,9 @@
</li>
<li class="chapter " data-level="4.63" data-path="_metadata_.outerdispatchcall.html">
<li class="chapter " data-level="4.63" data-path="_metadata_.outerdispatchcall.md">
<a href="_metadata_.outerdispatchcall.html">
<span>
hidden
@@ -1200,9 +1200,9 @@
</li>
<li class="chapter " data-level="4.64" data-path="_metadata_.outerdispatchmetadata.html">
<li class="chapter " data-level="4.64" data-path="_metadata_.outerdispatchmetadata.md">
<a href="_metadata_.outerdispatchmetadata.html">
<span>
hidden
@@ -1213,9 +1213,9 @@
</li>
<li class="chapter " data-level="4.65" data-path="_metadata_.outereventmetadata.html">
<li class="chapter " data-level="4.65" data-path="_metadata_.outereventmetadata.md">
<a href="_metadata_.outereventmetadata.html">
<span>
hidden
@@ -1226,9 +1226,9 @@
</li>
<li class="chapter " data-level="4.66" data-path="_metadata_.outereventmetadataevent.html">
<li class="chapter " data-level="4.66" data-path="_metadata_.outereventmetadataevent.md">
<a href="_metadata_.outereventmetadataevent.html">
<span>
hidden
@@ -1252,9 +1252,9 @@
</li>
<li class="chapter " data-level="4.68" data-path="_metadata_.runtimemodulemetadata.html">
<li class="chapter " data-level="4.68" data-path="_metadata_.runtimemodulemetadata.md">
<a href="_metadata_.runtimemodulemetadata.html">
<span>
hidden
@@ -1265,9 +1265,9 @@
</li>
<li class="chapter " data-level="4.69" data-path="_metadata_.storagefunctionmetadata.html">
<li class="chapter " data-level="4.69" data-path="_metadata_.storagefunctionmetadata.md">
<a href="_metadata_.storagefunctionmetadata.html">
<span>
hidden
@@ -1278,9 +1278,9 @@
</li>
<li class="chapter " data-level="4.70" data-path="_metadata_.storagefunctionmodifier.html">
<li class="chapter " data-level="4.70" data-path="_metadata_.storagefunctionmodifier.md">
<a href="_metadata_.storagefunctionmodifier.html">
<span>
hidden
@@ -1291,9 +1291,9 @@
</li>
<li class="chapter " data-level="4.71" data-path="_metadata_.storagefunctiontype.html">
<li class="chapter " data-level="4.71" data-path="_metadata_.storagefunctiontype.md">
<a href="_metadata_.storagefunctiontype.html">
<span>
hidden
@@ -1304,9 +1304,9 @@
</li>
<li class="chapter " data-level="4.72" data-path="_metadata_.storagefunctiontype_map.html">
<li class="chapter " data-level="4.72" data-path="_metadata_.storagefunctiontype_map.md">
<a href="_metadata_.storagefunctiontype_map.html">
<span>
hidden
@@ -1317,9 +1317,9 @@
</li>
<li class="chapter " data-level="4.73" data-path="_metadata_.storagemetadata.html">
<li class="chapter " data-level="4.73" data-path="_metadata_.storagemetadata.md">
<a href="_metadata_.storagemetadata.html">
<span>
hidden
@@ -1977,7 +1977,7 @@
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new AccountId</strong>(value?: <em><a href="../modules/_types_.md#anyu8a">AnyU8a</a></em>): <a href="_accountid_.accountid.html">AccountId</a></p>
<p><em>Overrides <a href="_codec_u8afixed_.u8afixed.html">U8aFixed</a>.<a href="_codec_u8afixed_.u8afixed.html#constructor">constructor</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/AccountId.ts#L19" target="_blank">AccountId.ts:19</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/AccountId.ts#L19" target="_blank">AccountId.ts:19</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2037,7 +2037,7 @@
<h2 id="encodedlength">encodedLength</h2>
<p>getencodedLength(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#encodedlength">encodedLength</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/U8a.ts#L36" target="_blank">codec/U8a.ts:36</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/U8a.ts#L36" target="_blank">codec/U8a.ts:36</a></em></p>
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2046,7 +2046,7 @@
<p>getlength(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#length">length</a></em></p>
<p><em>Overrides Uint8Array.length</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/U8a.ts#L43" target="_blank">codec/U8a.ts:43</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/U8a.ts#L43" target="_blank">codec/U8a.ts:43</a></em></p>
<p><em><strong>description</strong></em>: The length of the value</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2062,7 +2062,7 @@
<h2 id="bitlength">bitLength</h2>
<p>&#x25B8; <strong>bitLength</strong>(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_u8afixed_.u8afixed.html">U8aFixed</a>.<a href="_codec_u8afixed_.u8afixed.html#bitlength">bitLength</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/U8aFixed.ts#L39" target="_blank">codec/U8aFixed.ts:39</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/U8aFixed.ts#L39" target="_blank">codec/U8aFixed.ts:39</a></em></p>
<p><em><strong>description</strong></em>: Returns the number of bits in the value</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2729,7 +2729,7 @@
<p>&#x25B8; <strong>subarray</strong>(begin: <em><code>number</code></em>, end?: <em> <code>undefined</code> | <code>number</code></em>): <code>Uint8Array</code></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#subarray">subarray</a></em></p>
<p><em>Overrides Uint8Array.subarray</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/U8a.ts#L53" target="_blank">codec/U8a.ts:53</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/U8a.ts#L53" target="_blank">codec/U8a.ts:53</a></em></p>
<p><em><strong>description</strong></em>: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2760,7 +2760,7 @@
<p>&#x25B8; <strong>toHex</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#tohex">toHex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/U8a.ts#L60" target="_blank">codec/U8a.ts:60</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/U8a.ts#L60" target="_blank">codec/U8a.ts:60</a></em></p>
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2769,7 +2769,7 @@
<p>&#x25B8; <strong>toJSON</strong>(): <code>any</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
<p><em>Overrides <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#tojson">toJSON</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/AccountId.ts#L46" target="_blank">AccountId.ts:46</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/AccountId.ts#L46" target="_blank">AccountId.ts:46</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
<p><strong>Returns:</strong> <code>any</code></p>
<hr>
@@ -2786,7 +2786,7 @@
<p>&#x25B8; <strong>toString</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
<p><em>Overrides <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#tostring">toString</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/AccountId.ts#L53" target="_blank">AccountId.ts:53</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/AccountId.ts#L53" target="_blank">AccountId.ts:53</a></em></p>
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2795,7 +2795,7 @@
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em> <code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tou8a">toU8a</a></em></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#tou8a">toU8a</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/U8a.ts#L82" target="_blank">codec/U8a.ts:82</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/U8a.ts#L82" target="_blank">codec/U8a.ts:82</a></em></p>
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2827,7 +2827,7 @@
<p><a id="encode"></a></p>
<h2 id="static-encode"><code>&lt;Static&gt;</code> encode</h2>
<p>&#x25B8; <strong>encode</strong>(value: <em><code>Uint8Array</code></em>): <code>string</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/AccountId.ts#L27" target="_blank">AccountId.ts:27</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/AccountId.ts#L27" target="_blank">AccountId.ts:27</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2888,7 +2888,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.1","depth":1,"next":{"title":"hidden","level":"4.2","depth":1,"path":"types/classes/_accountindex_.accountindex.md","ref":"types/classes/_accountindex_.accountindex.md","articles":[]},"previous":{"title":"Display system events","level":"3.1.6","depth":2,"path":"examples/promise/08_system_events/README.md","ref":"examples/promise/08_system_events/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"types/classes/_accountid_.accountid.md","mtime":"2018-12-07T11:33:58.363Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-07T11:34:45.610Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.1","depth":1,"next":{"title":"hidden","level":"4.2","depth":1,"path":"types/classes/_accountindex_.accountindex.md","ref":"types/classes/_accountindex_.accountindex.md","articles":[]},"previous":{"title":"Display system events","level":"3.1.6","depth":2,"path":"examples/promise/08_system_events/README.md","ref":"examples/promise/08_system_events/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"types/classes/_accountid_.accountid.md","mtime":"2018-12-08T14:35:37.706Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-08T14:36:23.372Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_accountid_.accountid.md
+10 -10
View File
@@ -29,7 +29,7 @@
*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)*
*Defined in [AccountId.ts:19](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/AccountId.ts#L19)*
*Defined in [AccountId.ts:19](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/AccountId.ts#L19)*
**Parameters:**
@@ -117,7 +117,7 @@ getencodedLength(): `number`
*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/U8a.ts#L36)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/U8a.ts#L36)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -134,7 +134,7 @@ getlength(): `number`
*Overrides Uint8Array.length*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/U8a.ts#L43)*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/U8a.ts#L43)*
*__description__*: The length of the value
@@ -165,7 +165,7 @@ ___
*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)*
*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/U8aFixed.ts#L39)*
*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/U8aFixed.ts#L39)*
*__description__*: Returns the number of bits in the value
@@ -691,7 +691,7 @@ ___
*Overrides Uint8Array.subarray*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/U8a.ts#L53)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/U8a.ts#L53)*
*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here
@@ -715,7 +715,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/U8a.ts#L60)*
*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/U8a.ts#L60)*
*__description__*: Returns a hex string representation of the value
@@ -732,7 +732,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
*Defined in [AccountId.ts:46](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/AccountId.ts#L46)*
*Defined in [AccountId.ts:46](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/AccountId.ts#L46)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -764,7 +764,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)*
*Defined in [AccountId.ts:53](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/AccountId.ts#L53)*
*Defined in [AccountId.ts:53](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/AccountId.ts#L53)*
*__description__*: Returns the string representation of the value
@@ -781,7 +781,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/U8a.ts#L82)*
*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/U8a.ts#L82)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -815,7 +815,7 @@ ___
▸ **encode**(value: *`Uint8Array`*): `string`
*Defined in [AccountId.ts:27](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/AccountId.ts#L27)*
*Defined in [AccountId.ts:27](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/AccountId.ts#L27)*
**Parameters:**
docs/types/classes/_accountindex_.accountindex.html
+44 -44
View File
@@ -1122,9 +1122,9 @@
</li>
<li class="chapter " data-level="4.58" data-path="_metadata_.callmetadata.html">
<li class="chapter " data-level="4.58" data-path="_metadata_.callmetadata.md">
<a href="_metadata_.callmetadata.html">
<span>
hidden
@@ -1135,9 +1135,9 @@
</li>
<li class="chapter " data-level="4.59" data-path="_metadata_.eventmetadata.html">
<li class="chapter " data-level="4.59" data-path="_metadata_.eventmetadata.md">
<a href="_metadata_.eventmetadata.html">
<span>
hidden
@@ -1148,9 +1148,9 @@
</li>
<li class="chapter " data-level="4.60" data-path="_metadata_.functionargumentmetadata.html">
<li class="chapter " data-level="4.60" data-path="_metadata_.functionargumentmetadata.md">
<a href="_metadata_.functionargumentmetadata.html">
<span>
hidden
@@ -1161,9 +1161,9 @@
</li>
<li class="chapter " data-level="4.61" data-path="_metadata_.functionmetadata.html">
<li class="chapter " data-level="4.61" data-path="_metadata_.functionmetadata.md">
<a href="_metadata_.functionmetadata.html">
<span>
hidden
@@ -1174,9 +1174,9 @@
</li>
<li class="chapter " data-level="4.62" data-path="_metadata_.modulemetadata.html">
<li class="chapter " data-level="4.62" data-path="_metadata_.modulemetadata.md">
<a href="_metadata_.modulemetadata.html">
<span>
hidden
@@ -1187,9 +1187,9 @@
</li>
<li class="chapter " data-level="4.63" data-path="_metadata_.outerdispatchcall.html">
<li class="chapter " data-level="4.63" data-path="_metadata_.outerdispatchcall.md">
<a href="_metadata_.outerdispatchcall.html">
<span>
hidden
@@ -1200,9 +1200,9 @@
</li>
<li class="chapter " data-level="4.64" data-path="_metadata_.outerdispatchmetadata.html">
<li class="chapter " data-level="4.64" data-path="_metadata_.outerdispatchmetadata.md">
<a href="_metadata_.outerdispatchmetadata.html">
<span>
hidden
@@ -1213,9 +1213,9 @@
</li>
<li class="chapter " data-level="4.65" data-path="_metadata_.outereventmetadata.html">
<li class="chapter " data-level="4.65" data-path="_metadata_.outereventmetadata.md">
<a href="_metadata_.outereventmetadata.html">
<span>
hidden
@@ -1226,9 +1226,9 @@
</li>
<li class="chapter " data-level="4.66" data-path="_metadata_.outereventmetadataevent.html">
<li class="chapter " data-level="4.66" data-path="_metadata_.outereventmetadataevent.md">
<a href="_metadata_.outereventmetadataevent.html">
<span>
hidden
@@ -1252,9 +1252,9 @@
</li>
<li class="chapter " data-level="4.68" data-path="_metadata_.runtimemodulemetadata.html">
<li class="chapter " data-level="4.68" data-path="_metadata_.runtimemodulemetadata.md">
<a href="_metadata_.runtimemodulemetadata.html">
<span>
hidden
@@ -1265,9 +1265,9 @@
</li>
<li class="chapter " data-level="4.69" data-path="_metadata_.storagefunctionmetadata.html">
<li class="chapter " data-level="4.69" data-path="_metadata_.storagefunctionmetadata.md">
<a href="_metadata_.storagefunctionmetadata.html">
<span>
hidden
@@ -1278,9 +1278,9 @@
</li>
<li class="chapter " data-level="4.70" data-path="_metadata_.storagefunctionmodifier.html">
<li class="chapter " data-level="4.70" data-path="_metadata_.storagefunctionmodifier.md">
<a href="_metadata_.storagefunctionmodifier.html">
<span>
hidden
@@ -1291,9 +1291,9 @@
</li>
<li class="chapter " data-level="4.71" data-path="_metadata_.storagefunctiontype.html">
<li class="chapter " data-level="4.71" data-path="_metadata_.storagefunctiontype.md">
<a href="_metadata_.storagefunctiontype.html">
<span>
hidden
@@ -1304,9 +1304,9 @@
</li>
<li class="chapter " data-level="4.72" data-path="_metadata_.storagefunctiontype_map.html">
<li class="chapter " data-level="4.72" data-path="_metadata_.storagefunctiontype_map.md">
<a href="_metadata_.storagefunctiontype_map.html">
<span>
hidden
@@ -1317,9 +1317,9 @@
</li>
<li class="chapter " data-level="4.73" data-path="_metadata_.storagemetadata.html">
<li class="chapter " data-level="4.73" data-path="_metadata_.storagemetadata.md">
<a href="_metadata_.storagemetadata.html">
<span>
hidden
@@ -1974,7 +1974,7 @@
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new AccountIndex</strong>(value?: <em><a href="../modules/_types_.md#anynumber">AnyNumber</a></em>): <a href="_accountindex_.accountindex.html">AccountIndex</a></p>
<p><em>Overrides <a href="_u32_.u32.html">U32</a>.<a href="_u32_.u32.html#constructor">constructor</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/AccountIndex.ts#L29" target="_blank">AccountIndex.ts:29</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/AccountIndex.ts#L29" target="_blank">AccountIndex.ts:29</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -1999,7 +1999,7 @@
<h2 id="encodedlength">encodedLength</h2>
<p>getencodedLength(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#encodedlength">encodedLength</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/UInt.ts#L57" target="_blank">codec/UInt.ts:57</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/UInt.ts#L57" target="_blank">codec/UInt.ts:57</a></em></p>
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2132,7 +2132,7 @@
<p>&#x25B8; <strong>bitLength</strong>(): <a href="../modules/_codec_uint_.md#uintbitlength">UIntBitLength</a></p>
<p><em>Inherited from <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#bitlength">bitLength</a></em></p>
<p><em>Overrides BN.bitLength</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/UInt.ts#L64" target="_blank">codec/UInt.ts:64</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/UInt.ts#L64" target="_blank">codec/UInt.ts:64</a></em></p>
<p><em><strong>description</strong></em>: Returns the number of bits in the value</p>
<p><strong>Returns:</strong> <a href="../modules/_codec_uint_.md#uintbitlength">UIntBitLength</a></p>
<hr>
@@ -3510,7 +3510,7 @@
<h2 id="tobn">toBn</h2>
<p>&#x25B8; <strong>toBn</strong>(): <code>BN</code></p>
<p><em>Overrides <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#tobn">toBn</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/AccountIndex.ts#L92" target="_blank">AccountIndex.ts:92</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/AccountIndex.ts#L92" target="_blank">AccountIndex.ts:92</a></em></p>
<p><em><strong>description</strong></em>: Returns the BN representation of the AccountIndex</p>
<p><strong>Returns:</strong> <code>BN</code></p>
<hr>
@@ -3546,7 +3546,7 @@
<p>&#x25B8; <strong>toHex</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
<p><em>Overrides <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#tohex">toHex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/AccountIndex.ts#L99" target="_blank">AccountIndex.ts:99</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/AccountIndex.ts#L99" target="_blank">AccountIndex.ts:99</a></em></p>
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -3555,7 +3555,7 @@
<p>&#x25B8; <strong>toJSON</strong>(): <code>any</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
<p><em>Overrides <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#tojson">toJSON</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/AccountIndex.ts#L108" target="_blank">AccountIndex.ts:108</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/AccountIndex.ts#L108" target="_blank">AccountIndex.ts:108</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
<p><strong>Returns:</strong> <code>any</code></p>
<hr>
@@ -3595,7 +3595,7 @@
<p>&#x25B8; <strong>toString</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
<p><em>Overrides <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#tostring">toString</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/AccountIndex.ts#L115" target="_blank">AccountIndex.ts:115</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/AccountIndex.ts#L115" target="_blank">AccountIndex.ts:115</a></em></p>
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -3627,7 +3627,7 @@
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em> <code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tou8a">toU8a</a></em></p>
<p><em>Overrides <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#tou8a">toU8a</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/AccountIndex.ts#L125" target="_blank">AccountIndex.ts:125</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/AccountIndex.ts#L125" target="_blank">AccountIndex.ts:125</a></em></p>
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -3843,7 +3843,7 @@
<p><a id="calclength"></a></p>
<h2 id="static-calclength"><code>&lt;Static&gt;</code> calcLength</h2>
<p>&#x25B8; <strong>calcLength</strong>(_value: <em> <code>BN</code> | <code>number</code></em>): <code>number</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/AccountIndex.ts#L52" target="_blank">AccountIndex.ts:52</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/AccountIndex.ts#L52" target="_blank">AccountIndex.ts:52</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -3864,7 +3864,7 @@
<p><a id="decodeaccountindex"></a></p>
<h2 id="static-decodeaccountindex"><code>&lt;Static&gt;</code> decodeAccountIndex</h2>
<p>&#x25B8; <strong>decodeAccountIndex</strong>(value: <em><a href="../modules/_types_.md#anynumber">AnyNumber</a></em>): <code>BN</code> | <code>Uint8Array</code> | <code>number</code> | <code>string</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/AccountIndex.ts#L36" target="_blank">AccountIndex.ts:36</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/AccountIndex.ts#L36" target="_blank">AccountIndex.ts:36</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -3886,7 +3886,7 @@
<h2 id="static-decodeuint"><code>&lt;Static&gt;</code> decodeUInt</h2>
<p>&#x25B8; <strong>decodeUInt</strong>(value: <em><a href="../modules/_types_.md#anynumber">AnyNumber</a></em>, bitLength: <em><a href="../modules/_codec_uint_.md#uintbitlength">UIntBitLength</a></em>): <code>string</code></p>
<p><em>Inherited from <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#decodeuint">decodeUInt</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/UInt.ts#L38" target="_blank">codec/UInt.ts:38</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/UInt.ts#L38" target="_blank">codec/UInt.ts:38</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -4011,7 +4011,7 @@
<p><a id="readlength"></a></p>
<h2 id="static-readlength"><code>&lt;Static&gt;</code> readLength</h2>
<p>&#x25B8; <strong>readLength</strong>(input: <em><code>Uint8Array</code></em>): [<code>number</code>, <code>number</code>]</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/AccountIndex.ts#L66" target="_blank">AccountIndex.ts:66</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/AccountIndex.ts#L66" target="_blank">AccountIndex.ts:66</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -4055,7 +4055,7 @@
<p><a id="writelength"></a></p>
<h2 id="static-writelength"><code>&lt;Static&gt;</code> writeLength</h2>
<p>&#x25B8; <strong>writeLength</strong>(input: <em><code>Uint8Array</code></em>): <code>Uint8Array</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/AccountIndex.ts#L80" target="_blank">AccountIndex.ts:80</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/AccountIndex.ts#L80" target="_blank">AccountIndex.ts:80</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -4116,7 +4116,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.2","depth":1,"next":{"title":"hidden","level":"4.3","depth":1,"path":"types/classes/_address_.address.md","ref":"types/classes/_address_.address.md","articles":[]},"previous":{"title":"hidden","level":"4.1","depth":1,"path":"types/classes/_accountid_.accountid.md","ref":"types/classes/_accountid_.accountid.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"types/classes/_accountindex_.accountindex.md","mtime":"2018-12-07T11:33:58.635Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-07T11:34:45.610Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.2","depth":1,"next":{"title":"hidden","level":"4.3","depth":1,"path":"types/classes/_address_.address.md","ref":"types/classes/_address_.address.md","articles":[]},"previous":{"title":"hidden","level":"4.1","depth":1,"path":"types/classes/_accountid_.accountid.md","ref":"types/classes/_accountid_.accountid.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"types/classes/_accountindex_.accountindex.md","mtime":"2018-12-08T14:35:37.986Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-08T14:36:23.372Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_accountindex_.accountindex.md
+13 -13
View File
@@ -24,7 +24,7 @@
*Overrides [U32](_u32_.u32.md).[constructor](_u32_.u32.md#constructor)*
*Defined in [AccountIndex.ts:29](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/AccountIndex.ts#L29)*
*Defined in [AccountIndex.ts:29](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/AccountIndex.ts#L29)*
**Parameters:**
@@ -46,7 +46,7 @@ getencodedLength(): `number`
*Inherited from [UInt](_codec_uint_.uint.md).[encodedLength](_codec_uint_.uint.md#encodedlength)*
*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/UInt.ts#L57)*
*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/UInt.ts#L57)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -186,7 +186,7 @@ ___
*Overrides BN.bitLength*
*Defined in [codec/UInt.ts:64](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/UInt.ts#L64)*
*Defined in [codec/UInt.ts:64](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/UInt.ts#L64)*
*__description__*: Returns the number of bits in the value
@@ -1521,7 +1521,7 @@ ___
*Overrides [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)*
*Defined in [AccountIndex.ts:92](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/AccountIndex.ts#L92)*
*Defined in [AccountIndex.ts:92](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/AccountIndex.ts#L92)*
*__description__*: Returns the BN representation of the AccountIndex
@@ -1560,7 +1560,7 @@ ___
*Overrides [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)*
*Defined in [AccountIndex.ts:99](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/AccountIndex.ts#L99)*
*Defined in [AccountIndex.ts:99](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/AccountIndex.ts#L99)*
*__description__*: Returns a hex string representation of the value
@@ -1577,7 +1577,7 @@ ___
*Overrides [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)*
*Defined in [AccountIndex.ts:108](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/AccountIndex.ts#L108)*
*Defined in [AccountIndex.ts:108](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/AccountIndex.ts#L108)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -1630,7 +1630,7 @@ ___
*Overrides [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)*
*Defined in [AccountIndex.ts:115](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/AccountIndex.ts#L115)*
*Defined in [AccountIndex.ts:115](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/AccountIndex.ts#L115)*
*__description__*: Returns the string representation of the value
@@ -1668,7 +1668,7 @@ ___
*Overrides [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)*
*Defined in [AccountIndex.ts:125](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/AccountIndex.ts#L125)*
*Defined in [AccountIndex.ts:125](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/AccountIndex.ts#L125)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -1870,7 +1870,7 @@ ___
▸ **calcLength**(_value: * `BN` &#124; `number`*): `number`
*Defined in [AccountIndex.ts:52](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/AccountIndex.ts#L52)*
*Defined in [AccountIndex.ts:52](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/AccountIndex.ts#L52)*
**Parameters:**
@@ -1887,7 +1887,7 @@ ___
▸ **decodeAccountIndex**(value: *[AnyNumber](../modules/_types_.md#anynumber)*): `BN` &#124; `Uint8Array` &#124; `number` &#124; `string`
*Defined in [AccountIndex.ts:36](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/AccountIndex.ts#L36)*
*Defined in [AccountIndex.ts:36](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/AccountIndex.ts#L36)*
**Parameters:**
@@ -1906,7 +1906,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)*
*Defined in [codec/UInt.ts:38](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/UInt.ts#L38)*
*Defined in [codec/UInt.ts:38](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/UInt.ts#L38)*
**Parameters:**
@@ -2010,7 +2010,7 @@ ___
▸ **readLength**(input: *`Uint8Array`*): [`number`, `number`]
*Defined in [AccountIndex.ts:66](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/AccountIndex.ts#L66)*
*Defined in [AccountIndex.ts:66](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/AccountIndex.ts#L66)*
**Parameters:**
@@ -2048,7 +2048,7 @@ ___
▸ **writeLength**(input: *`Uint8Array`*): `Uint8Array`
*Defined in [AccountIndex.ts:80](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/AccountIndex.ts#L80)*
*Defined in [AccountIndex.ts:80](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/AccountIndex.ts#L80)*
**Parameters:**
docs/types/classes/_address_.address.html
+39 -39
View File
@@ -1122,9 +1122,9 @@
</li>
<li class="chapter " data-level="4.58" data-path="_metadata_.callmetadata.html">
<li class="chapter " data-level="4.58" data-path="_metadata_.callmetadata.md">
<a href="_metadata_.callmetadata.html">
<span>
hidden
@@ -1135,9 +1135,9 @@
</li>
<li class="chapter " data-level="4.59" data-path="_metadata_.eventmetadata.html">
<li class="chapter " data-level="4.59" data-path="_metadata_.eventmetadata.md">
<a href="_metadata_.eventmetadata.html">
<span>
hidden
@@ -1148,9 +1148,9 @@
</li>
<li class="chapter " data-level="4.60" data-path="_metadata_.functionargumentmetadata.html">
<li class="chapter " data-level="4.60" data-path="_metadata_.functionargumentmetadata.md">
<a href="_metadata_.functionargumentmetadata.html">
<span>
hidden
@@ -1161,9 +1161,9 @@
</li>
<li class="chapter " data-level="4.61" data-path="_metadata_.functionmetadata.html">
<li class="chapter " data-level="4.61" data-path="_metadata_.functionmetadata.md">
<a href="_metadata_.functionmetadata.html">
<span>
hidden
@@ -1174,9 +1174,9 @@
</li>
<li class="chapter " data-level="4.62" data-path="_metadata_.modulemetadata.html">
<li class="chapter " data-level="4.62" data-path="_metadata_.modulemetadata.md">
<a href="_metadata_.modulemetadata.html">
<span>
hidden
@@ -1187,9 +1187,9 @@
</li>
<li class="chapter " data-level="4.63" data-path="_metadata_.outerdispatchcall.html">
<li class="chapter " data-level="4.63" data-path="_metadata_.outerdispatchcall.md">
<a href="_metadata_.outerdispatchcall.html">
<span>
hidden
@@ -1200,9 +1200,9 @@
</li>
<li class="chapter " data-level="4.64" data-path="_metadata_.outerdispatchmetadata.html">
<li class="chapter " data-level="4.64" data-path="_metadata_.outerdispatchmetadata.md">
<a href="_metadata_.outerdispatchmetadata.html">
<span>
hidden
@@ -1213,9 +1213,9 @@
</li>
<li class="chapter " data-level="4.65" data-path="_metadata_.outereventmetadata.html">
<li class="chapter " data-level="4.65" data-path="_metadata_.outereventmetadata.md">
<a href="_metadata_.outereventmetadata.html">
<span>
hidden
@@ -1226,9 +1226,9 @@
</li>
<li class="chapter " data-level="4.66" data-path="_metadata_.outereventmetadataevent.html">
<li class="chapter " data-level="4.66" data-path="_metadata_.outereventmetadataevent.md">
<a href="_metadata_.outereventmetadataevent.html">
<span>
hidden
@@ -1252,9 +1252,9 @@
</li>
<li class="chapter " data-level="4.68" data-path="_metadata_.runtimemodulemetadata.html">
<li class="chapter " data-level="4.68" data-path="_metadata_.runtimemodulemetadata.md">
<a href="_metadata_.runtimemodulemetadata.html">
<span>
hidden
@@ -1265,9 +1265,9 @@
</li>
<li class="chapter " data-level="4.69" data-path="_metadata_.storagefunctionmetadata.html">
<li class="chapter " data-level="4.69" data-path="_metadata_.storagefunctionmetadata.md">
<a href="_metadata_.storagefunctionmetadata.html">
<span>
hidden
@@ -1278,9 +1278,9 @@
</li>
<li class="chapter " data-level="4.70" data-path="_metadata_.storagefunctionmodifier.html">
<li class="chapter " data-level="4.70" data-path="_metadata_.storagefunctionmodifier.md">
<a href="_metadata_.storagefunctionmodifier.html">
<span>
hidden
@@ -1291,9 +1291,9 @@
</li>
<li class="chapter " data-level="4.71" data-path="_metadata_.storagefunctiontype.html">
<li class="chapter " data-level="4.71" data-path="_metadata_.storagefunctiontype.md">
<a href="_metadata_.storagefunctiontype.html">
<span>
hidden
@@ -1304,9 +1304,9 @@
</li>
<li class="chapter " data-level="4.72" data-path="_metadata_.storagefunctiontype_map.html">
<li class="chapter " data-level="4.72" data-path="_metadata_.storagefunctiontype_map.md">
<a href="_metadata_.storagefunctiontype_map.html">
<span>
hidden
@@ -1317,9 +1317,9 @@
</li>
<li class="chapter " data-level="4.73" data-path="_metadata_.storagemetadata.html">
<li class="chapter " data-level="4.73" data-path="_metadata_.storagemetadata.md">
<a href="_metadata_.storagemetadata.html">
<span>
hidden
@@ -1970,7 +1970,7 @@
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new Address</strong>(value?: <em><code>AnyAddress</code></em>): <a href="_address_.address.html">Address</a></p>
<p><em>Overrides <a href="_codec_base_.base.html">Base</a>.<a href="_codec_base_.base.html#constructor">constructor</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Address.ts#L25" target="_blank">Address.ts:25</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Address.ts#L25" target="_blank">Address.ts:25</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -1994,14 +1994,14 @@
<p><a id="encodedlength"></a></p>
<h2 id="encodedlength">encodedLength</h2>
<p>getencodedLength(): <code>number</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Address.ts#L67" target="_blank">Address.ts:67</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Address.ts#L67" target="_blank">Address.ts:67</a></em></p>
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
<p><a id="rawlength"></a></p>
<h2 id="rawlength">rawLength</h2>
<p>getrawLength(): <code>number</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Address.ts#L81" target="_blank">Address.ts:81</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Address.ts#L81" target="_blank">Address.ts:81</a></em></p>
<p><em><strong>description</strong></em>: The length of the raw value, either AccountIndex or AccountId</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2009,28 +2009,28 @@
<p><a id="tohex"></a></p>
<h2 id="tohex">toHex</h2>
<p>&#x25B8; <strong>toHex</strong>(): <code>string</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Address.ts#L90" target="_blank">Address.ts:90</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Address.ts#L90" target="_blank">Address.ts:90</a></em></p>
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
<p><a id="tojson"></a></p>
<h2 id="tojson">toJSON</h2>
<p>&#x25B8; <strong>toJSON</strong>(): <code>any</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Address.ts#L97" target="_blank">Address.ts:97</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Address.ts#L97" target="_blank">Address.ts:97</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
<p><strong>Returns:</strong> <code>any</code></p>
<hr>
<p><a id="tostring"></a></p>
<h2 id="tostring">toString</h2>
<p>&#x25B8; <strong>toString</strong>(): <code>string</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Address.ts#L104" target="_blank">Address.ts:104</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Address.ts#L104" target="_blank">Address.ts:104</a></em></p>
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
<p><a id="tou8a"></a></p>
<h2 id="tou8a">toU8a</h2>
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em> <code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Address.ts#L112" target="_blank">Address.ts:112</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Address.ts#L112" target="_blank">Address.ts:112</a></em></p>
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2054,7 +2054,7 @@
<p><a id="decodeaddress"></a></p>
<h2 id="static-decodeaddress"><code>&lt;Static&gt;</code> decodeAddress</h2>
<p>&#x25B8; <strong>decodeAddress</strong>(value: <em><code>AnyAddress</code></em>): <a href="_accountid_.accountid.html">AccountId</a> | <a href="_accountindex_.accountindex.html">AccountIndex</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Address.ts#L32" target="_blank">Address.ts:32</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Address.ts#L32" target="_blank">Address.ts:32</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2115,7 +2115,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.3","depth":1,"next":{"title":"hidden","level":"4.4","depth":1,"path":"types/classes/_authorityid_.authorityid.md","ref":"types/classes/_authorityid_.authorityid.md","articles":[]},"previous":{"title":"hidden","level":"4.2","depth":1,"path":"types/classes/_accountindex_.accountindex.md","ref":"types/classes/_accountindex_.accountindex.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"types/classes/_address_.address.md","mtime":"2018-12-07T11:33:58.655Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-07T11:34:45.610Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.3","depth":1,"next":{"title":"hidden","level":"4.4","depth":1,"path":"types/classes/_authorityid_.authorityid.md","ref":"types/classes/_authorityid_.authorityid.md","articles":[]},"previous":{"title":"hidden","level":"4.2","depth":1,"path":"types/classes/_accountindex_.accountindex.md","ref":"types/classes/_accountindex_.accountindex.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"types/classes/_address_.address.md","mtime":"2018-12-08T14:35:38.006Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-08T14:36:23.372Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_address_.address.md
+8 -8
View File
@@ -20,7 +20,7 @@
*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)*
*Defined in [Address.ts:25](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Address.ts#L25)*
*Defined in [Address.ts:25](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Address.ts#L25)*
**Parameters:**
@@ -40,7 +40,7 @@ ___
getencodedLength(): `number`
*Defined in [Address.ts:67](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Address.ts#L67)*
*Defined in [Address.ts:67](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Address.ts#L67)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -53,7 +53,7 @@ ___
getrawLength(): `number`
*Defined in [Address.ts:81](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Address.ts#L81)*
*Defined in [Address.ts:81](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Address.ts#L81)*
*__description__*: The length of the raw value, either AccountIndex or AccountId
@@ -69,7 +69,7 @@ ___
▸ **toHex**(): `string`
*Defined in [Address.ts:90](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Address.ts#L90)*
*Defined in [Address.ts:90](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Address.ts#L90)*
*__description__*: Returns a hex string representation of the value
@@ -82,7 +82,7 @@ ___
▸ **toJSON**(): `any`
*Defined in [Address.ts:97](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Address.ts#L97)*
*Defined in [Address.ts:97](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Address.ts#L97)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -95,7 +95,7 @@ ___
▸ **toString**(): `string`
*Defined in [Address.ts:104](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Address.ts#L104)*
*Defined in [Address.ts:104](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Address.ts#L104)*
*__description__*: Returns the string representation of the value
@@ -108,7 +108,7 @@ ___
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Defined in [Address.ts:112](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Address.ts#L112)*
*Defined in [Address.ts:112](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Address.ts#L112)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -127,7 +127,7 @@ ___
▸ **decodeAddress**(value: *`AnyAddress`*): [AccountId](_accountid_.accountid.md) &#124; [AccountIndex](_accountindex_.accountindex.md)
*Defined in [Address.ts:32](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Address.ts#L32)*
*Defined in [Address.ts:32](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Address.ts#L32)*
**Parameters:**
docs/types/classes/_authorityid_.authorityid.html
+41 -41
View File
@@ -1122,9 +1122,9 @@
</li>
<li class="chapter " data-level="4.58" data-path="_metadata_.callmetadata.html">
<li class="chapter " data-level="4.58" data-path="_metadata_.callmetadata.md">
<a href="_metadata_.callmetadata.html">
<span>
hidden
@@ -1135,9 +1135,9 @@
</li>
<li class="chapter " data-level="4.59" data-path="_metadata_.eventmetadata.html">
<li class="chapter " data-level="4.59" data-path="_metadata_.eventmetadata.md">
<a href="_metadata_.eventmetadata.html">
<span>
hidden
@@ -1148,9 +1148,9 @@
</li>
<li class="chapter " data-level="4.60" data-path="_metadata_.functionargumentmetadata.html">
<li class="chapter " data-level="4.60" data-path="_metadata_.functionargumentmetadata.md">
<a href="_metadata_.functionargumentmetadata.html">
<span>
hidden
@@ -1161,9 +1161,9 @@
</li>
<li class="chapter " data-level="4.61" data-path="_metadata_.functionmetadata.html">
<li class="chapter " data-level="4.61" data-path="_metadata_.functionmetadata.md">
<a href="_metadata_.functionmetadata.html">
<span>
hidden
@@ -1174,9 +1174,9 @@
</li>
<li class="chapter " data-level="4.62" data-path="_metadata_.modulemetadata.html">
<li class="chapter " data-level="4.62" data-path="_metadata_.modulemetadata.md">
<a href="_metadata_.modulemetadata.html">
<span>
hidden
@@ -1187,9 +1187,9 @@
</li>
<li class="chapter " data-level="4.63" data-path="_metadata_.outerdispatchcall.html">
<li class="chapter " data-level="4.63" data-path="_metadata_.outerdispatchcall.md">
<a href="_metadata_.outerdispatchcall.html">
<span>
hidden
@@ -1200,9 +1200,9 @@
</li>
<li class="chapter " data-level="4.64" data-path="_metadata_.outerdispatchmetadata.html">
<li class="chapter " data-level="4.64" data-path="_metadata_.outerdispatchmetadata.md">
<a href="_metadata_.outerdispatchmetadata.html">
<span>
hidden
@@ -1213,9 +1213,9 @@
</li>
<li class="chapter " data-level="4.65" data-path="_metadata_.outereventmetadata.html">
<li class="chapter " data-level="4.65" data-path="_metadata_.outereventmetadata.md">
<a href="_metadata_.outereventmetadata.html">
<span>
hidden
@@ -1226,9 +1226,9 @@
</li>
<li class="chapter " data-level="4.66" data-path="_metadata_.outereventmetadataevent.html">
<li class="chapter " data-level="4.66" data-path="_metadata_.outereventmetadataevent.md">
<a href="_metadata_.outereventmetadataevent.html">
<span>
hidden
@@ -1252,9 +1252,9 @@
</li>
<li class="chapter " data-level="4.68" data-path="_metadata_.runtimemodulemetadata.html">
<li class="chapter " data-level="4.68" data-path="_metadata_.runtimemodulemetadata.md">
<a href="_metadata_.runtimemodulemetadata.html">
<span>
hidden
@@ -1265,9 +1265,9 @@
</li>
<li class="chapter " data-level="4.69" data-path="_metadata_.storagefunctionmetadata.html">
<li class="chapter " data-level="4.69" data-path="_metadata_.storagefunctionmetadata.md">
<a href="_metadata_.storagefunctionmetadata.html">
<span>
hidden
@@ -1278,9 +1278,9 @@
</li>
<li class="chapter " data-level="4.70" data-path="_metadata_.storagefunctionmodifier.html">
<li class="chapter " data-level="4.70" data-path="_metadata_.storagefunctionmodifier.md">
<a href="_metadata_.storagefunctionmodifier.html">
<span>
hidden
@@ -1291,9 +1291,9 @@
</li>
<li class="chapter " data-level="4.71" data-path="_metadata_.storagefunctiontype.html">
<li class="chapter " data-level="4.71" data-path="_metadata_.storagefunctiontype.md">
<a href="_metadata_.storagefunctiontype.html">
<span>
hidden
@@ -1304,9 +1304,9 @@
</li>
<li class="chapter " data-level="4.72" data-path="_metadata_.storagefunctiontype_map.html">
<li class="chapter " data-level="4.72" data-path="_metadata_.storagefunctiontype_map.md">
<a href="_metadata_.storagefunctiontype_map.html">
<span>
hidden
@@ -1317,9 +1317,9 @@
</li>
<li class="chapter " data-level="4.73" data-path="_metadata_.storagemetadata.html">
<li class="chapter " data-level="4.73" data-path="_metadata_.storagemetadata.md">
<a href="_metadata_.storagemetadata.html">
<span>
hidden
@@ -1976,7 +1976,7 @@
<p>&#x2295; <strong>new AuthorityId</strong>(value?: <em><a href="../modules/_types_.md#anyu8a">AnyU8a</a></em>): <a href="_authorityid_.authorityid.html">AuthorityId</a></p>
<p><em>Inherited from <a href="_accountid_.accountid.html">AccountId</a>.<a href="_accountid_.accountid.html#constructor">constructor</a></em></p>
<p><em>Overrides <a href="_codec_u8afixed_.u8afixed.html">U8aFixed</a>.<a href="_codec_u8afixed_.u8afixed.html#constructor">constructor</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/AccountId.ts#L19" target="_blank">AccountId.ts:19</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/AccountId.ts#L19" target="_blank">AccountId.ts:19</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2036,7 +2036,7 @@
<h2 id="encodedlength">encodedLength</h2>
<p>getencodedLength(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#encodedlength">encodedLength</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/U8a.ts#L36" target="_blank">codec/U8a.ts:36</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/U8a.ts#L36" target="_blank">codec/U8a.ts:36</a></em></p>
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2045,7 +2045,7 @@
<p>getlength(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#length">length</a></em></p>
<p><em>Overrides Uint8Array.length</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/U8a.ts#L43" target="_blank">codec/U8a.ts:43</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/U8a.ts#L43" target="_blank">codec/U8a.ts:43</a></em></p>
<p><em><strong>description</strong></em>: The length of the value</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2061,7 +2061,7 @@
<h2 id="bitlength">bitLength</h2>
<p>&#x25B8; <strong>bitLength</strong>(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_u8afixed_.u8afixed.html">U8aFixed</a>.<a href="_codec_u8afixed_.u8afixed.html#bitlength">bitLength</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/U8aFixed.ts#L39" target="_blank">codec/U8aFixed.ts:39</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/U8aFixed.ts#L39" target="_blank">codec/U8aFixed.ts:39</a></em></p>
<p><em><strong>description</strong></em>: Returns the number of bits in the value</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2728,7 +2728,7 @@
<p>&#x25B8; <strong>subarray</strong>(begin: <em><code>number</code></em>, end?: <em> <code>undefined</code> | <code>number</code></em>): <code>Uint8Array</code></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#subarray">subarray</a></em></p>
<p><em>Overrides Uint8Array.subarray</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/U8a.ts#L53" target="_blank">codec/U8a.ts:53</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/U8a.ts#L53" target="_blank">codec/U8a.ts:53</a></em></p>
<p><em><strong>description</strong></em>: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2759,7 +2759,7 @@
<p>&#x25B8; <strong>toHex</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#tohex">toHex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/U8a.ts#L60" target="_blank">codec/U8a.ts:60</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/U8a.ts#L60" target="_blank">codec/U8a.ts:60</a></em></p>
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2769,7 +2769,7 @@
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
<p><em>Inherited from <a href="_accountid_.accountid.html">AccountId</a>.<a href="_accountid_.accountid.html#tojson">toJSON</a></em></p>
<p><em>Overrides <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#tojson">toJSON</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/AccountId.ts#L46" target="_blank">AccountId.ts:46</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/AccountId.ts#L46" target="_blank">AccountId.ts:46</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
<p><strong>Returns:</strong> <code>any</code></p>
<hr>
@@ -2787,7 +2787,7 @@
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
<p><em>Inherited from <a href="_accountid_.accountid.html">AccountId</a>.<a href="_accountid_.accountid.html#tostring">toString</a></em></p>
<p><em>Overrides <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#tostring">toString</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/AccountId.ts#L53" target="_blank">AccountId.ts:53</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/AccountId.ts#L53" target="_blank">AccountId.ts:53</a></em></p>
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2796,7 +2796,7 @@
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em> <code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tou8a">toU8a</a></em></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#tou8a">toU8a</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/U8a.ts#L82" target="_blank">codec/U8a.ts:82</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/U8a.ts#L82" target="_blank">codec/U8a.ts:82</a></em></p>
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2829,7 +2829,7 @@
<h2 id="static-encode"><code>&lt;Static&gt;</code> encode</h2>
<p>&#x25B8; <strong>encode</strong>(value: <em><code>Uint8Array</code></em>): <code>string</code></p>
<p><em>Inherited from <a href="_accountid_.accountid.html">AccountId</a>.<a href="_accountid_.accountid.html#encode">encode</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/AccountId.ts#L27" target="_blank">AccountId.ts:27</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/AccountId.ts#L27" target="_blank">AccountId.ts:27</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2890,7 +2890,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.4","depth":1,"next":{"title":"hidden","level":"4.5","depth":1,"path":"types/classes/_balance_.balance.md","ref":"types/classes/_balance_.balance.md","articles":[]},"previous":{"title":"hidden","level":"4.3","depth":1,"path":"types/classes/_address_.address.md","ref":"types/classes/_address_.address.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"types/classes/_authorityid_.authorityid.md","mtime":"2018-12-07T11:33:58.851Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-07T11:34:45.610Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.4","depth":1,"next":{"title":"hidden","level":"4.5","depth":1,"path":"types/classes/_balance_.balance.md","ref":"types/classes/_balance_.balance.md","articles":[]},"previous":{"title":"hidden","level":"4.3","depth":1,"path":"types/classes/_address_.address.md","ref":"types/classes/_address_.address.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"types/classes/_authorityid_.authorityid.md","mtime":"2018-12-08T14:35:38.402Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-08T14:36:23.372Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_authorityid_.authorityid.md
+10 -10
View File
@@ -27,7 +27,7 @@
*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)*
*Defined in [AccountId.ts:19](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/AccountId.ts#L19)*
*Defined in [AccountId.ts:19](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/AccountId.ts#L19)*
**Parameters:**
@@ -115,7 +115,7 @@ getencodedLength(): `number`
*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/U8a.ts#L36)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/U8a.ts#L36)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -132,7 +132,7 @@ getlength(): `number`
*Overrides Uint8Array.length*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/U8a.ts#L43)*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/U8a.ts#L43)*
*__description__*: The length of the value
@@ -163,7 +163,7 @@ ___
*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)*
*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/U8aFixed.ts#L39)*
*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/U8aFixed.ts#L39)*
*__description__*: Returns the number of bits in the value
@@ -689,7 +689,7 @@ ___
*Overrides Uint8Array.subarray*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/U8a.ts#L53)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/U8a.ts#L53)*
*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here
@@ -713,7 +713,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/U8a.ts#L60)*
*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/U8a.ts#L60)*
*__description__*: Returns a hex string representation of the value
@@ -732,7 +732,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
*Defined in [AccountId.ts:46](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/AccountId.ts#L46)*
*Defined in [AccountId.ts:46](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/AccountId.ts#L46)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -766,7 +766,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)*
*Defined in [AccountId.ts:53](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/AccountId.ts#L53)*
*Defined in [AccountId.ts:53](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/AccountId.ts#L53)*
*__description__*: Returns the string representation of the value
@@ -783,7 +783,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/U8a.ts#L82)*
*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/U8a.ts#L82)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -819,7 +819,7 @@ ___
*Inherited from [AccountId](_accountid_.accountid.md).[encode](_accountid_.accountid.md#encode)*
*Defined in [AccountId.ts:27](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/AccountId.ts#L27)*
*Defined in [AccountId.ts:27](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/AccountId.ts#L27)*
**Parameters:**
docs/types/classes/_balance_.balance.html
+40 -40
View File
@@ -1122,9 +1122,9 @@
</li>
<li class="chapter " data-level="4.58" data-path="_metadata_.callmetadata.html">
<li class="chapter " data-level="4.58" data-path="_metadata_.callmetadata.md">
<a href="_metadata_.callmetadata.html">
<span>
hidden
@@ -1135,9 +1135,9 @@
</li>
<li class="chapter " data-level="4.59" data-path="_metadata_.eventmetadata.html">
<li class="chapter " data-level="4.59" data-path="_metadata_.eventmetadata.md">
<a href="_metadata_.eventmetadata.html">
<span>
hidden
@@ -1148,9 +1148,9 @@
</li>
<li class="chapter " data-level="4.60" data-path="_metadata_.functionargumentmetadata.html">
<li class="chapter " data-level="4.60" data-path="_metadata_.functionargumentmetadata.md">
<a href="_metadata_.functionargumentmetadata.html">
<span>
hidden
@@ -1161,9 +1161,9 @@
</li>
<li class="chapter " data-level="4.61" data-path="_metadata_.functionmetadata.html">
<li class="chapter " data-level="4.61" data-path="_metadata_.functionmetadata.md">
<a href="_metadata_.functionmetadata.html">
<span>
hidden
@@ -1174,9 +1174,9 @@
</li>
<li class="chapter " data-level="4.62" data-path="_metadata_.modulemetadata.html">
<li class="chapter " data-level="4.62" data-path="_metadata_.modulemetadata.md">
<a href="_metadata_.modulemetadata.html">
<span>
hidden
@@ -1187,9 +1187,9 @@
</li>
<li class="chapter " data-level="4.63" data-path="_metadata_.outerdispatchcall.html">
<li class="chapter " data-level="4.63" data-path="_metadata_.outerdispatchcall.md">
<a href="_metadata_.outerdispatchcall.html">
<span>
hidden
@@ -1200,9 +1200,9 @@
</li>
<li class="chapter " data-level="4.64" data-path="_metadata_.outerdispatchmetadata.html">
<li class="chapter " data-level="4.64" data-path="_metadata_.outerdispatchmetadata.md">
<a href="_metadata_.outerdispatchmetadata.html">
<span>
hidden
@@ -1213,9 +1213,9 @@
</li>
<li class="chapter " data-level="4.65" data-path="_metadata_.outereventmetadata.html">
<li class="chapter " data-level="4.65" data-path="_metadata_.outereventmetadata.md">
<a href="_metadata_.outereventmetadata.html">
<span>
hidden
@@ -1226,9 +1226,9 @@
</li>
<li class="chapter " data-level="4.66" data-path="_metadata_.outereventmetadataevent.html">
<li class="chapter " data-level="4.66" data-path="_metadata_.outereventmetadataevent.md">
<a href="_metadata_.outereventmetadataevent.html">
<span>
hidden
@@ -1252,9 +1252,9 @@
</li>
<li class="chapter " data-level="4.68" data-path="_metadata_.runtimemodulemetadata.html">
<li class="chapter " data-level="4.68" data-path="_metadata_.runtimemodulemetadata.md">
<a href="_metadata_.runtimemodulemetadata.html">
<span>
hidden
@@ -1265,9 +1265,9 @@
</li>
<li class="chapter " data-level="4.69" data-path="_metadata_.storagefunctionmetadata.html">
<li class="chapter " data-level="4.69" data-path="_metadata_.storagefunctionmetadata.md">
<a href="_metadata_.storagefunctionmetadata.html">
<span>
hidden
@@ -1278,9 +1278,9 @@
</li>
<li class="chapter " data-level="4.70" data-path="_metadata_.storagefunctionmodifier.html">
<li class="chapter " data-level="4.70" data-path="_metadata_.storagefunctionmodifier.md">
<a href="_metadata_.storagefunctionmodifier.html">
<span>
hidden
@@ -1291,9 +1291,9 @@
</li>
<li class="chapter " data-level="4.71" data-path="_metadata_.storagefunctiontype.html">
<li class="chapter " data-level="4.71" data-path="_metadata_.storagefunctiontype.md">
<a href="_metadata_.storagefunctiontype.html">
<span>
hidden
@@ -1304,9 +1304,9 @@
</li>
<li class="chapter " data-level="4.72" data-path="_metadata_.storagefunctiontype_map.html">
<li class="chapter " data-level="4.72" data-path="_metadata_.storagefunctiontype_map.md">
<a href="_metadata_.storagefunctiontype_map.html">
<span>
hidden
@@ -1317,9 +1317,9 @@
</li>
<li class="chapter " data-level="4.73" data-path="_metadata_.storagemetadata.html">
<li class="chapter " data-level="4.73" data-path="_metadata_.storagemetadata.md">
<a href="_metadata_.storagemetadata.html">
<span>
hidden
@@ -1975,7 +1975,7 @@
<p>&#x2295; <strong>new Balance</strong>(value?: <em><a href="../modules/_types_.md#anynumber">AnyNumber</a></em>): <a href="_balance_.balance.html">Balance</a></p>
<p><em>Inherited from <a href="_u128_.u128.html">U128</a>.<a href="_u128_.u128.html#constructor">constructor</a></em></p>
<p><em>Overrides <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#constructor">constructor</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/U128.ts#L14" target="_blank">U128.ts:14</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/U128.ts#L14" target="_blank">U128.ts:14</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -1998,7 +1998,7 @@
<h2 id="encodedlength">encodedLength</h2>
<p>getencodedLength(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#encodedlength">encodedLength</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/UInt.ts#L57" target="_blank">codec/UInt.ts:57</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/UInt.ts#L57" target="_blank">codec/UInt.ts:57</a></em></p>
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2131,7 +2131,7 @@
<p>&#x25B8; <strong>bitLength</strong>(): <a href="../modules/_codec_uint_.md#uintbitlength">UIntBitLength</a></p>
<p><em>Inherited from <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#bitlength">bitLength</a></em></p>
<p><em>Overrides BN.bitLength</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/UInt.ts#L64" target="_blank">codec/UInt.ts:64</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/UInt.ts#L64" target="_blank">codec/UInt.ts:64</a></em></p>
<p><em><strong>description</strong></em>: Returns the number of bits in the value</p>
<p><strong>Returns:</strong> <a href="../modules/_codec_uint_.md#uintbitlength">UIntBitLength</a></p>
<hr>
@@ -3509,7 +3509,7 @@
<h2 id="tobn">toBn</h2>
<p>&#x25B8; <strong>toBn</strong>(): <code>BN</code></p>
<p><em>Inherited from <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#tobn">toBn</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/UInt.ts#L71" target="_blank">codec/UInt.ts:71</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/UInt.ts#L71" target="_blank">codec/UInt.ts:71</a></em></p>
<p><em><strong>description</strong></em>: Returns the BN representation of the number. (Compatibility)</p>
<p><strong>Returns:</strong> <code>BN</code></p>
<hr>
@@ -3545,7 +3545,7 @@
<p>&#x25B8; <strong>toHex</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
<p><em>Inherited from <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#tohex">toHex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/UInt.ts#L78" target="_blank">codec/UInt.ts:78</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/UInt.ts#L78" target="_blank">codec/UInt.ts:78</a></em></p>
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -3555,7 +3555,7 @@
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
<p><em>Inherited from <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#tojson">toJSON</a></em></p>
<p><em>Overrides BN.toJSON</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/UInt.ts#L85" target="_blank">codec/UInt.ts:85</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/UInt.ts#L85" target="_blank">codec/UInt.ts:85</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
<p><strong>Returns:</strong> <code>any</code></p>
<hr>
@@ -3595,7 +3595,7 @@
<p>&#x25B8; <strong>toString</strong>(base?: <em> <code>undefined</code> | <code>number</code></em>): <code>string</code></p>
<p><em>Inherited from <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#tostring">toString</a></em></p>
<p><em>Overrides BN.toString</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/UInt.ts#L95" target="_blank">codec/UInt.ts:95</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/UInt.ts#L95" target="_blank">codec/UInt.ts:95</a></em></p>
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -3644,7 +3644,7 @@
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em> <code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tou8a">toU8a</a></em></p>
<p><em>Inherited from <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#tou8a">toU8a</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/UInt.ts#L104" target="_blank">codec/UInt.ts:104</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/UInt.ts#L104" target="_blank">codec/UInt.ts:104</a></em></p>
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -3861,7 +3861,7 @@
<h2 id="static-decodeuint"><code>&lt;Static&gt;</code> decodeUInt</h2>
<p>&#x25B8; <strong>decodeUInt</strong>(value: <em><a href="../modules/_types_.md#anynumber">AnyNumber</a></em>, bitLength: <em><a href="../modules/_codec_uint_.md#uintbitlength">UIntBitLength</a></em>): <code>string</code></p>
<p><em>Inherited from <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#decodeuint">decodeUInt</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/UInt.ts#L38" target="_blank">codec/UInt.ts:38</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/UInt.ts#L38" target="_blank">codec/UInt.ts:38</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -4049,7 +4049,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.5","depth":1,"next":{"title":"hidden","level":"4.6","depth":1,"path":"types/classes/_bft_.bftauthoritysignature.md","ref":"types/classes/_bft_.bftauthoritysignature.md","articles":[]},"previous":{"title":"hidden","level":"4.4","depth":1,"path":"types/classes/_authorityid_.authorityid.md","ref":"types/classes/_authorityid_.authorityid.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"types/classes/_balance_.balance.md","mtime":"2018-12-07T11:33:59.279Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-07T11:34:45.610Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.5","depth":1,"next":{"title":"hidden","level":"4.6","depth":1,"path":"types/classes/_bft_.bftauthoritysignature.md","ref":"types/classes/_bft_.bftauthoritysignature.md","articles":[]},"previous":{"title":"hidden","level":"4.4","depth":1,"path":"types/classes/_authorityid_.authorityid.md","ref":"types/classes/_authorityid_.authorityid.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"types/classes/_balance_.balance.md","mtime":"2018-12-08T14:35:38.654Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-08T14:36:23.372Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_balance_.balance.md
+9 -9
View File
@@ -26,7 +26,7 @@
*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)*
*Defined in [U128.ts:14](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/U128.ts#L14)*
*Defined in [U128.ts:14](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/U128.ts#L14)*
**Parameters:**
@@ -48,7 +48,7 @@ getencodedLength(): `number`
*Inherited from [UInt](_codec_uint_.uint.md).[encodedLength](_codec_uint_.uint.md#encodedlength)*
*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/UInt.ts#L57)*
*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/UInt.ts#L57)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -188,7 +188,7 @@ ___
*Overrides BN.bitLength*
*Defined in [codec/UInt.ts:64](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/UInt.ts#L64)*
*Defined in [codec/UInt.ts:64](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/UInt.ts#L64)*
*__description__*: Returns the number of bits in the value
@@ -1523,7 +1523,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)*
*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/UInt.ts#L71)*
*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/UInt.ts#L71)*
*__description__*: Returns the BN representation of the number. (Compatibility)
@@ -1562,7 +1562,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)*
*Defined in [codec/UInt.ts:78](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/UInt.ts#L78)*
*Defined in [codec/UInt.ts:78](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/UInt.ts#L78)*
*__description__*: Returns a hex string representation of the value
@@ -1581,7 +1581,7 @@ ___
*Overrides BN.toJSON*
*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/UInt.ts#L85)*
*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/UInt.ts#L85)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -1634,7 +1634,7 @@ ___
*Overrides BN.toString*
*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/UInt.ts#L95)*
*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/UInt.ts#L95)*
*__description__*: Returns the string representation of the value
@@ -1678,7 +1678,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)*
*Defined in [codec/UInt.ts:104](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/UInt.ts#L104)*
*Defined in [codec/UInt.ts:104](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/UInt.ts#L104)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -1882,7 +1882,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)*
*Defined in [codec/UInt.ts:38](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/UInt.ts#L38)*
*Defined in [codec/UInt.ts:38](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/UInt.ts#L38)*
**Parameters:**
docs/types/classes/_bft_.bftauthoritysignature.html
+44 -44
View File
@@ -1122,9 +1122,9 @@
</li>
<li class="chapter " data-level="4.58" data-path="_metadata_.callmetadata.html">
<li class="chapter " data-level="4.58" data-path="_metadata_.callmetadata.md">
<a href="_metadata_.callmetadata.html">
<span>
hidden
@@ -1135,9 +1135,9 @@
</li>
<li class="chapter " data-level="4.59" data-path="_metadata_.eventmetadata.html">
<li class="chapter " data-level="4.59" data-path="_metadata_.eventmetadata.md">
<a href="_metadata_.eventmetadata.html">
<span>
hidden
@@ -1148,9 +1148,9 @@
</li>
<li class="chapter " data-level="4.60" data-path="_metadata_.functionargumentmetadata.html">
<li class="chapter " data-level="4.60" data-path="_metadata_.functionargumentmetadata.md">
<a href="_metadata_.functionargumentmetadata.html">
<span>
hidden
@@ -1161,9 +1161,9 @@
</li>
<li class="chapter " data-level="4.61" data-path="_metadata_.functionmetadata.html">
<li class="chapter " data-level="4.61" data-path="_metadata_.functionmetadata.md">
<a href="_metadata_.functionmetadata.html">
<span>
hidden
@@ -1174,9 +1174,9 @@
</li>
<li class="chapter " data-level="4.62" data-path="_metadata_.modulemetadata.html">
<li class="chapter " data-level="4.62" data-path="_metadata_.modulemetadata.md">
<a href="_metadata_.modulemetadata.html">
<span>
hidden
@@ -1187,9 +1187,9 @@
</li>
<li class="chapter " data-level="4.63" data-path="_metadata_.outerdispatchcall.html">
<li class="chapter " data-level="4.63" data-path="_metadata_.outerdispatchcall.md">
<a href="_metadata_.outerdispatchcall.html">
<span>
hidden
@@ -1200,9 +1200,9 @@
</li>
<li class="chapter " data-level="4.64" data-path="_metadata_.outerdispatchmetadata.html">
<li class="chapter " data-level="4.64" data-path="_metadata_.outerdispatchmetadata.md">
<a href="_metadata_.outerdispatchmetadata.html">
<span>
hidden
@@ -1213,9 +1213,9 @@
</li>
<li class="chapter " data-level="4.65" data-path="_metadata_.outereventmetadata.html">
<li class="chapter " data-level="4.65" data-path="_metadata_.outereventmetadata.md">
<a href="_metadata_.outereventmetadata.html">
<span>
hidden
@@ -1226,9 +1226,9 @@
</li>
<li class="chapter " data-level="4.66" data-path="_metadata_.outereventmetadataevent.html">
<li class="chapter " data-level="4.66" data-path="_metadata_.outereventmetadataevent.md">
<a href="_metadata_.outereventmetadataevent.html">
<span>
hidden
@@ -1252,9 +1252,9 @@
</li>
<li class="chapter " data-level="4.68" data-path="_metadata_.runtimemodulemetadata.html">
<li class="chapter " data-level="4.68" data-path="_metadata_.runtimemodulemetadata.md">
<a href="_metadata_.runtimemodulemetadata.html">
<span>
hidden
@@ -1265,9 +1265,9 @@
</li>
<li class="chapter " data-level="4.69" data-path="_metadata_.storagefunctionmetadata.html">
<li class="chapter " data-level="4.69" data-path="_metadata_.storagefunctionmetadata.md">
<a href="_metadata_.storagefunctionmetadata.html">
<span>
hidden
@@ -1278,9 +1278,9 @@
</li>
<li class="chapter " data-level="4.70" data-path="_metadata_.storagefunctionmodifier.html">
<li class="chapter " data-level="4.70" data-path="_metadata_.storagefunctionmodifier.md">
<a href="_metadata_.storagefunctionmodifier.html">
<span>
hidden
@@ -1291,9 +1291,9 @@
</li>
<li class="chapter " data-level="4.71" data-path="_metadata_.storagefunctiontype.html">
<li class="chapter " data-level="4.71" data-path="_metadata_.storagefunctiontype.md">
<a href="_metadata_.storagefunctiontype.html">
<span>
hidden
@@ -1304,9 +1304,9 @@
</li>
<li class="chapter " data-level="4.72" data-path="_metadata_.storagefunctiontype_map.html">
<li class="chapter " data-level="4.72" data-path="_metadata_.storagefunctiontype_map.md">
<a href="_metadata_.storagefunctiontype_map.html">
<span>
hidden
@@ -1317,9 +1317,9 @@
</li>
<li class="chapter " data-level="4.73" data-path="_metadata_.storagemetadata.html">
<li class="chapter " data-level="4.73" data-path="_metadata_.storagemetadata.md">
<a href="_metadata_.storagemetadata.html">
<span>
hidden
@@ -1978,7 +1978,7 @@
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new BftAuthoritySignature</strong>(value?: <em> <a href="../modules/_bft_.md#bftauthoritysignaturevalue">BftAuthoritySignatureValue</a> | <code>Uint8Array</code></em>): <a href="_bft_.bftauthoritysignature.html">BftAuthoritySignature</a></p>
<p><em>Overrides <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#constructor">constructor</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Bft.ts#L20" target="_blank">Bft.ts:20</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Bft.ts#L20" target="_blank">Bft.ts:20</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2009,14 +2009,14 @@
<h2 id="types">Types</h2>
<p>getTypes(): <code>Array</code>&lt;<code>string</code>&gt;</p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#types">Types</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Tuple.ts#L75" target="_blank">codec/Tuple.ts:75</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Tuple.ts#L75" target="_blank">codec/Tuple.ts:75</a></em></p>
<p><em><strong>description</strong></em>: The types definition of the tuple</p>
<p><strong>Returns:</strong> <code>Array</code>&lt;<code>string</code>&gt;</p>
<hr>
<p><a id="authorityid"></a></p>
<h2 id="authorityid">authorityId</h2>
<p>getauthorityId(): <a href="_authorityid_.authorityid.html">AuthorityId</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Bft.ts#L31" target="_blank">Bft.ts:31</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Bft.ts#L31" target="_blank">Bft.ts:31</a></em></p>
<p><em><strong>description</strong></em>: The wrapped [[AuthoriyId]]</p>
<p><strong>Returns:</strong> <a href="_authorityid_.authorityid.html">AuthorityId</a></p>
<hr>
@@ -2024,14 +2024,14 @@
<h2 id="encodedlength">encodedLength</h2>
<p>getencodedLength(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#encodedlength">encodedLength</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Tuple.ts#L66" target="_blank">codec/Tuple.ts:66</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Tuple.ts#L66" target="_blank">codec/Tuple.ts:66</a></em></p>
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
<p><a id="signature"></a></p>
<h2 id="signature">signature</h2>
<p>getsignature(): <a href="_signature_.signature.html">Signature</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Bft.ts#L38" target="_blank">Bft.ts:38</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Bft.ts#L38" target="_blank">Bft.ts:38</a></em></p>
<p><em><strong>description</strong></em>: The wrapped <a href="_signature_.signature.html">Signature</a> value</p>
<p><strong>Returns:</strong> <a href="_signature_.signature.html">Signature</a></p>
<hr>
@@ -2212,7 +2212,7 @@
<p>&#x25B8; <strong>filter</strong>(callbackfn: <em><code>function</code></em>, thisArg?: <em><code>any</code></em>): <code>Array</code>&lt;<a href="../interfaces/_types_.codec.md">Codec</a>&gt;</p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#filter">filter</a></em></p>
<p><em>Overrides Array.filter</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Tuple.ts#L131" target="_blank">codec/Tuple.ts:131</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Tuple.ts#L131" target="_blank">codec/Tuple.ts:131</a></em></p>
<p><em><strong>description</strong></em>: Filters the array with the callback</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2765,7 +2765,7 @@
<p>&#x25B8; <strong>map</strong>&lt;<code>U</code>&gt;(callbackfn: <em><code>function</code></em>, thisArg?: <em><code>any</code></em>): <code>Array</code>&lt;<code>U</code>&gt;</p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#map">map</a></em></p>
<p><em>Overrides Array.map</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Tuple.ts#L140" target="_blank">codec/Tuple.ts:140</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Tuple.ts#L140" target="_blank">codec/Tuple.ts:140</a></em></p>
<p><em><strong>description</strong></em>: Maps the array with the callback</p>
<p><strong>Type parameters:</strong></p>
<h4 id="u">U</h4>
@@ -3147,7 +3147,7 @@
<h2 id="toarray">toArray</h2>
<p>&#x25B8; <strong>toArray</strong>(): <code>Array</code>&lt;<a href="../interfaces/_types_.codec.md">Codec</a>&gt;</p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#toarray">toArray</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Tuple.ts#L82" target="_blank">codec/Tuple.ts:82</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Tuple.ts#L82" target="_blank">codec/Tuple.ts:82</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to an standard JavaScript Array</p>
<p><strong>Returns:</strong> <code>Array</code>&lt;<a href="../interfaces/_types_.codec.md">Codec</a>&gt;</p>
<hr>
@@ -3156,7 +3156,7 @@
<p>&#x25B8; <strong>toHex</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#tohex">toHex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Tuple.ts#L89" target="_blank">codec/Tuple.ts:89</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Tuple.ts#L89" target="_blank">codec/Tuple.ts:89</a></em></p>
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -3165,7 +3165,7 @@
<p>&#x25B8; <strong>toJSON</strong>(): <code>any</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#tojson">toJSON</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Tuple.ts#L96" target="_blank">codec/Tuple.ts:96</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Tuple.ts#L96" target="_blank">codec/Tuple.ts:96</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
<p><strong>Returns:</strong> <code>any</code></p>
<hr>
@@ -3183,7 +3183,7 @@
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#tostring">toString</a></em></p>
<p><em>Overrides Array.toString</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Tuple.ts#L105" target="_blank">codec/Tuple.ts:105</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Tuple.ts#L105" target="_blank">codec/Tuple.ts:105</a></em></p>
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -3192,7 +3192,7 @@
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em> <code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tou8a">toU8a</a></em></p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#tou8a">toU8a</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Tuple.ts#L114" target="_blank">codec/Tuple.ts:114</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Tuple.ts#L114" target="_blank">codec/Tuple.ts:114</a></em></p>
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -3250,7 +3250,7 @@
<h2 id="static-with"><code>&lt;Static&gt;</code> with</h2>
<p>&#x25B8; <strong>with</strong>&lt;<code>S</code>&gt;(Types: <em><code>S</code></em>): <a href="../modules/_types_.md#constructor">Constructor</a>&lt;<a href="_codec_tuple_.tuple.html">Tuple</a>&lt;<code>S</code>&gt;&gt;</p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#with">with</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Tuple.ts#L53" target="_blank">codec/Tuple.ts:53</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Tuple.ts#L53" target="_blank">codec/Tuple.ts:53</a></em></p>
<p><strong>Type parameters:</strong></p>
<h4 id="s---arrayconstructor">S : <code>Array</code>&lt;<a href="../modules/_types_.md#constructor">Constructor</a>&gt;</h4>
<p><strong>Parameters:</strong></p>
@@ -3313,7 +3313,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.6","depth":1,"next":{"title":"hidden","level":"4.7","depth":1,"path":"types/classes/_bft_.bfthashsignature.md","ref":"types/classes/_bft_.bfthashsignature.md","articles":[]},"previous":{"title":"hidden","level":"4.5","depth":1,"path":"types/classes/_balance_.balance.md","ref":"types/classes/_balance_.balance.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"types/classes/_bft_.bftauthoritysignature.md","mtime":"2018-12-07T11:33:59.543Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-07T11:34:45.610Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.6","depth":1,"next":{"title":"hidden","level":"4.7","depth":1,"path":"types/classes/_bft_.bfthashsignature.md","ref":"types/classes/_bft_.bfthashsignature.md","articles":[]},"previous":{"title":"hidden","level":"4.5","depth":1,"path":"types/classes/_balance_.balance.md","ref":"types/classes/_balance_.balance.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"types/classes/_bft_.bftauthoritysignature.md","mtime":"2018-12-08T14:35:38.922Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-08T14:36:23.372Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_bft_.bftauthoritysignature.md
+13 -13
View File
@@ -29,7 +29,7 @@
*Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)*
*Defined in [Bft.ts:20](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Bft.ts#L20)*
*Defined in [Bft.ts:20](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Bft.ts#L20)*
**Parameters:**
@@ -67,7 +67,7 @@ getTypes(): `Array`<`string`>
*Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)*
*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Tuple.ts#L75)*
*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Tuple.ts#L75)*
*__description__*: The types definition of the tuple
@@ -80,7 +80,7 @@ ___
getauthorityId(): [AuthorityId](_authorityid_.authorityid.md)
*Defined in [Bft.ts:31](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Bft.ts#L31)*
*Defined in [Bft.ts:31](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Bft.ts#L31)*
*__description__*: The wrapped \[\[AuthoriyId\]\]
@@ -95,7 +95,7 @@ getencodedLength(): `number`
*Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)*
*Defined in [codec/Tuple.ts:66](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Tuple.ts#L66)*
*Defined in [codec/Tuple.ts:66](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Tuple.ts#L66)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -108,7 +108,7 @@ ___
getsignature(): [Signature](_signature_.signature.md)
*Defined in [Bft.ts:38](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Bft.ts#L38)*
*Defined in [Bft.ts:38](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Bft.ts#L38)*
*__description__*: The wrapped [Signature](_signature_.signature.md) value
@@ -278,7 +278,7 @@ ___
*Overrides Array.filter*
*Defined in [codec/Tuple.ts:131](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Tuple.ts#L131)*
*Defined in [codec/Tuple.ts:131](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Tuple.ts#L131)*
*__description__*: Filters the array with the callback
@@ -698,7 +698,7 @@ ___
*Overrides Array.map*
*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Tuple.ts#L140)*
*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Tuple.ts#L140)*
*__description__*: Maps the array with the callback
@@ -1006,7 +1006,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)*
*Defined in [codec/Tuple.ts:82](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Tuple.ts#L82)*
*Defined in [codec/Tuple.ts:82](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Tuple.ts#L82)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -1023,7 +1023,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)*
*Defined in [codec/Tuple.ts:89](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Tuple.ts#L89)*
*Defined in [codec/Tuple.ts:89](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Tuple.ts#L89)*
*__description__*: Returns a hex string representation of the value
@@ -1040,7 +1040,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)*
*Defined in [codec/Tuple.ts:96](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Tuple.ts#L96)*
*Defined in [codec/Tuple.ts:96](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Tuple.ts#L96)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -1074,7 +1074,7 @@ ___
*Overrides Array.toString*
*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Tuple.ts#L105)*
*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Tuple.ts#L105)*
*__description__*: Returns the string representation of the value
@@ -1091,7 +1091,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)*
*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Tuple.ts#L114)*
*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Tuple.ts#L114)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -1148,7 +1148,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)*
*Defined in [codec/Tuple.ts:53](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Tuple.ts#L53)*
*Defined in [codec/Tuple.ts:53](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Tuple.ts#L53)*
**Type parameters:**
docs/types/classes/_bft_.bfthashsignature.html
+44 -44
View File
@@ -1122,9 +1122,9 @@
</li>
<li class="chapter " data-level="4.58" data-path="_metadata_.callmetadata.html">
<li class="chapter " data-level="4.58" data-path="_metadata_.callmetadata.md">
<a href="_metadata_.callmetadata.html">
<span>
hidden
@@ -1135,9 +1135,9 @@
</li>
<li class="chapter " data-level="4.59" data-path="_metadata_.eventmetadata.html">
<li class="chapter " data-level="4.59" data-path="_metadata_.eventmetadata.md">
<a href="_metadata_.eventmetadata.html">
<span>
hidden
@@ -1148,9 +1148,9 @@
</li>
<li class="chapter " data-level="4.60" data-path="_metadata_.functionargumentmetadata.html">
<li class="chapter " data-level="4.60" data-path="_metadata_.functionargumentmetadata.md">
<a href="_metadata_.functionargumentmetadata.html">
<span>
hidden
@@ -1161,9 +1161,9 @@
</li>
<li class="chapter " data-level="4.61" data-path="_metadata_.functionmetadata.html">
<li class="chapter " data-level="4.61" data-path="_metadata_.functionmetadata.md">
<a href="_metadata_.functionmetadata.html">
<span>
hidden
@@ -1174,9 +1174,9 @@
</li>
<li class="chapter " data-level="4.62" data-path="_metadata_.modulemetadata.html">
<li class="chapter " data-level="4.62" data-path="_metadata_.modulemetadata.md">
<a href="_metadata_.modulemetadata.html">
<span>
hidden
@@ -1187,9 +1187,9 @@
</li>
<li class="chapter " data-level="4.63" data-path="_metadata_.outerdispatchcall.html">
<li class="chapter " data-level="4.63" data-path="_metadata_.outerdispatchcall.md">
<a href="_metadata_.outerdispatchcall.html">
<span>
hidden
@@ -1200,9 +1200,9 @@
</li>
<li class="chapter " data-level="4.64" data-path="_metadata_.outerdispatchmetadata.html">
<li class="chapter " data-level="4.64" data-path="_metadata_.outerdispatchmetadata.md">
<a href="_metadata_.outerdispatchmetadata.html">
<span>
hidden
@@ -1213,9 +1213,9 @@
</li>
<li class="chapter " data-level="4.65" data-path="_metadata_.outereventmetadata.html">
<li class="chapter " data-level="4.65" data-path="_metadata_.outereventmetadata.md">
<a href="_metadata_.outereventmetadata.html">
<span>
hidden
@@ -1226,9 +1226,9 @@
</li>
<li class="chapter " data-level="4.66" data-path="_metadata_.outereventmetadataevent.html">
<li class="chapter " data-level="4.66" data-path="_metadata_.outereventmetadataevent.md">
<a href="_metadata_.outereventmetadataevent.html">
<span>
hidden
@@ -1252,9 +1252,9 @@
</li>
<li class="chapter " data-level="4.68" data-path="_metadata_.runtimemodulemetadata.html">
<li class="chapter " data-level="4.68" data-path="_metadata_.runtimemodulemetadata.md">
<a href="_metadata_.runtimemodulemetadata.html">
<span>
hidden
@@ -1265,9 +1265,9 @@
</li>
<li class="chapter " data-level="4.69" data-path="_metadata_.storagefunctionmetadata.html">
<li class="chapter " data-level="4.69" data-path="_metadata_.storagefunctionmetadata.md">
<a href="_metadata_.storagefunctionmetadata.html">
<span>
hidden
@@ -1278,9 +1278,9 @@
</li>
<li class="chapter " data-level="4.70" data-path="_metadata_.storagefunctionmodifier.html">
<li class="chapter " data-level="4.70" data-path="_metadata_.storagefunctionmodifier.md">
<a href="_metadata_.storagefunctionmodifier.html">
<span>
hidden
@@ -1291,9 +1291,9 @@
</li>
<li class="chapter " data-level="4.71" data-path="_metadata_.storagefunctiontype.html">
<li class="chapter " data-level="4.71" data-path="_metadata_.storagefunctiontype.md">
<a href="_metadata_.storagefunctiontype.html">
<span>
hidden
@@ -1304,9 +1304,9 @@
</li>
<li class="chapter " data-level="4.72" data-path="_metadata_.storagefunctiontype_map.html">
<li class="chapter " data-level="4.72" data-path="_metadata_.storagefunctiontype_map.md">
<a href="_metadata_.storagefunctiontype_map.html">
<span>
hidden
@@ -1317,9 +1317,9 @@
</li>
<li class="chapter " data-level="4.73" data-path="_metadata_.storagemetadata.html">
<li class="chapter " data-level="4.73" data-path="_metadata_.storagemetadata.md">
<a href="_metadata_.storagemetadata.html">
<span>
hidden
@@ -1978,7 +1978,7 @@
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new BftHashSignature</strong>(value?: <em> <a href="../modules/_bft_.md#bfthashsignaturevalue">BftHashSignatureValue</a> | <code>Uint8Array</code></em>): <a href="_bft_.bfthashsignature.html">BftHashSignature</a></p>
<p><em>Overrides <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#constructor">constructor</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Bft.ts#L51" target="_blank">Bft.ts:51</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Bft.ts#L51" target="_blank">Bft.ts:51</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2009,7 +2009,7 @@
<h2 id="types">Types</h2>
<p>getTypes(): <code>Array</code>&lt;<code>string</code>&gt;</p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#types">Types</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Tuple.ts#L75" target="_blank">codec/Tuple.ts:75</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Tuple.ts#L75" target="_blank">codec/Tuple.ts:75</a></em></p>
<p><em><strong>description</strong></em>: The types definition of the tuple</p>
<p><strong>Returns:</strong> <code>Array</code>&lt;<code>string</code>&gt;</p>
<hr>
@@ -2017,21 +2017,21 @@
<h2 id="encodedlength">encodedLength</h2>
<p>getencodedLength(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#encodedlength">encodedLength</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Tuple.ts#L66" target="_blank">codec/Tuple.ts:66</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Tuple.ts#L66" target="_blank">codec/Tuple.ts:66</a></em></p>
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
<p><a id="hash"></a></p>
<h2 id="hash">hash</h2>
<p>gethash(): <a href="_hash_.hash.html">Hash</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Bft.ts#L62" target="_blank">Bft.ts:62</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Bft.ts#L62" target="_blank">Bft.ts:62</a></em></p>
<p><em><strong>description</strong></em>: The wrapped <a href="_hash_.hash.html">Hash</a></p>
<p><strong>Returns:</strong> <a href="_hash_.hash.html">Hash</a></p>
<hr>
<p><a id="signature"></a></p>
<h2 id="signature">signature</h2>
<p>getsignature(): <a href="_signature_.signature.html">Signature</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Bft.ts#L69" target="_blank">Bft.ts:69</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Bft.ts#L69" target="_blank">Bft.ts:69</a></em></p>
<p><em><strong>description</strong></em>: The wrapped <a href="_signature_.signature.html">Signature</a></p>
<p><strong>Returns:</strong> <a href="_signature_.signature.html">Signature</a></p>
<hr>
@@ -2212,7 +2212,7 @@
<p>&#x25B8; <strong>filter</strong>(callbackfn: <em><code>function</code></em>, thisArg?: <em><code>any</code></em>): <code>Array</code>&lt;<a href="../interfaces/_types_.codec.md">Codec</a>&gt;</p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#filter">filter</a></em></p>
<p><em>Overrides Array.filter</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Tuple.ts#L131" target="_blank">codec/Tuple.ts:131</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Tuple.ts#L131" target="_blank">codec/Tuple.ts:131</a></em></p>
<p><em><strong>description</strong></em>: Filters the array with the callback</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2765,7 +2765,7 @@
<p>&#x25B8; <strong>map</strong>&lt;<code>U</code>&gt;(callbackfn: <em><code>function</code></em>, thisArg?: <em><code>any</code></em>): <code>Array</code>&lt;<code>U</code>&gt;</p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#map">map</a></em></p>
<p><em>Overrides Array.map</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Tuple.ts#L140" target="_blank">codec/Tuple.ts:140</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Tuple.ts#L140" target="_blank">codec/Tuple.ts:140</a></em></p>
<p><em><strong>description</strong></em>: Maps the array with the callback</p>
<p><strong>Type parameters:</strong></p>
<h4 id="u">U</h4>
@@ -3147,7 +3147,7 @@
<h2 id="toarray">toArray</h2>
<p>&#x25B8; <strong>toArray</strong>(): <code>Array</code>&lt;<a href="../interfaces/_types_.codec.md">Codec</a>&gt;</p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#toarray">toArray</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Tuple.ts#L82" target="_blank">codec/Tuple.ts:82</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Tuple.ts#L82" target="_blank">codec/Tuple.ts:82</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to an standard JavaScript Array</p>
<p><strong>Returns:</strong> <code>Array</code>&lt;<a href="../interfaces/_types_.codec.md">Codec</a>&gt;</p>
<hr>
@@ -3156,7 +3156,7 @@
<p>&#x25B8; <strong>toHex</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#tohex">toHex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Tuple.ts#L89" target="_blank">codec/Tuple.ts:89</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Tuple.ts#L89" target="_blank">codec/Tuple.ts:89</a></em></p>
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -3165,7 +3165,7 @@
<p>&#x25B8; <strong>toJSON</strong>(): <code>any</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#tojson">toJSON</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Tuple.ts#L96" target="_blank">codec/Tuple.ts:96</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Tuple.ts#L96" target="_blank">codec/Tuple.ts:96</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
<p><strong>Returns:</strong> <code>any</code></p>
<hr>
@@ -3183,7 +3183,7 @@
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#tostring">toString</a></em></p>
<p><em>Overrides Array.toString</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Tuple.ts#L105" target="_blank">codec/Tuple.ts:105</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Tuple.ts#L105" target="_blank">codec/Tuple.ts:105</a></em></p>
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -3192,7 +3192,7 @@
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em> <code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tou8a">toU8a</a></em></p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#tou8a">toU8a</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Tuple.ts#L114" target="_blank">codec/Tuple.ts:114</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Tuple.ts#L114" target="_blank">codec/Tuple.ts:114</a></em></p>
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -3250,7 +3250,7 @@
<h2 id="static-with"><code>&lt;Static&gt;</code> with</h2>
<p>&#x25B8; <strong>with</strong>&lt;<code>S</code>&gt;(Types: <em><code>S</code></em>): <a href="../modules/_types_.md#constructor">Constructor</a>&lt;<a href="_codec_tuple_.tuple.html">Tuple</a>&lt;<code>S</code>&gt;&gt;</p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#with">with</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Tuple.ts#L53" target="_blank">codec/Tuple.ts:53</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Tuple.ts#L53" target="_blank">codec/Tuple.ts:53</a></em></p>
<p><strong>Type parameters:</strong></p>
<h4 id="s---arrayconstructor">S : <code>Array</code>&lt;<a href="../modules/_types_.md#constructor">Constructor</a>&gt;</h4>
<p><strong>Parameters:</strong></p>
@@ -3313,7 +3313,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.7","depth":1,"next":{"title":"hidden","level":"4.8","depth":1,"path":"types/classes/_block_.block.md","ref":"types/classes/_block_.block.md","articles":[]},"previous":{"title":"hidden","level":"4.6","depth":1,"path":"types/classes/_bft_.bftauthoritysignature.md","ref":"types/classes/_bft_.bftauthoritysignature.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"types/classes/_bft_.bfthashsignature.md","mtime":"2018-12-07T11:33:59.799Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-07T11:34:45.610Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.7","depth":1,"next":{"title":"hidden","level":"4.8","depth":1,"path":"types/classes/_block_.block.md","ref":"types/classes/_block_.block.md","articles":[]},"previous":{"title":"hidden","level":"4.6","depth":1,"path":"types/classes/_bft_.bftauthoritysignature.md","ref":"types/classes/_bft_.bftauthoritysignature.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"types/classes/_bft_.bfthashsignature.md","mtime":"2018-12-08T14:35:39.182Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-08T14:36:23.372Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_bft_.bfthashsignature.md
+13 -13
View File
@@ -29,7 +29,7 @@
*Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)*
*Defined in [Bft.ts:51](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Bft.ts#L51)*
*Defined in [Bft.ts:51](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Bft.ts#L51)*
**Parameters:**
@@ -67,7 +67,7 @@ getTypes(): `Array`<`string`>
*Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)*
*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Tuple.ts#L75)*
*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Tuple.ts#L75)*
*__description__*: The types definition of the tuple
@@ -82,7 +82,7 @@ getencodedLength(): `number`
*Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)*
*Defined in [codec/Tuple.ts:66](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Tuple.ts#L66)*
*Defined in [codec/Tuple.ts:66](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Tuple.ts#L66)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -95,7 +95,7 @@ ___
gethash(): [Hash](_hash_.hash.md)
*Defined in [Bft.ts:62](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Bft.ts#L62)*
*Defined in [Bft.ts:62](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Bft.ts#L62)*
*__description__*: The wrapped [Hash](_hash_.hash.md)
@@ -108,7 +108,7 @@ ___
getsignature(): [Signature](_signature_.signature.md)
*Defined in [Bft.ts:69](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Bft.ts#L69)*
*Defined in [Bft.ts:69](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Bft.ts#L69)*
*__description__*: The wrapped [Signature](_signature_.signature.md)
@@ -278,7 +278,7 @@ ___
*Overrides Array.filter*
*Defined in [codec/Tuple.ts:131](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Tuple.ts#L131)*
*Defined in [codec/Tuple.ts:131](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Tuple.ts#L131)*
*__description__*: Filters the array with the callback
@@ -698,7 +698,7 @@ ___
*Overrides Array.map*
*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Tuple.ts#L140)*
*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Tuple.ts#L140)*
*__description__*: Maps the array with the callback
@@ -1006,7 +1006,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)*
*Defined in [codec/Tuple.ts:82](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Tuple.ts#L82)*
*Defined in [codec/Tuple.ts:82](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Tuple.ts#L82)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -1023,7 +1023,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)*
*Defined in [codec/Tuple.ts:89](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Tuple.ts#L89)*
*Defined in [codec/Tuple.ts:89](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Tuple.ts#L89)*
*__description__*: Returns a hex string representation of the value
@@ -1040,7 +1040,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)*
*Defined in [codec/Tuple.ts:96](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Tuple.ts#L96)*
*Defined in [codec/Tuple.ts:96](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Tuple.ts#L96)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -1074,7 +1074,7 @@ ___
*Overrides Array.toString*
*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Tuple.ts#L105)*
*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Tuple.ts#L105)*
*__description__*: Returns the string representation of the value
@@ -1091,7 +1091,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)*
*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Tuple.ts#L114)*
*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Tuple.ts#L114)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -1148,7 +1148,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)*
*Defined in [codec/Tuple.ts:53](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Tuple.ts#L53)*
*Defined in [codec/Tuple.ts:53](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Tuple.ts#L53)*
**Type parameters:**
docs/types/classes/_block_.block.html
+45 -45
View File
@@ -1122,9 +1122,9 @@
</li>
<li class="chapter " data-level="4.58" data-path="_metadata_.callmetadata.html">
<li class="chapter " data-level="4.58" data-path="_metadata_.callmetadata.md">
<a href="_metadata_.callmetadata.html">
<span>
hidden
@@ -1135,9 +1135,9 @@
</li>
<li class="chapter " data-level="4.59" data-path="_metadata_.eventmetadata.html">
<li class="chapter " data-level="4.59" data-path="_metadata_.eventmetadata.md">
<a href="_metadata_.eventmetadata.html">
<span>
hidden
@@ -1148,9 +1148,9 @@
</li>
<li class="chapter " data-level="4.60" data-path="_metadata_.functionargumentmetadata.html">
<li class="chapter " data-level="4.60" data-path="_metadata_.functionargumentmetadata.md">
<a href="_metadata_.functionargumentmetadata.html">
<span>
hidden
@@ -1161,9 +1161,9 @@
</li>
<li class="chapter " data-level="4.61" data-path="_metadata_.functionmetadata.html">
<li class="chapter " data-level="4.61" data-path="_metadata_.functionmetadata.md">
<a href="_metadata_.functionmetadata.html">
<span>
hidden
@@ -1174,9 +1174,9 @@
</li>
<li class="chapter " data-level="4.62" data-path="_metadata_.modulemetadata.html">
<li class="chapter " data-level="4.62" data-path="_metadata_.modulemetadata.md">
<a href="_metadata_.modulemetadata.html">
<span>
hidden
@@ -1187,9 +1187,9 @@
</li>
<li class="chapter " data-level="4.63" data-path="_metadata_.outerdispatchcall.html">
<li class="chapter " data-level="4.63" data-path="_metadata_.outerdispatchcall.md">
<a href="_metadata_.outerdispatchcall.html">
<span>
hidden
@@ -1200,9 +1200,9 @@
</li>
<li class="chapter " data-level="4.64" data-path="_metadata_.outerdispatchmetadata.html">
<li class="chapter " data-level="4.64" data-path="_metadata_.outerdispatchmetadata.md">
<a href="_metadata_.outerdispatchmetadata.html">
<span>
hidden
@@ -1213,9 +1213,9 @@
</li>
<li class="chapter " data-level="4.65" data-path="_metadata_.outereventmetadata.html">
<li class="chapter " data-level="4.65" data-path="_metadata_.outereventmetadata.md">
<a href="_metadata_.outereventmetadata.html">
<span>
hidden
@@ -1226,9 +1226,9 @@
</li>
<li class="chapter " data-level="4.66" data-path="_metadata_.outereventmetadataevent.html">
<li class="chapter " data-level="4.66" data-path="_metadata_.outereventmetadataevent.md">
<a href="_metadata_.outereventmetadataevent.html">
<span>
hidden
@@ -1252,9 +1252,9 @@
</li>
<li class="chapter " data-level="4.68" data-path="_metadata_.runtimemodulemetadata.html">
<li class="chapter " data-level="4.68" data-path="_metadata_.runtimemodulemetadata.md">
<a href="_metadata_.runtimemodulemetadata.html">
<span>
hidden
@@ -1265,9 +1265,9 @@
</li>
<li class="chapter " data-level="4.69" data-path="_metadata_.storagefunctionmetadata.html">
<li class="chapter " data-level="4.69" data-path="_metadata_.storagefunctionmetadata.md">
<a href="_metadata_.storagefunctionmetadata.html">
<span>
hidden
@@ -1278,9 +1278,9 @@
</li>
<li class="chapter " data-level="4.70" data-path="_metadata_.storagefunctionmodifier.html">
<li class="chapter " data-level="4.70" data-path="_metadata_.storagefunctionmodifier.md">
<a href="_metadata_.storagefunctionmodifier.html">
<span>
hidden
@@ -1291,9 +1291,9 @@
</li>
<li class="chapter " data-level="4.71" data-path="_metadata_.storagefunctiontype.html">
<li class="chapter " data-level="4.71" data-path="_metadata_.storagefunctiontype.md">
<a href="_metadata_.storagefunctiontype.html">
<span>
hidden
@@ -1304,9 +1304,9 @@
</li>
<li class="chapter " data-level="4.72" data-path="_metadata_.storagefunctiontype_map.html">
<li class="chapter " data-level="4.72" data-path="_metadata_.storagefunctiontype_map.md">
<a href="_metadata_.storagefunctiontype_map.html">
<span>
hidden
@@ -1317,9 +1317,9 @@
</li>
<li class="chapter " data-level="4.73" data-path="_metadata_.storagemetadata.html">
<li class="chapter " data-level="4.73" data-path="_metadata_.storagemetadata.md">
<a href="_metadata_.storagemetadata.html">
<span>
hidden
@@ -1979,7 +1979,7 @@
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new Block</strong>(value?: <em> <a href="../modules/_block_.md#blockvalue">BlockValue</a> | <code>Uint8Array</code></em>): <a href="_block_.block.html">Block</a></p>
<p><em>Overrides <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#constructor">constructor</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Block.ts#L24" target="_blank">Block.ts:24</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Block.ts#L24" target="_blank">Block.ts:24</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2015,7 +2015,7 @@
<h2 id="type">Type</h2>
<p>getType(): <code>E</code></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#type">Type</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L133" target="_blank">codec/Struct.ts:133</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L127" target="_blank">codec/Struct.ts:127</a></em></p>
<p><em><strong>description</strong></em>: Returns the Type description to sthe structure</p>
<p><strong>Returns:</strong> <code>E</code></p>
<hr>
@@ -2023,28 +2023,28 @@
<h2 id="encodedlength">encodedLength</h2>
<p>getencodedLength(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#encodedlength">encodedLength</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L140" target="_blank">codec/Struct.ts:140</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L134" target="_blank">codec/Struct.ts:134</a></em></p>
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
<p><a id="extrinsics"></a></p>
<h2 id="extrinsics">extrinsics</h2>
<p>getextrinsics(): <a href="_extrinsics_.extrinsics.html">Extrinsics</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Block.ts#L35" target="_blank">Block.ts:35</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Block.ts#L35" target="_blank">Block.ts:35</a></em></p>
<p><em><strong>description</strong></em>: The <a href="../interfaces/_method_.extrinsics.md">Extrinsics</a> conatined in the block</p>
<p><strong>Returns:</strong> <a href="_extrinsics_.extrinsics.html">Extrinsics</a></p>
<hr>
<p><a id="hash"></a></p>
<h2 id="hash">hash</h2>
<p>gethash(): <a href="_hash_.hash.html">Hash</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Block.ts#L42" target="_blank">Block.ts:42</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Block.ts#L42" target="_blank">Block.ts:42</a></em></p>
<p><em><strong>description</strong></em>: Coinvenience getter, encoded the <a href="_hash_.hash.html">Hash</a> for the block</p>
<p><strong>Returns:</strong> <a href="_hash_.hash.html">Hash</a></p>
<hr>
<p><a id="header"></a></p>
<h2 id="header">header</h2>
<p>getheader(): <a href="_header_.header.html">Header</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Block.ts#L51" target="_blank">Block.ts:51</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Block.ts#L51" target="_blank">Block.ts:51</a></em></p>
<p><em><strong>description</strong></em>: The <a href="_header_.header.html">Header</a> in the block</p>
<p><strong>Returns:</strong> <a href="_header_.header.html">Header</a></p>
<hr>
@@ -2125,7 +2125,7 @@
<p>&#x25B8; <strong>get</strong>(name: <em><code>keyof S</code></em>): <a href="../interfaces/_types_.codec.md">Codec</a> | <code>undefined</code></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#get">get</a></em></p>
<p><em>Overrides Map.get</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L150" target="_blank">codec/Struct.ts:150</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L144" target="_blank">codec/Struct.ts:144</a></em></p>
<p><em><strong>description</strong></em>: Returns a specific names entry in the structure</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2150,7 +2150,7 @@
<h2 id="getatindex">getAtIndex</h2>
<p>&#x25B8; <strong>getAtIndex</strong>(index: <em><code>number</code></em>): <a href="../interfaces/_types_.codec.md">Codec</a></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#getatindex">getAtIndex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L157" target="_blank">codec/Struct.ts:157</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L151" target="_blank">codec/Struct.ts:151</a></em></p>
<p><em><strong>description</strong></em>: Returns the values of a member at a specific index (Rather use get(name) for performance)</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2229,7 +2229,7 @@
<h2 id="toarray">toArray</h2>
<p>&#x25B8; <strong>toArray</strong>(): <code>Array</code>&lt;<a href="../interfaces/_types_.codec.md">Codec</a>&gt;</p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#toarray">toArray</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L164" target="_blank">codec/Struct.ts:164</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L158" target="_blank">codec/Struct.ts:158</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to an standard JavaScript Array</p>
<p><strong>Returns:</strong> <code>Array</code>&lt;<a href="../interfaces/_types_.codec.md">Codec</a>&gt;</p>
<hr>
@@ -2238,7 +2238,7 @@
<p>&#x25B8; <strong>toHex</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#tohex">toHex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L171" target="_blank">codec/Struct.ts:171</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L165" target="_blank">codec/Struct.ts:165</a></em></p>
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2247,7 +2247,7 @@
<p>&#x25B8; <strong>toJSON</strong>(): <code>any</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#tojson">toJSON</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L178" target="_blank">codec/Struct.ts:178</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L172" target="_blank">codec/Struct.ts:172</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
<p><strong>Returns:</strong> <code>any</code></p>
<hr>
@@ -2256,7 +2256,7 @@
<p>&#x25B8; <strong>toString</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#tostring">toString</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L192" target="_blank">codec/Struct.ts:192</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L186" target="_blank">codec/Struct.ts:186</a></em></p>
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2265,7 +2265,7 @@
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em> <code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tou8a">toU8a</a></em></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#tou8a">toU8a</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L200" target="_blank">codec/Struct.ts:200</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L194" target="_blank">codec/Struct.ts:194</a></em></p>
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2298,7 +2298,7 @@
<h2 id="static-with"><code>&lt;Static&gt;</code> with</h2>
<p>&#x25B8; <strong>with</strong>&lt;<code>S</code>&gt;(Types: <em><code>S</code></em>): <a href="../modules/_types_.md#constructor">Constructor</a>&lt;<a href="_codec_struct_.struct.html">Struct</a>&lt;<code>S</code>&gt;&gt;</p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#with">with</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L113" target="_blank">codec/Struct.ts:113</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L107" target="_blank">codec/Struct.ts:107</a></em></p>
<p><strong>Type parameters:</strong></p>
<h4 id="s---constructordef">S : <a href="../modules/_types_.md#constructordef">ConstructorDef</a></h4>
<p><strong>Parameters:</strong></p>
@@ -2361,7 +2361,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.8","depth":1,"next":{"title":"hidden","level":"4.9","depth":1,"path":"types/classes/_blocknumber_.blocknumber.md","ref":"types/classes/_blocknumber_.blocknumber.md","articles":[]},"previous":{"title":"hidden","level":"4.7","depth":1,"path":"types/classes/_bft_.bfthashsignature.md","ref":"types/classes/_bft_.bfthashsignature.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"types/classes/_block_.block.md","mtime":"2018-12-07T11:33:59.859Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-07T11:34:45.610Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.8","depth":1,"next":{"title":"hidden","level":"4.9","depth":1,"path":"types/classes/_blocknumber_.blocknumber.md","ref":"types/classes/_blocknumber_.blocknumber.md","articles":[]},"previous":{"title":"hidden","level":"4.7","depth":1,"path":"types/classes/_bft_.bfthashsignature.md","ref":"types/classes/_bft_.bfthashsignature.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"types/classes/_block_.block.md","mtime":"2018-12-08T14:35:39.246Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-08T14:36:23.372Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_block_.block.md
+14 -14
View File
@@ -29,7 +29,7 @@
*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)*
*Defined in [Block.ts:24](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Block.ts#L24)*
*Defined in [Block.ts:24](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Block.ts#L24)*
**Parameters:**
@@ -76,7 +76,7 @@ getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L133)*
*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L127)*
*__description__*: Returns the Type description to sthe structure
@@ -91,7 +91,7 @@ getencodedLength(): `number`
*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)*
*Defined in [codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L140)*
*Defined in [codec/Struct.ts:134](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L134)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -104,7 +104,7 @@ ___
getextrinsics(): [Extrinsics](_extrinsics_.extrinsics.md)
*Defined in [Block.ts:35](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Block.ts#L35)*
*Defined in [Block.ts:35](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Block.ts#L35)*
*__description__*: The [Extrinsics](../interfaces/_method_.extrinsics.md) conatined in the block
@@ -117,7 +117,7 @@ ___
gethash(): [Hash](_hash_.hash.md)
*Defined in [Block.ts:42](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Block.ts#L42)*
*Defined in [Block.ts:42](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Block.ts#L42)*
*__description__*: Coinvenience getter, encoded the [Hash](_hash_.hash.md) for the block
@@ -130,7 +130,7 @@ ___
getheader(): [Header](_header_.header.md)
*Defined in [Block.ts:51](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Block.ts#L51)*
*Defined in [Block.ts:51](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Block.ts#L51)*
*__description__*: The [Header](_header_.header.md) in the block
@@ -232,7 +232,7 @@ ___
*Overrides Map.get*
*Defined in [codec/Struct.ts:150](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L150)*
*Defined in [codec/Struct.ts:144](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L144)*
*__description__*: Returns a specific names entry in the structure
@@ -253,7 +253,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)*
*Defined in [codec/Struct.ts:157](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L157)*
*Defined in [codec/Struct.ts:151](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L151)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
@@ -328,7 +328,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)*
*Defined in [codec/Struct.ts:164](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L164)*
*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L158)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -345,7 +345,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)*
*Defined in [codec/Struct.ts:171](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L171)*
*Defined in [codec/Struct.ts:165](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L165)*
*__description__*: Returns a hex string representation of the value
@@ -362,7 +362,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
*Defined in [codec/Struct.ts:178](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L178)*
*Defined in [codec/Struct.ts:172](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L172)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -379,7 +379,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)*
*Defined in [codec/Struct.ts:192](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L192)*
*Defined in [codec/Struct.ts:186](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L186)*
*__description__*: Returns the string representation of the value
@@ -396,7 +396,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
*Defined in [codec/Struct.ts:200](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L200)*
*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L194)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -432,7 +432,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/Struct.ts#L113)*
*Defined in [codec/Struct.ts:107](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/Struct.ts#L107)*
**Type parameters:**
docs/types/classes/_blocknumber_.blocknumber.html
+40 -40
View File
@@ -1122,9 +1122,9 @@
</li>
<li class="chapter " data-level="4.58" data-path="_metadata_.callmetadata.html">
<li class="chapter " data-level="4.58" data-path="_metadata_.callmetadata.md">
<a href="_metadata_.callmetadata.html">
<span>
hidden
@@ -1135,9 +1135,9 @@
</li>
<li class="chapter " data-level="4.59" data-path="_metadata_.eventmetadata.html">
<li class="chapter " data-level="4.59" data-path="_metadata_.eventmetadata.md">
<a href="_metadata_.eventmetadata.html">
<span>
hidden
@@ -1148,9 +1148,9 @@
</li>
<li class="chapter " data-level="4.60" data-path="_metadata_.functionargumentmetadata.html">
<li class="chapter " data-level="4.60" data-path="_metadata_.functionargumentmetadata.md">
<a href="_metadata_.functionargumentmetadata.html">
<span>
hidden
@@ -1161,9 +1161,9 @@
</li>
<li class="chapter " data-level="4.61" data-path="_metadata_.functionmetadata.html">
<li class="chapter " data-level="4.61" data-path="_metadata_.functionmetadata.md">
<a href="_metadata_.functionmetadata.html">
<span>
hidden
@@ -1174,9 +1174,9 @@
</li>
<li class="chapter " data-level="4.62" data-path="_metadata_.modulemetadata.html">
<li class="chapter " data-level="4.62" data-path="_metadata_.modulemetadata.md">
<a href="_metadata_.modulemetadata.html">
<span>
hidden
@@ -1187,9 +1187,9 @@
</li>
<li class="chapter " data-level="4.63" data-path="_metadata_.outerdispatchcall.html">
<li class="chapter " data-level="4.63" data-path="_metadata_.outerdispatchcall.md">
<a href="_metadata_.outerdispatchcall.html">
<span>
hidden
@@ -1200,9 +1200,9 @@
</li>
<li class="chapter " data-level="4.64" data-path="_metadata_.outerdispatchmetadata.html">
<li class="chapter " data-level="4.64" data-path="_metadata_.outerdispatchmetadata.md">
<a href="_metadata_.outerdispatchmetadata.html">
<span>
hidden
@@ -1213,9 +1213,9 @@
</li>
<li class="chapter " data-level="4.65" data-path="_metadata_.outereventmetadata.html">
<li class="chapter " data-level="4.65" data-path="_metadata_.outereventmetadata.md">
<a href="_metadata_.outereventmetadata.html">
<span>
hidden
@@ -1226,9 +1226,9 @@
</li>
<li class="chapter " data-level="4.66" data-path="_metadata_.outereventmetadataevent.html">
<li class="chapter " data-level="4.66" data-path="_metadata_.outereventmetadataevent.md">
<a href="_metadata_.outereventmetadataevent.html">
<span>
hidden
@@ -1252,9 +1252,9 @@
</li>
<li class="chapter " data-level="4.68" data-path="_metadata_.runtimemodulemetadata.html">
<li class="chapter " data-level="4.68" data-path="_metadata_.runtimemodulemetadata.md">
<a href="_metadata_.runtimemodulemetadata.html">
<span>
hidden
@@ -1265,9 +1265,9 @@
</li>
<li class="chapter " data-level="4.69" data-path="_metadata_.storagefunctionmetadata.html">
<li class="chapter " data-level="4.69" data-path="_metadata_.storagefunctionmetadata.md">
<a href="_metadata_.storagefunctionmetadata.html">
<span>
hidden
@@ -1278,9 +1278,9 @@
</li>
<li class="chapter " data-level="4.70" data-path="_metadata_.storagefunctionmodifier.html">
<li class="chapter " data-level="4.70" data-path="_metadata_.storagefunctionmodifier.md">
<a href="_metadata_.storagefunctionmodifier.html">
<span>
hidden
@@ -1291,9 +1291,9 @@
</li>
<li class="chapter " data-level="4.71" data-path="_metadata_.storagefunctiontype.html">
<li class="chapter " data-level="4.71" data-path="_metadata_.storagefunctiontype.md">
<a href="_metadata_.storagefunctiontype.html">
<span>
hidden
@@ -1304,9 +1304,9 @@
</li>
<li class="chapter " data-level="4.72" data-path="_metadata_.storagefunctiontype_map.html">
<li class="chapter " data-level="4.72" data-path="_metadata_.storagefunctiontype_map.md">
<a href="_metadata_.storagefunctiontype_map.html">
<span>
hidden
@@ -1317,9 +1317,9 @@
</li>
<li class="chapter " data-level="4.73" data-path="_metadata_.storagemetadata.html">
<li class="chapter " data-level="4.73" data-path="_metadata_.storagemetadata.md">
<a href="_metadata_.storagemetadata.html">
<span>
hidden
@@ -1975,7 +1975,7 @@
<p>&#x2295; <strong>new BlockNumber</strong>(value?: <em><a href="../modules/_types_.md#anynumber">AnyNumber</a></em>): <a href="_blocknumber_.blocknumber.html">BlockNumber</a></p>
<p><em>Inherited from <a href="_u64_.u64.html">U64</a>.<a href="_u64_.u64.html#constructor">constructor</a></em></p>
<p><em>Overrides <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#constructor">constructor</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/U64.ts#L14" target="_blank">U64.ts:14</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/U64.ts#L14" target="_blank">U64.ts:14</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -1998,7 +1998,7 @@
<h2 id="encodedlength">encodedLength</h2>
<p>getencodedLength(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#encodedlength">encodedLength</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/UInt.ts#L57" target="_blank">codec/UInt.ts:57</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/UInt.ts#L57" target="_blank">codec/UInt.ts:57</a></em></p>
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2131,7 +2131,7 @@
<p>&#x25B8; <strong>bitLength</strong>(): <a href="../modules/_codec_uint_.md#uintbitlength">UIntBitLength</a></p>
<p><em>Inherited from <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#bitlength">bitLength</a></em></p>
<p><em>Overrides BN.bitLength</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/UInt.ts#L64" target="_blank">codec/UInt.ts:64</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/UInt.ts#L64" target="_blank">codec/UInt.ts:64</a></em></p>
<p><em><strong>description</strong></em>: Returns the number of bits in the value</p>
<p><strong>Returns:</strong> <a href="../modules/_codec_uint_.md#uintbitlength">UIntBitLength</a></p>
<hr>
@@ -3509,7 +3509,7 @@
<h2 id="tobn">toBn</h2>
<p>&#x25B8; <strong>toBn</strong>(): <code>BN</code></p>
<p><em>Inherited from <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#tobn">toBn</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/UInt.ts#L71" target="_blank">codec/UInt.ts:71</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/UInt.ts#L71" target="_blank">codec/UInt.ts:71</a></em></p>
<p><em><strong>description</strong></em>: Returns the BN representation of the number. (Compatibility)</p>
<p><strong>Returns:</strong> <code>BN</code></p>
<hr>
@@ -3545,7 +3545,7 @@
<p>&#x25B8; <strong>toHex</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
<p><em>Inherited from <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#tohex">toHex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/UInt.ts#L78" target="_blank">codec/UInt.ts:78</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/UInt.ts#L78" target="_blank">codec/UInt.ts:78</a></em></p>
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -3555,7 +3555,7 @@
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
<p><em>Inherited from <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#tojson">toJSON</a></em></p>
<p><em>Overrides BN.toJSON</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/UInt.ts#L85" target="_blank">codec/UInt.ts:85</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/UInt.ts#L85" target="_blank">codec/UInt.ts:85</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
<p><strong>Returns:</strong> <code>any</code></p>
<hr>
@@ -3595,7 +3595,7 @@
<p>&#x25B8; <strong>toString</strong>(base?: <em> <code>undefined</code> | <code>number</code></em>): <code>string</code></p>
<p><em>Inherited from <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#tostring">toString</a></em></p>
<p><em>Overrides BN.toString</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/UInt.ts#L95" target="_blank">codec/UInt.ts:95</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/UInt.ts#L95" target="_blank">codec/UInt.ts:95</a></em></p>
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -3644,7 +3644,7 @@
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em> <code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tou8a">toU8a</a></em></p>
<p><em>Inherited from <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#tou8a">toU8a</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/UInt.ts#L104" target="_blank">codec/UInt.ts:104</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/UInt.ts#L104" target="_blank">codec/UInt.ts:104</a></em></p>
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -3861,7 +3861,7 @@
<h2 id="static-decodeuint"><code>&lt;Static&gt;</code> decodeUInt</h2>
<p>&#x25B8; <strong>decodeUInt</strong>(value: <em><a href="../modules/_types_.md#anynumber">AnyNumber</a></em>, bitLength: <em><a href="../modules/_codec_uint_.md#uintbitlength">UIntBitLength</a></em>): <code>string</code></p>
<p><em>Inherited from <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#decodeuint">decodeUInt</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/UInt.ts#L38" target="_blank">codec/UInt.ts:38</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/UInt.ts#L38" target="_blank">codec/UInt.ts:38</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -4049,7 +4049,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.9","depth":1,"next":{"title":"hidden","level":"4.10","depth":1,"path":"types/classes/_bool_.bool.md","ref":"types/classes/_bool_.bool.md","articles":[]},"previous":{"title":"hidden","level":"4.8","depth":1,"path":"types/classes/_block_.block.md","ref":"types/classes/_block_.block.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"types/classes/_blocknumber_.blocknumber.md","mtime":"2018-12-07T11:34:00.087Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-07T11:34:45.610Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.9","depth":1,"next":{"title":"hidden","level":"4.10","depth":1,"path":"types/classes/_bool_.bool.md","ref":"types/classes/_bool_.bool.md","articles":[]},"previous":{"title":"hidden","level":"4.8","depth":1,"path":"types/classes/_block_.block.md","ref":"types/classes/_block_.block.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"types/classes/_blocknumber_.blocknumber.md","mtime":"2018-12-08T14:35:39.466Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-08T14:36:23.372Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_blocknumber_.blocknumber.md
+9 -9
View File
@@ -26,7 +26,7 @@
*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)*
*Defined in [U64.ts:14](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/U64.ts#L14)*
*Defined in [U64.ts:14](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/U64.ts#L14)*
**Parameters:**
@@ -48,7 +48,7 @@ getencodedLength(): `number`
*Inherited from [UInt](_codec_uint_.uint.md).[encodedLength](_codec_uint_.uint.md#encodedlength)*
*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/UInt.ts#L57)*
*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/UInt.ts#L57)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -188,7 +188,7 @@ ___
*Overrides BN.bitLength*
*Defined in [codec/UInt.ts:64](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/UInt.ts#L64)*
*Defined in [codec/UInt.ts:64](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/UInt.ts#L64)*
*__description__*: Returns the number of bits in the value
@@ -1523,7 +1523,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)*
*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/UInt.ts#L71)*
*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/UInt.ts#L71)*
*__description__*: Returns the BN representation of the number. (Compatibility)
@@ -1562,7 +1562,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)*
*Defined in [codec/UInt.ts:78](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/UInt.ts#L78)*
*Defined in [codec/UInt.ts:78](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/UInt.ts#L78)*
*__description__*: Returns a hex string representation of the value
@@ -1581,7 +1581,7 @@ ___
*Overrides BN.toJSON*
*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/UInt.ts#L85)*
*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/UInt.ts#L85)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -1634,7 +1634,7 @@ ___
*Overrides BN.toString*
*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/UInt.ts#L95)*
*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/UInt.ts#L95)*
*__description__*: Returns the string representation of the value
@@ -1678,7 +1678,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)*
*Defined in [codec/UInt.ts:104](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/UInt.ts#L104)*
*Defined in [codec/UInt.ts:104](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/UInt.ts#L104)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -1882,7 +1882,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)*
*Defined in [codec/UInt.ts:38](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/codec/UInt.ts#L38)*
*Defined in [codec/UInt.ts:38](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/codec/UInt.ts#L38)*
**Parameters:**
docs/types/classes/_bool_.bool.html
+37 -37
View File
@@ -1122,9 +1122,9 @@
</li>
<li class="chapter " data-level="4.58" data-path="_metadata_.callmetadata.html">
<li class="chapter " data-level="4.58" data-path="_metadata_.callmetadata.md">
<a href="_metadata_.callmetadata.html">
<span>
hidden
@@ -1135,9 +1135,9 @@
</li>
<li class="chapter " data-level="4.59" data-path="_metadata_.eventmetadata.html">
<li class="chapter " data-level="4.59" data-path="_metadata_.eventmetadata.md">
<a href="_metadata_.eventmetadata.html">
<span>
hidden
@@ -1148,9 +1148,9 @@
</li>
<li class="chapter " data-level="4.60" data-path="_metadata_.functionargumentmetadata.html">
<li class="chapter " data-level="4.60" data-path="_metadata_.functionargumentmetadata.md">
<a href="_metadata_.functionargumentmetadata.html">
<span>
hidden
@@ -1161,9 +1161,9 @@
</li>
<li class="chapter " data-level="4.61" data-path="_metadata_.functionmetadata.html">
<li class="chapter " data-level="4.61" data-path="_metadata_.functionmetadata.md">
<a href="_metadata_.functionmetadata.html">
<span>
hidden
@@ -1174,9 +1174,9 @@
</li>
<li class="chapter " data-level="4.62" data-path="_metadata_.modulemetadata.html">
<li class="chapter " data-level="4.62" data-path="_metadata_.modulemetadata.md">
<a href="_metadata_.modulemetadata.html">
<span>
hidden
@@ -1187,9 +1187,9 @@
</li>
<li class="chapter " data-level="4.63" data-path="_metadata_.outerdispatchcall.html">
<li class="chapter " data-level="4.63" data-path="_metadata_.outerdispatchcall.md">
<a href="_metadata_.outerdispatchcall.html">
<span>
hidden
@@ -1200,9 +1200,9 @@
</li>
<li class="chapter " data-level="4.64" data-path="_metadata_.outerdispatchmetadata.html">
<li class="chapter " data-level="4.64" data-path="_metadata_.outerdispatchmetadata.md">
<a href="_metadata_.outerdispatchmetadata.html">
<span>
hidden
@@ -1213,9 +1213,9 @@
</li>
<li class="chapter " data-level="4.65" data-path="_metadata_.outereventmetadata.html">
<li class="chapter " data-level="4.65" data-path="_metadata_.outereventmetadata.md">
<a href="_metadata_.outereventmetadata.html">
<span>
hidden
@@ -1226,9 +1226,9 @@
</li>
<li class="chapter " data-level="4.66" data-path="_metadata_.outereventmetadataevent.html">
<li class="chapter " data-level="4.66" data-path="_metadata_.outereventmetadataevent.md">
<a href="_metadata_.outereventmetadataevent.html">
<span>
hidden
@@ -1252,9 +1252,9 @@
</li>
<li class="chapter " data-level="4.68" data-path="_metadata_.runtimemodulemetadata.html">
<li class="chapter " data-level="4.68" data-path="_metadata_.runtimemodulemetadata.md">
<a href="_metadata_.runtimemodulemetadata.html">
<span>
hidden
@@ -1265,9 +1265,9 @@
</li>
<li class="chapter " data-level="4.69" data-path="_metadata_.storagefunctionmetadata.html">
<li class="chapter " data-level="4.69" data-path="_metadata_.storagefunctionmetadata.md">
<a href="_metadata_.storagefunctionmetadata.html">
<span>
hidden
@@ -1278,9 +1278,9 @@
</li>
<li class="chapter " data-level="4.70" data-path="_metadata_.storagefunctionmodifier.html">
<li class="chapter " data-level="4.70" data-path="_metadata_.storagefunctionmodifier.md">
<a href="_metadata_.storagefunctionmodifier.html">
<span>
hidden
@@ -1291,9 +1291,9 @@
</li>
<li class="chapter " data-level="4.71" data-path="_metadata_.storagefunctiontype.html">
<li class="chapter " data-level="4.71" data-path="_metadata_.storagefunctiontype.md">
<a href="_metadata_.storagefunctiontype.html">
<span>
hidden
@@ -1304,9 +1304,9 @@
</li>
<li class="chapter " data-level="4.72" data-path="_metadata_.storagefunctiontype_map.html">
<li class="chapter " data-level="4.72" data-path="_metadata_.storagefunctiontype_map.md">
<a href="_metadata_.storagefunctiontype_map.html">
<span>
hidden
@@ -1317,9 +1317,9 @@
</li>
<li class="chapter " data-level="4.73" data-path="_metadata_.storagemetadata.html">
<li class="chapter " data-level="4.73" data-path="_metadata_.storagemetadata.md">
<a href="_metadata_.storagemetadata.html">
<span>
hidden
@@ -1973,7 +1973,7 @@
<p><a id="constructor"></a></p>
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new Bool</strong>(value?: <em> <a href="_bool_.bool.html">Bool</a> | <code>Boolean</code> | <code>Uint8Array</code> | <code>boolean</code> | <code>number</code></em>): <a href="_bool_.bool.html">Bool</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Bool.ts#L15" target="_blank">Bool.ts:15</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Bool.ts#L15" target="_blank">Bool.ts:15</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2003,7 +2003,7 @@
<p><a id="encodedlength"></a></p>
<h2 id="encodedlength">encodedLength</h2>
<p>getencodedLength(): <code>number</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Bool.ts#L35" target="_blank">Bool.ts:35</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Bool.ts#L35" target="_blank">Bool.ts:35</a></em></p>
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2012,7 +2012,7 @@
<h2 id="tohex">toHex</h2>
<p>&#x25B8; <strong>toHex</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Bool.ts#L42" target="_blank">Bool.ts:42</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Bool.ts#L42" target="_blank">Bool.ts:42</a></em></p>
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2020,7 +2020,7 @@
<h2 id="tojson">toJSON</h2>
<p>&#x25B8; <strong>toJSON</strong>(): <code>any</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Bool.ts#L49" target="_blank">Bool.ts:49</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Bool.ts#L49" target="_blank">Bool.ts:49</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
<p><strong>Returns:</strong> <code>any</code></p>
<hr>
@@ -2028,7 +2028,7 @@
<h2 id="tostring">toString</h2>
<p>&#x25B8; <strong>toString</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Bool.ts#L56" target="_blank">Bool.ts:56</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Bool.ts#L56" target="_blank">Bool.ts:56</a></em></p>
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2036,7 +2036,7 @@
<h2 id="tou8a">toU8a</h2>
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em> <code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tou8a">toU8a</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Bool.ts#L64" target="_blank">Bool.ts:64</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Bool.ts#L64" target="_blank">Bool.ts:64</a></em></p>
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2100,7 +2100,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.10","depth":1,"next":{"title":"hidden","level":"4.11","depth":1,"path":"types/classes/_bytes_.bytes.md","ref":"types/classes/_bytes_.bytes.md","articles":[]},"previous":{"title":"hidden","level":"4.9","depth":1,"path":"types/classes/_blocknumber_.blocknumber.md","ref":"types/classes/_blocknumber_.blocknumber.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"types/classes/_bool_.bool.md","mtime":"2018-12-07T11:34:00.103Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-07T11:34:45.610Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.10","depth":1,"next":{"title":"hidden","level":"4.11","depth":1,"path":"types/classes/_bytes_.bytes.md","ref":"types/classes/_bytes_.bytes.md","articles":[]},"previous":{"title":"hidden","level":"4.9","depth":1,"path":"types/classes/_blocknumber_.blocknumber.md","ref":"types/classes/_blocknumber_.blocknumber.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"types/classes/_bool_.bool.md","mtime":"2018-12-08T14:35:39.482Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-08T14:36:23.372Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_bool_.bool.md
+6 -6
View File
@@ -22,7 +22,7 @@
⊕ **new Bool**(value?: * [Bool](_bool_.bool.md) &#124; `Boolean` &#124; `Uint8Array` &#124; `boolean` &#124; `number`*): [Bool](_bool_.bool.md)
*Defined in [Bool.ts:15](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Bool.ts#L15)*
*Defined in [Bool.ts:15](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Bool.ts#L15)*
**Parameters:**
@@ -54,7 +54,7 @@ ___
getencodedLength(): `number`
*Defined in [Bool.ts:35](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Bool.ts#L35)*
*Defined in [Bool.ts:35](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Bool.ts#L35)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -72,7 +72,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)*
*Defined in [Bool.ts:42](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Bool.ts#L42)*
*Defined in [Bool.ts:42](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Bool.ts#L42)*
*__description__*: Returns a hex string representation of the value
@@ -87,7 +87,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)*
*Defined in [Bool.ts:49](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Bool.ts#L49)*
*Defined in [Bool.ts:49](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Bool.ts#L49)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -102,7 +102,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)*
*Defined in [Bool.ts:56](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Bool.ts#L56)*
*Defined in [Bool.ts:56](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Bool.ts#L56)*
*__description__*: Returns the string representation of the value
@@ -117,7 +117,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)*
*Defined in [Bool.ts:64](https://github.com/polkadot-js/api/blob/69f6850/packages/types/src/Bool.ts#L64)*
*Defined in [Bool.ts:64](https://github.com/polkadot-js/api/blob/448a729/packages/types/src/Bool.ts#L64)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications

Some files were not shown because too many files have changed in this diff Show More