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

[CI Skip] 0.32.17

Browse Source
This commit is contained in:
Travis CI
2018-12-03 10:28:14 +00:00
parent 6cab9be9c8
commit f1df2f7c75
219 changed files with 12988 additions and 2017 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/GLOSSARY.html
+14 -1
View File
@@ -194,6 +194,19 @@
</li>
<li class="chapter " data-level="1.4" data-path="types/">
<a href="types/">
types (codec implementation)
</a>
</li>
@@ -439,7 +452,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-11-30T14:55:08.108Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-30T14:58:57.607Z"},"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-03T10:24:06.792Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-03T10:28:05.942Z"},"basePath":".","book":{"language":""}});
});
</script>
</div>
docs/METHODS_EVENTS.html
+14 -1
View File
@@ -198,6 +198,19 @@
</li>
<li class="chapter " data-level="1.4" data-path="types/">
<a href="types/">
types (codec implementation)
</a>
</li>
@@ -613,7 +626,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-11-30T14:57:25.617Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-30T14:58:57.607Z"},"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-03T10:26:27.577Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-03T10:28:05.942Z"},"basePath":".","book":{"language":""}});
});
</script>
</div>
docs/METHODS_EXTRINSICS.html
+14 -1
View File
@@ -198,6 +198,19 @@
</li>
<li class="chapter " data-level="1.4" data-path="types/">
<a href="types/">
types (codec implementation)
</a>
</li>
@@ -559,7 +572,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-11-30T14:57:25.617Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-30T14:58:57.607Z"},"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-03T10:26:27.577Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-03T10:28:05.942Z"},"basePath":".","book":{"language":""}});
});
</script>
</div>
docs/METHODS_RPC.html
+16 -3
View File
@@ -64,7 +64,7 @@
<link rel="next" href="METHODS_STORAGE.html" />
<link rel="prev" href="rpc-provider/classes/_ws_index_.wsprovider.html" />
<link rel="prev" href="types/" />
</head>
@@ -198,6 +198,19 @@
</li>
<li class="chapter " data-level="1.4" data-path="types/">
<a href="types/">
types (codec implementation)
</a>
</li>
@@ -553,7 +566,7 @@
<a href="rpc-provider/classes/_ws_index_.wsprovider.html" class="navigation navigation-prev " aria-label="Previous page: WsProvider">
<a href="types/" class="navigation navigation-prev " aria-label="Previous page: types (codec implementation)">
<i class="fa fa-angle-left"></i>
</a>
@@ -569,7 +582,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":"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":"METHODS_RPC.md","mtime":"2018-11-30T14:57:25.617Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-30T14:58:57.607Z"},"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-03T10:26:27.577Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-03T10:28:05.942Z"},"basePath":".","book":{"language":""}});
});
</script>
</div>
docs/METHODS_STORAGE.html
+14 -1
View File
@@ -198,6 +198,19 @@
</li>
<li class="chapter " data-level="1.4" data-path="types/">
<a href="types/">
types (codec implementation)
</a>
</li>
@@ -900,7 +913,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-11-30T14:57:25.649Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-30T14:58:57.607Z"},"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-03T10:26:27.597Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-03T10:28:05.942Z"},"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/82dcbe5/packages/api-observable/src/Base.ts#L33)*
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Base.ts#L33)*
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Base.ts#L41)*
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Base.ts#L42)*
*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Base.ts#L87)*
*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Base.ts#L91)*
*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Base.ts#L95)*
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Base.ts#L108)*
*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Base.ts#L123)*
*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Base.ts#L33)*
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Base.ts#L33)*
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Base.ts#L41)*
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Base.ts#L42)*
*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Base.ts#L87)*
*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L19)*
*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L23)*
*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L27)*
*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Calls.ts#L13)*
*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L35)*
*Defined in [Queries.ts:35](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L31)*
*Defined in [Queries.ts:31](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Calls.ts#L25)*
*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L39)*
*Defined in [Queries.ts:39](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L43)*
*Defined in [Queries.ts:43](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L126)*
*Defined in [Queries.ts:126](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L151)*
*Defined in [Queries.ts:151](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L130)*
*Defined in [Queries.ts:130](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L47)*
*Defined in [Queries.ts:47](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Calls.ts#L29)*
*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Base.ts#L91)*
*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L58)*
*Defined in [Queries.ts:58](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L62)*
*Defined in [Queries.ts:62](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L75)*
*Defined in [Queries.ts:75](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Base.ts#L95)*
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Base.ts#L108)*
*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Base.ts#L123)*
*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L94)*
*Defined in [Queries.ts:94](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L98)*
*Defined in [Queries.ts:98](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L111)*
*Defined in [Queries.ts:111](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L115)*
*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L163)*
*Defined in [Queries.ts:163](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L167)*
*Defined in [Queries.ts:167](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L171)*
*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L175)*
*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L155)*
*Defined in [Queries.ts:155](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L159)*
*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L183)*
*Defined in [Queries.ts:183](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L179)*
*Defined in [Queries.ts:179](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L194)*
*Defined in [Queries.ts:194](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L216)*
*Defined in [Queries.ts:216](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L205)*
*Defined in [Queries.ts:205](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Calls.ts#L51)*
*Defined in [Calls.ts:51](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Calls.ts#L47)*
*Defined in [Calls.ts:47](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Calls.ts#L33)*
*Defined in [Calls.ts:33](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L220)*
*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Calls.ts#L39)*
*Defined in [Calls.ts:39](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Calls.ts#L43)*
*Defined in [Calls.ts:43](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L231)*
*Defined in [Queries.ts:231](https://github.com/polkadot-js/api/blob/6cab9be/packages/api-observable/src/Queries.ts#L231)*
**Returns:** `Observable`< `u32` &#124; `undefined`>
docs/api-observable/classes/_classes_.rxproposal.md
+30 -16
View File
@@ -25,7 +25,7 @@
*Overrides Struct.__constructor*
*Defined in [classes.ts:12](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api-observable/src/classes.ts#L12)*
*Defined in [classes.ts:12](https://github.com/polkadot-js/api/blob/6cab9be/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:125](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L125)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:129](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L129)*
**Returns:** `E`
@@ -83,7 +83,7 @@ ___
getaddress(): `AccountId`
*Defined in [classes.ts:21](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api-observable/src/classes.ts#L21)*
*Defined in [classes.ts:21](https://github.com/polkadot-js/api/blob/6cab9be/packages/api-observable/src/classes.ts#L21)*
**Returns:** `AccountId`
@@ -96,7 +96,9 @@ getencodedLength(): `number`
*Inherited from Struct.encodedLength*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:129](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L129)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L136)*
*__description__*: The length of the value when encoded as a Uint8Array
**Returns:** `number`
@@ -107,7 +109,7 @@ ___
getid(): `PropIndex`
*Defined in [classes.ts:25](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api-observable/src/classes.ts#L25)*
*Defined in [classes.ts:25](https://github.com/polkadot-js/api/blob/6cab9be/packages/api-observable/src/classes.ts#L25)*
**Returns:** `PropIndex`
@@ -118,7 +120,7 @@ ___
getproposal(): `Proposal`
*Defined in [classes.ts:29](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api-observable/src/classes.ts#L29)*
*Defined in [classes.ts:29](https://github.com/polkadot-js/api/blob/6cab9be/packages/api-observable/src/classes.ts#L29)*
**Returns:** `Proposal`
@@ -235,7 +237,9 @@ ___
*Inherited from Struct.getAtIndex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:135](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L135)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L145)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
**Parameters:**
@@ -308,7 +312,9 @@ ___
*Inherited from Struct.toArray*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:139](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L139)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:152](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L152)*
*__description__*: Converts the Object to an standard JavaScript Array
**Returns:** `Array`<`Codec`>
@@ -321,7 +327,9 @@ ___
*Inherited from Struct.toHex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:143](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L143)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L159)*
*__description__*: Returns a hex string representation of the value
**Returns:** `string`
@@ -334,7 +342,9 @@ ___
*Inherited from Struct.toJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L147)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L166)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
**Returns:** `any`
@@ -347,7 +357,9 @@ ___
*Inherited from Struct.toString*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L158)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L180)*
*__description__*: Returns the string representation of the value
**Returns:** `string`
@@ -360,13 +372,15 @@ ___
*Inherited from Struct.toU8a*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:162](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L162)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:188](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L188)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
**Parameters:**
| Name | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
| Name | Type | Description |
| ------ | ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`| true when the value has none of the type-specific prefixes (internal) |
**Returns:** `Uint8Array`
@@ -394,7 +408,7 @@ ___
*Inherited from Struct.with*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:108](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L108)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L112)*
**Type parameters:**
docs/api-observable/classes/_classes_.rxproposaldeposits.md
+29 -15
View File
@@ -25,7 +25,7 @@
*Overrides Struct.__constructor*
*Defined in [classes.ts:36](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api-observable/src/classes.ts#L36)*
*Defined in [classes.ts:36](https://github.com/polkadot-js/api/blob/6cab9be/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:125](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L125)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:129](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L129)*
**Returns:** `E`
@@ -83,7 +83,7 @@ ___
getaddresses(): `Vector`<`AccountId`>
*Defined in [classes.ts:44](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api-observable/src/classes.ts#L44)*
*Defined in [classes.ts:44](https://github.com/polkadot-js/api/blob/6cab9be/packages/api-observable/src/classes.ts#L44)*
**Returns:** `Vector`<`AccountId`>
@@ -94,7 +94,7 @@ ___
getbalance(): `Balance`
*Defined in [classes.ts:48](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api-observable/src/classes.ts#L48)*
*Defined in [classes.ts:48](https://github.com/polkadot-js/api/blob/6cab9be/packages/api-observable/src/classes.ts#L48)*
**Returns:** `Balance`
@@ -107,7 +107,9 @@ getencodedLength(): `number`
*Inherited from Struct.encodedLength*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:129](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L129)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L136)*
*__description__*: The length of the value when encoded as a Uint8Array
**Returns:** `number`
@@ -224,7 +226,9 @@ ___
*Inherited from Struct.getAtIndex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:135](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L135)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L145)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
**Parameters:**
@@ -297,7 +301,9 @@ ___
*Inherited from Struct.toArray*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:139](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L139)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:152](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L152)*
*__description__*: Converts the Object to an standard JavaScript Array
**Returns:** `Array`<`Codec`>
@@ -310,7 +316,9 @@ ___
*Inherited from Struct.toHex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:143](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L143)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L159)*
*__description__*: Returns a hex string representation of the value
**Returns:** `string`
@@ -323,7 +331,9 @@ ___
*Inherited from Struct.toJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L147)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L166)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
**Returns:** `any`
@@ -336,7 +346,9 @@ ___
*Inherited from Struct.toString*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L158)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L180)*
*__description__*: Returns the string representation of the value
**Returns:** `string`
@@ -349,13 +361,15 @@ ___
*Inherited from Struct.toU8a*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:162](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L162)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:188](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L188)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
**Parameters:**
| Name | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
| Name | Type | Description |
| ------ | ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`| true when the value has none of the type-specific prefixes (internal) |
**Returns:** `Uint8Array`
@@ -383,7 +397,7 @@ ___
*Inherited from Struct.with*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:108](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L108)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L112)*
**Type parameters:**
docs/api-observable/classes/_classes_.rxreferendum.md
+31 -17
View File
@@ -25,7 +25,7 @@
*Overrides Struct.__constructor*
*Defined in [classes.ts:55](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api-observable/src/classes.ts#L55)*
*Defined in [classes.ts:55](https://github.com/polkadot-js/api/blob/6cab9be/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:125](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L125)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:129](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L129)*
**Returns:** `E`
@@ -84,7 +84,7 @@ ___
getblockNumber(): `BlockNumber`
*Defined in [classes.ts:65](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api-observable/src/classes.ts#L65)*
*Defined in [classes.ts:65](https://github.com/polkadot-js/api/blob/6cab9be/packages/api-observable/src/classes.ts#L65)*
**Returns:** `BlockNumber`
@@ -97,7 +97,9 @@ getencodedLength(): `number`
*Inherited from Struct.encodedLength*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:129](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L129)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L136)*
*__description__*: The length of the value when encoded as a Uint8Array
**Returns:** `number`
@@ -108,7 +110,7 @@ ___
getid(): `ReferendumIndex`
*Defined in [classes.ts:69](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api-observable/src/classes.ts#L69)*
*Defined in [classes.ts:69](https://github.com/polkadot-js/api/blob/6cab9be/packages/api-observable/src/classes.ts#L69)*
**Returns:** `ReferendumIndex`
@@ -119,7 +121,7 @@ ___
getproposal(): `Proposal`
*Defined in [classes.ts:73](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api-observable/src/classes.ts#L73)*
*Defined in [classes.ts:73](https://github.com/polkadot-js/api/blob/6cab9be/packages/api-observable/src/classes.ts#L73)*
**Returns:** `Proposal`
@@ -130,7 +132,7 @@ ___
getvoteThreshold(): `VoteThreshold`
*Defined in [classes.ts:77](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api-observable/src/classes.ts#L77)*
*Defined in [classes.ts:77](https://github.com/polkadot-js/api/blob/6cab9be/packages/api-observable/src/classes.ts#L77)*
**Returns:** `VoteThreshold`
@@ -247,7 +249,9 @@ ___
*Inherited from Struct.getAtIndex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:135](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L135)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L145)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
**Parameters:**
@@ -320,7 +324,9 @@ ___
*Inherited from Struct.toArray*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:139](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L139)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:152](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L152)*
*__description__*: Converts the Object to an standard JavaScript Array
**Returns:** `Array`<`Codec`>
@@ -333,7 +339,9 @@ ___
*Inherited from Struct.toHex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:143](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L143)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L159)*
*__description__*: Returns a hex string representation of the value
**Returns:** `string`
@@ -346,7 +354,9 @@ ___
*Inherited from Struct.toJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L147)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L166)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
**Returns:** `any`
@@ -359,7 +369,9 @@ ___
*Inherited from Struct.toString*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L158)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L180)*
*__description__*: Returns the string representation of the value
**Returns:** `string`
@@ -372,13 +384,15 @@ ___
*Inherited from Struct.toU8a*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:162](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L162)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:188](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L188)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
**Parameters:**
| Name | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
| Name | Type | Description |
| ------ | ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`| true when the value has none of the type-specific prefixes (internal) |
**Returns:** `Uint8Array`
@@ -406,7 +420,7 @@ ___
*Inherited from Struct.with*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:108](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L108)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L112)*
**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/82dcbe5/packages/api-observable/src/Base.ts#L33)*
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Base.ts#L33)*
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Base.ts#L41)*
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Base.ts#L42)*
*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Base.ts#L87)*
*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Combined.ts#L79)*
*Defined in [Combined.ts:79](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Combined.ts#L53)*
*Defined in [Combined.ts:53](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Combined.ts#L68)*
*Defined in [Combined.ts:68](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Combined.ts#L23)*
*Defined in [Combined.ts:23](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L19)*
*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L23)*
*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L27)*
*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Calls.ts#L13)*
*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L35)*
*Defined in [Queries.ts:35](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L31)*
*Defined in [Queries.ts:31](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Calls.ts#L25)*
*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L39)*
*Defined in [Queries.ts:39](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L43)*
*Defined in [Queries.ts:43](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Combined.ts#L137)*
*Defined in [Combined.ts:137](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Combined.ts#L182)*
*Defined in [Combined.ts:182](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Combined.ts#L198)*
*Defined in [Combined.ts:198](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L126)*
*Defined in [Queries.ts:126](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Combined.ts#L209)*
*Defined in [Combined.ts:209](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Combined.ts#L224)*
*Defined in [Combined.ts:224](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Combined.ts#L247)*
*Defined in [Combined.ts:247](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L151)*
*Defined in [Queries.ts:151](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L130)*
*Defined in [Queries.ts:130](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L47)*
*Defined in [Queries.ts:47](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Calls.ts#L29)*
*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Base.ts#L91)*
*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L58)*
*Defined in [Queries.ts:58](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L62)*
*Defined in [Queries.ts:62](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Combined.ts#L115)*
*Defined in [Combined.ts:115](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L75)*
*Defined in [Queries.ts:75](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Base.ts#L95)*
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Base.ts#L108)*
*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Base.ts#L123)*
*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L94)*
*Defined in [Queries.ts:94](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L98)*
*Defined in [Queries.ts:98](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L111)*
*Defined in [Queries.ts:111](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L115)*
*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Combined.ts#L174)*
*Defined in [Combined.ts:174](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Combined.ts#L153)*
*Defined in [Combined.ts:153](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Combined.ts#L125)*
*Defined in [Combined.ts:125](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Combined.ts#L262)*
*Defined in [Combined.ts:262](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Combined.ts#L282)*
*Defined in [Combined.ts:282](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Combined.ts#L297)*
*Defined in [Combined.ts:297](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L163)*
*Defined in [Queries.ts:163](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L167)*
*Defined in [Queries.ts:167](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L171)*
*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L175)*
*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L155)*
*Defined in [Queries.ts:155](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L159)*
*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Combined.ts#L316)*
*Defined in [Combined.ts:316](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Combined.ts#L331)*
*Defined in [Combined.ts:331](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L183)*
*Defined in [Queries.ts:183](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L179)*
*Defined in [Queries.ts:179](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L194)*
*Defined in [Queries.ts:194](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L216)*
*Defined in [Queries.ts:216](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L205)*
*Defined in [Queries.ts:205](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Calls.ts#L51)*
*Defined in [Calls.ts:51](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Calls.ts#L47)*
*Defined in [Calls.ts:47](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Calls.ts#L33)*
*Defined in [Calls.ts:33](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L220)*
*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Calls.ts#L39)*
*Defined in [Calls.ts:39](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Calls.ts#L43)*
*Defined in [Calls.ts:43](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Combined.ts#L346)*
*Defined in [Combined.ts:346](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Combined.ts#L371)*
*Defined in [Combined.ts:371](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L231)*
*Defined in [Queries.ts:231](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Combined.ts#L385)*
*Defined in [Combined.ts:385](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Combined.ts#L425)*
*Defined in [Combined.ts:425](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Combined.ts#L414)*
*Defined in [Combined.ts:414](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Base.ts#L33)*
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Base.ts#L33)*
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Base.ts#L41)*
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Base.ts#L42)*
*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Base.ts#L87)*
*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Combined.ts#L79)*
*Defined in [Combined.ts:79](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Combined.ts#L53)*
*Defined in [Combined.ts:53](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Combined.ts#L68)*
*Defined in [Combined.ts:68](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Combined.ts#L23)*
*Defined in [Combined.ts:23](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L19)*
*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L23)*
*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L27)*
*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Calls.ts#L13)*
*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L35)*
*Defined in [Queries.ts:35](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L31)*
*Defined in [Queries.ts:31](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Calls.ts#L25)*
*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L39)*
*Defined in [Queries.ts:39](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L43)*
*Defined in [Queries.ts:43](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Combined.ts#L137)*
*Defined in [Combined.ts:137](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Combined.ts#L182)*
*Defined in [Combined.ts:182](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Combined.ts#L198)*
*Defined in [Combined.ts:198](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L126)*
*Defined in [Queries.ts:126](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Combined.ts#L209)*
*Defined in [Combined.ts:209](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Combined.ts#L224)*
*Defined in [Combined.ts:224](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Combined.ts#L247)*
*Defined in [Combined.ts:247](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L151)*
*Defined in [Queries.ts:151](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L130)*
*Defined in [Queries.ts:130](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L47)*
*Defined in [Queries.ts:47](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Calls.ts#L29)*
*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Base.ts#L91)*
*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L58)*
*Defined in [Queries.ts:58](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L62)*
*Defined in [Queries.ts:62](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Combined.ts#L115)*
*Defined in [Combined.ts:115](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L75)*
*Defined in [Queries.ts:75](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Base.ts#L95)*
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Base.ts#L108)*
*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Base.ts#L123)*
*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L94)*
*Defined in [Queries.ts:94](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L98)*
*Defined in [Queries.ts:98](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L111)*
*Defined in [Queries.ts:111](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L115)*
*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Combined.ts#L174)*
*Defined in [Combined.ts:174](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Combined.ts#L153)*
*Defined in [Combined.ts:153](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Combined.ts#L125)*
*Defined in [Combined.ts:125](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Combined.ts#L262)*
*Defined in [Combined.ts:262](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Combined.ts#L282)*
*Defined in [Combined.ts:282](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Combined.ts#L297)*
*Defined in [Combined.ts:297](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L163)*
*Defined in [Queries.ts:163](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L167)*
*Defined in [Queries.ts:167](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L171)*
*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L175)*
*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L155)*
*Defined in [Queries.ts:155](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L159)*
*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Combined.ts#L316)*
*Defined in [Combined.ts:316](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Combined.ts#L331)*
*Defined in [Combined.ts:331](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L183)*
*Defined in [Queries.ts:183](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L179)*
*Defined in [Queries.ts:179](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L194)*
*Defined in [Queries.ts:194](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L216)*
*Defined in [Queries.ts:216](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L205)*
*Defined in [Queries.ts:205](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Calls.ts#L51)*
*Defined in [Calls.ts:51](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Calls.ts#L47)*
*Defined in [Calls.ts:47](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Calls.ts#L33)*
*Defined in [Calls.ts:33](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L220)*
*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Calls.ts#L39)*
*Defined in [Calls.ts:39](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Calls.ts#L43)*
*Defined in [Calls.ts:43](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Combined.ts#L346)*
*Defined in [Combined.ts:346](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Combined.ts#L371)*
*Defined in [Combined.ts:371](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L231)*
*Defined in [Queries.ts:231](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Combined.ts#L385)*
*Defined in [Combined.ts:385](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Combined.ts#L425)*
*Defined in [Combined.ts:425](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Combined.ts#L414)*
*Defined in [Combined.ts:414](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Base.ts#L33)*
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Base.ts#L33)*
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Base.ts#L41)*
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Base.ts#L42)*
*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Base.ts#L87)*
*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L19)*
*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L23)*
*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L27)*
*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L35)*
*Defined in [Queries.ts:35](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L31)*
*Defined in [Queries.ts:31](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L39)*
*Defined in [Queries.ts:39](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L43)*
*Defined in [Queries.ts:43](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L126)*
*Defined in [Queries.ts:126](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L151)*
*Defined in [Queries.ts:151](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L130)*
*Defined in [Queries.ts:130](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L47)*
*Defined in [Queries.ts:47](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Base.ts#L91)*
*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L58)*
*Defined in [Queries.ts:58](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L62)*
*Defined in [Queries.ts:62](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L75)*
*Defined in [Queries.ts:75](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Base.ts#L95)*
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Base.ts#L108)*
*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Base.ts#L123)*
*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L94)*
*Defined in [Queries.ts:94](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L98)*
*Defined in [Queries.ts:98](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L111)*
*Defined in [Queries.ts:111](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L115)*
*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L163)*
*Defined in [Queries.ts:163](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L167)*
*Defined in [Queries.ts:167](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L171)*
*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L175)*
*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L155)*
*Defined in [Queries.ts:155](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L159)*
*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L183)*
*Defined in [Queries.ts:183](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L179)*
*Defined in [Queries.ts:179](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L194)*
*Defined in [Queries.ts:194](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L216)*
*Defined in [Queries.ts:216](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L205)*
*Defined in [Queries.ts:205](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L220)*
*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/Queries.ts#L231)*
*Defined in [Queries.ts:231](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/types.ts#L12)*
*Defined in [types.ts:12](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/types.ts#L14)*
*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/types.ts#L38)*
*Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/types.ts#L24)*
*Defined in [types.ts:24](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api-observable/src/types.ts#L32)*
*Defined in [types.ts:32](https://github.com/polkadot-js/api/blob/6cab9be/packages/api-observable/src/types.ts#L32)*
#### Type declaration
docs/api/classes/_base_.apibase.md
+8 -8
View File
@@ -24,7 +24,7 @@
⊕ **new ApiBase**(options: *[ApiOptions](../interfaces/_base_.apioptions.md)*): [ApiBase](_base_.apibase.md)
*Defined in [Base.ts:53](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/Base.ts#L53)*
*Defined in [Base.ts:53](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/Base.ts#L53)*
*__description__*: Create an instance of the class
@@ -58,7 +58,7 @@ ___
getgenesisHash(): `Hash`
*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/Base.ts#L88)*
*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/Base.ts#L88)*
*__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 @@ ___
getquery(): `S`
*Defined in [Base.ts:126](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/Base.ts#L126)*
*Defined in [Base.ts:126](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/Base.ts#L126)*
*__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.
@@ -94,7 +94,7 @@ ___
getrpc(): `R`
*Defined in [Base.ts:146](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/Base.ts#L146)*
*Defined in [Base.ts:146](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/Base.ts#L146)*
*__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.
@@ -117,7 +117,7 @@ ___
getruntimeMetadata(): `RuntimeMetadata`
*Defined in [Base.ts:97](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/Base.ts#L97)*
*Defined in [Base.ts:97](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/Base.ts#L97)*
*__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.
@@ -130,7 +130,7 @@ ___
getruntimeVersion(): `RuntimeVersion`
*Defined in [Base.ts:106](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/Base.ts#L106)*
*Defined in [Base.ts:106](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/Base.ts#L106)*
*__description__*: Contains the version information for the current runtime.
@@ -143,7 +143,7 @@ ___
gettx(): `E`
*Defined in [Base.ts:165](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/Base.ts#L165)*
*Defined in [Base.ts:165](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/Base.ts#L165)*
*__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.
@@ -170,7 +170,7 @@ ___
▸ **on**(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `void`
*Defined in [Base.ts:190](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/Base.ts#L190)*
*Defined in [Base.ts:190](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/Base.ts#L190)*
*__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/82dcbe5/packages/api/src/promise/Combinator.ts#L14)*
*Defined in [promise/Combinator.ts:14](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/promise/Combinator.ts#L14)*
**Parameters:**
docs/api/classes/_promise_index_.apipromise.html
+25 -12
View File
@@ -198,6 +198,19 @@
</li>
<li class="chapter " data-level="1.4" data-path="../../types/">
<a href="../../types/">
types (codec implementation)
</a>
</li>
@@ -482,7 +495,7 @@
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new ApiPromise</strong>(options?: <em> <a href="../interfaces/_base_.apioptions.md">ApiOptions</a> | <code>WsProvider</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/82dcbe5/packages/api/src/promise/index.ts#L128" target="_blank">promise/index.ts:128</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/promise/index.ts#L128" target="_blank">promise/index.ts:128</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>
@@ -519,14 +532,14 @@
<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/82dcbe5/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/6cab9be/packages/api/src/Base.ts#L88" target="_blank">Base.ts:88</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>
<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/82dcbe5/packages/api/src/promise/index.ts#L166" target="_blank">promise/index.ts:166</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/promise/index.ts#L166" target="_blank">promise/index.ts:166</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>
@@ -534,7 +547,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/82dcbe5/packages/api/src/Base.ts#L126" target="_blank">Base.ts:126</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/Base.ts#L126" target="_blank">Base.ts:126</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>
@@ -548,7 +561,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/82dcbe5/packages/api/src/Base.ts#L146" target="_blank">Base.ts:146</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/Base.ts#L146" target="_blank">Base.ts:146</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>
@@ -562,7 +575,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/82dcbe5/packages/api/src/Base.ts#L97" target="_blank">Base.ts:97</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/Base.ts#L97" target="_blank">Base.ts:97</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>
@@ -570,7 +583,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/82dcbe5/packages/api/src/Base.ts#L106" target="_blank">Base.ts:106</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/Base.ts#L106" target="_blank">Base.ts:106</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>
@@ -578,7 +591,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/82dcbe5/packages/api/src/Base.ts#L165" target="_blank">Base.ts:165</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/Base.ts#L165" target="_blank">Base.ts:165</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>
@@ -594,7 +607,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/82dcbe5/packages/api/src/promise/index.ts#L194" target="_blank">promise/index.ts:194</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/promise/index.ts#L194" target="_blank">promise/index.ts:194</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>
@@ -636,7 +649,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/82dcbe5/packages/api/src/Base.ts#L190" target="_blank">Base.ts:190</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/Base.ts#L190" target="_blank">Base.ts:190</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>
@@ -674,7 +687,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/_base_.apioptions.md">ApiOptions</a> | <code>WsProvider</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/82dcbe5/packages/api/src/promise/index.ts#L126" target="_blank">promise/index.ts:126</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/promise/index.ts#L126" target="_blank">promise/index.ts:126</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>
@@ -749,7 +762,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-11-30T14:57:32.429Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-30T14:58:57.607Z"},"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-03T10:26:34.961Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-03T10:28:05.942Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/api/classes/_promise_index_.apipromise.md
+11 -11
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:128](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/promise/index.ts#L128)*
*Defined in [promise/index.ts:128](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/promise/index.ts#L128)*
*__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:88](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/Base.ts#L88)*
*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/Base.ts#L88)*
*__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.
@@ -155,7 +155,7 @@ ___
getisReady(): `Promise`<[ApiPromise](_promise_index_.apipromise.md)>
*Defined in [promise/index.ts:166](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/promise/index.ts#L166)*
*Defined in [promise/index.ts:166](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/promise/index.ts#L166)*
*__description__*: Promise that returns the first time we are connected and loaded
@@ -170,7 +170,7 @@ getquery(): [QueryableStorage](../interfaces/_promise_types_.queryablestorage.md
*Inherited from [ApiBase](_base_.apibase.md).[query](_base_.apibase.md#query)*
*Defined in [Base.ts:126](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/Base.ts#L126)*
*Defined in [Base.ts:126](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/Base.ts#L126)*
*__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.
@@ -195,7 +195,7 @@ getrpc(): `Rpc`
*Inherited from [ApiBase](_base_.apibase.md).[rpc](_base_.apibase.md#rpc)*
*Defined in [Base.ts:146](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/Base.ts#L146)*
*Defined in [Base.ts:146](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/Base.ts#L146)*
*__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.
@@ -220,7 +220,7 @@ getruntimeMetadata(): `RuntimeMetadata`
*Inherited from [ApiBase](_base_.apibase.md).[runtimeMetadata](_base_.apibase.md#runtimemetadata)*
*Defined in [Base.ts:97](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/Base.ts#L97)*
*Defined in [Base.ts:97](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/Base.ts#L97)*
*__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.
@@ -235,7 +235,7 @@ getruntimeVersion(): `RuntimeVersion`
*Inherited from [ApiBase](_base_.apibase.md).[runtimeVersion](_base_.apibase.md#runtimeversion)*
*Defined in [Base.ts:106](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/Base.ts#L106)*
*Defined in [Base.ts:106](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/Base.ts#L106)*
*__description__*: Contains the version information for the current runtime.
@@ -250,7 +250,7 @@ gettx(): [SubmittableExtrinsics](../interfaces/_promise_types_.submittableextrin
*Inherited from [ApiBase](_base_.apibase.md).[tx](_base_.apibase.md#tx)*
*Defined in [Base.ts:165](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/Base.ts#L165)*
*Defined in [Base.ts:165](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/Base.ts#L165)*
*__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.
@@ -277,7 +277,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:194](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/promise/index.ts#L194)*
*Defined in [promise/index.ts:194](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/promise/index.ts#L194)*
*__description__*: Creates a combinator that can be used to combine the latest results from multiple subscriptions
@@ -314,7 +314,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[on](_base_.apibase.md#on)*
*Defined in [Base.ts:190](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/Base.ts#L190)*
*Defined in [Base.ts:190](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/Base.ts#L190)*
*__description__*: Attach an eventemitter handler to listen to a specific event
@@ -346,7 +346,7 @@ ___
▸ **create**(options?: * [ApiOptions](../interfaces/_base_.apioptions.md) &#124; `WsProvider`*): `Promise`<[ApiPromise](_promise_index_.apipromise.md)>
*Defined in [promise/index.ts:126](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/promise/index.ts#L126)*
*Defined in [promise/index.ts:126](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/promise/index.ts#L126)*
*__description__*: Creates an ApiPromise instance using the supplied provider. Returns an Promise containing the actual Api instance.
docs/api/classes/_promise_submittableextrinsic_.submittableextrinsic.md
+29 -23
View File
@@ -25,7 +25,7 @@
*Overrides Extrinsic.__constructor*
*Defined in [promise/SubmittableExtrinsic.ts:12](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/promise/SubmittableExtrinsic.ts#L12)*
*Defined in [promise/SubmittableExtrinsic.ts:12](https://github.com/polkadot-js/api/blob/6cab9be/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:125](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L125)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:129](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L129)*
**Returns:** `E`
@@ -86,7 +86,7 @@ getargs(): `Array`<`Codec`>
*Inherited from Extrinsic.args*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:65](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Extrinsic.ts#L65)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:67](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Extrinsic.ts#L67)*
**Returns:** `Array`<`Codec`>
@@ -99,7 +99,7 @@ getcallIndex(): `Uint8Array`
*Inherited from Extrinsic.callIndex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:70](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Extrinsic.ts#L70)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:72](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Extrinsic.ts#L72)*
**Returns:** `Uint8Array`
@@ -112,7 +112,7 @@ getdata(): `Uint8Array`
*Inherited from Extrinsic.data*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:74](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Extrinsic.ts#L74)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:76](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Extrinsic.ts#L76)*
**Returns:** `Uint8Array`
@@ -127,7 +127,7 @@ getencodedLength(): `number`
*Overrides Struct.encodedLength*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:105](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Extrinsic.ts#L105)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:80](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Extrinsic.ts#L80)*
**Returns:** `number`
@@ -140,7 +140,7 @@ gethash(): `Hash`
*Inherited from Extrinsic.hash*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:79](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Extrinsic.ts#L79)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:87](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Extrinsic.ts#L87)*
**Returns:** `Hash`
@@ -153,7 +153,7 @@ getisSigned(): `boolean`
*Inherited from Extrinsic.isSigned*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:85](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Extrinsic.ts#L85)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:93](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Extrinsic.ts#L93)*
**Returns:** `boolean`
@@ -166,7 +166,7 @@ getlength(): `number`
*Inherited from Extrinsic.length*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:89](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Extrinsic.ts#L89)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:97](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Extrinsic.ts#L97)*
**Returns:** `number`
@@ -179,7 +179,7 @@ getmeta(): `FunctionMetadata`
*Inherited from Extrinsic.meta*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:93](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Extrinsic.ts#L93)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:101](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Extrinsic.ts#L101)*
**Returns:** `FunctionMetadata`
@@ -192,7 +192,7 @@ getmethod(): `Method`
*Inherited from Extrinsic.method*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:97](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Extrinsic.ts#L97)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:105](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Extrinsic.ts#L105)*
**Returns:** `Method`
@@ -205,7 +205,7 @@ getsignature(): `ExtrinsicSignature`
*Inherited from Extrinsic.signature*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:101](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Extrinsic.ts#L101)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:109](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Extrinsic.ts#L109)*
**Returns:** `ExtrinsicSignature`
@@ -236,7 +236,7 @@ ___
*Inherited from Extrinsic.addSignature*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:111](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Extrinsic.ts#L111)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:113](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Extrinsic.ts#L113)*
**Parameters:**
@@ -344,7 +344,9 @@ ___
*Inherited from Struct.getAtIndex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:135](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L135)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L145)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
**Parameters:**
@@ -395,7 +397,7 @@ ___
▸ **send**(statusCb?: * `undefined` &#124; `function`*): `Promise`<`Hash`>
*Defined in [promise/SubmittableExtrinsic.ts:20](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/promise/SubmittableExtrinsic.ts#L20)*
*Defined in [promise/SubmittableExtrinsic.ts:20](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/promise/SubmittableExtrinsic.ts#L20)*
**Parameters:**
@@ -434,7 +436,7 @@ ___
*Overrides Extrinsic.sign*
*Defined in [promise/SubmittableExtrinsic.ts:28](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/promise/SubmittableExtrinsic.ts#L28)*
*Defined in [promise/SubmittableExtrinsic.ts:28](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/promise/SubmittableExtrinsic.ts#L28)*
**Parameters:**
@@ -455,7 +457,9 @@ ___
*Inherited from Struct.toArray*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:139](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L139)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:152](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L152)*
*__description__*: Converts the Object to an standard JavaScript Array
**Returns:** `Array`<`Codec`>
@@ -470,7 +474,7 @@ ___
*Overrides Struct.toHex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:131](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Extrinsic.ts#L131)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:125](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Extrinsic.ts#L125)*
**Returns:** `string`
@@ -485,7 +489,7 @@ ___
*Overrides Struct.toJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:135](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Extrinsic.ts#L135)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:129](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Extrinsic.ts#L129)*
**Returns:** `any`
@@ -498,7 +502,9 @@ ___
*Inherited from Struct.toString*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L158)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L180)*
*__description__*: Returns the string representation of the value
**Returns:** `string`
@@ -513,7 +519,7 @@ ___
*Overrides Struct.toU8a*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:123](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Extrinsic.ts#L123)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:133](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Extrinsic.ts#L133)*
**Parameters:**
@@ -547,7 +553,7 @@ ___
*Inherited from Extrinsic.decodeExtrinsic*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:42](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Extrinsic.ts#L42)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:44](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Extrinsic.ts#L44)*
**Parameters:**
@@ -566,7 +572,7 @@ ___
*Inherited from Struct.with*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:108](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L108)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L112)*
**Type parameters:**
docs/api/classes/_rx_index_.apirx.html
+25 -12
View File
@@ -198,6 +198,19 @@
</li>
<li class="chapter " data-level="1.4" data-path="../../types/">
<a href="../../types/">
types (codec implementation)
</a>
</li>
@@ -493,7 +506,7 @@
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new ApiRx</strong>(options?: <em> <a href="../interfaces/_base_.apioptions.md">ApiOptions</a> | <code>WsProvider</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/82dcbe5/packages/api/src/rx/index.ts#L143" target="_blank">rx/index.ts:143</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/rx/index.ts#L143" target="_blank">rx/index.ts:143</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>
@@ -530,21 +543,21 @@
<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/82dcbe5/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/6cab9be/packages/api/src/Base.ts#L88" target="_blank">Base.ts:88</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>
<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/82dcbe5/packages/api/src/rx/index.ts#L184" target="_blank">rx/index.ts:184</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/rx/index.ts#L184" target="_blank">rx/index.ts:184</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/82dcbe5/packages/api/src/rx/index.ts#L191" target="_blank">rx/index.ts:191</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/rx/index.ts#L191" target="_blank">rx/index.ts:191</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>
@@ -552,7 +565,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/82dcbe5/packages/api/src/Base.ts#L126" target="_blank">Base.ts:126</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/Base.ts#L126" target="_blank">Base.ts:126</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>
@@ -566,7 +579,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/82dcbe5/packages/api/src/Base.ts#L146" target="_blank">Base.ts:146</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/Base.ts#L146" target="_blank">Base.ts:146</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>
@@ -580,7 +593,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/82dcbe5/packages/api/src/Base.ts#L97" target="_blank">Base.ts:97</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/Base.ts#L97" target="_blank">Base.ts:97</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>
@@ -588,7 +601,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/82dcbe5/packages/api/src/Base.ts#L106" target="_blank">Base.ts:106</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/Base.ts#L106" target="_blank">Base.ts:106</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>
@@ -596,7 +609,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/82dcbe5/packages/api/src/Base.ts#L165" target="_blank">Base.ts:165</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/Base.ts#L165" target="_blank">Base.ts:165</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>
@@ -613,7 +626,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/82dcbe5/packages/api/src/Base.ts#L190" target="_blank">Base.ts:190</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/Base.ts#L190" target="_blank">Base.ts:190</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>
@@ -651,7 +664,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/_base_.apioptions.md">ApiOptions</a> | <code>WsProvider</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/82dcbe5/packages/api/src/rx/index.ts#L141" target="_blank">rx/index.ts:141</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/rx/index.ts#L141" target="_blank">rx/index.ts:141</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>
@@ -726,7 +739,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-11-30T14:57:32.589Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-30T14:58:57.607Z"},"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-03T10:26:35.137Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-03T10:28:05.942Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/api/classes/_rx_index_.apirx.md
+11 -11
View File
@@ -117,7 +117,7 @@ api.query.system
*Overrides [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
*Defined in [rx/index.ts:143](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/rx/index.ts#L143)*
*Defined in [rx/index.ts:143](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/rx/index.ts#L143)*
*__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:88](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/Base.ts#L88)*
*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/Base.ts#L88)*
*__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.
@@ -166,7 +166,7 @@ ___
getisConnected(): `Observable`<`boolean`>
*Defined in [rx/index.ts:184](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/rx/index.ts#L184)*
*Defined in [rx/index.ts:184](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/rx/index.ts#L184)*
*__description__*: Observable that carries the connected state for the provider. Results in a boolean flag that is true/false based on the connectivity.
@@ -179,7 +179,7 @@ ___
getisReady(): `Observable`<[ApiRx](_rx_index_.apirx.md)>
*Defined in [rx/index.ts:191](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/rx/index.ts#L191)*
*Defined in [rx/index.ts:191](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/rx/index.ts#L191)*
*__description__*: Observable that returns the first time we are connected and loaded
@@ -194,7 +194,7 @@ getquery(): [QueryableStorage](../interfaces/_rx_types_.queryablestorage.md)
*Inherited from [ApiBase](_base_.apibase.md).[query](_base_.apibase.md#query)*
*Defined in [Base.ts:126](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/Base.ts#L126)*
*Defined in [Base.ts:126](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/Base.ts#L126)*
*__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.
@@ -219,7 +219,7 @@ getrpc(): `RpcRx`
*Inherited from [ApiBase](_base_.apibase.md).[rpc](_base_.apibase.md#rpc)*
*Defined in [Base.ts:146](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/Base.ts#L146)*
*Defined in [Base.ts:146](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/Base.ts#L146)*
*__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.
@@ -244,7 +244,7 @@ getruntimeMetadata(): `RuntimeMetadata`
*Inherited from [ApiBase](_base_.apibase.md).[runtimeMetadata](_base_.apibase.md#runtimemetadata)*
*Defined in [Base.ts:97](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/Base.ts#L97)*
*Defined in [Base.ts:97](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/Base.ts#L97)*
*__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.
@@ -259,7 +259,7 @@ getruntimeVersion(): `RuntimeVersion`
*Inherited from [ApiBase](_base_.apibase.md).[runtimeVersion](_base_.apibase.md#runtimeversion)*
*Defined in [Base.ts:106](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/Base.ts#L106)*
*Defined in [Base.ts:106](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/Base.ts#L106)*
*__description__*: Contains the version information for the current runtime.
@@ -274,7 +274,7 @@ gettx(): [SubmittableExtrinsics](../interfaces/_rx_types_.submittableextrinsics.
*Inherited from [ApiBase](_base_.apibase.md).[tx](_base_.apibase.md#tx)*
*Defined in [Base.ts:165](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/Base.ts#L165)*
*Defined in [Base.ts:165](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/Base.ts#L165)*
*__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.
@@ -303,7 +303,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[on](_base_.apibase.md#on)*
*Defined in [Base.ts:190](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/Base.ts#L190)*
*Defined in [Base.ts:190](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/Base.ts#L190)*
*__description__*: Attach an eventemitter handler to listen to a specific event
@@ -335,7 +335,7 @@ ___
▸ **create**(options?: * [ApiOptions](../interfaces/_base_.apioptions.md) &#124; `WsProvider`*): `Observable`<[ApiRx](_rx_index_.apirx.md)>
*Defined in [rx/index.ts:141](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/rx/index.ts#L141)*
*Defined in [rx/index.ts:141](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/rx/index.ts#L141)*
*__description__*: Creates an ApiRx instance using the supplied provider. Returns an Observable containing the actual Api instance.
docs/api/classes/_rx_submittableextrinsic_.submittableextrinsic.md
+29 -23
View File
@@ -25,7 +25,7 @@
*Overrides Extrinsic.__constructor*
*Defined in [rx/SubmittableExtrinsic.ts:13](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/rx/SubmittableExtrinsic.ts#L13)*
*Defined in [rx/SubmittableExtrinsic.ts:13](https://github.com/polkadot-js/api/blob/6cab9be/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:125](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L125)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:129](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L129)*
**Returns:** `E`
@@ -86,7 +86,7 @@ getargs(): `Array`<`Codec`>
*Inherited from Extrinsic.args*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:65](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Extrinsic.ts#L65)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:67](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Extrinsic.ts#L67)*
**Returns:** `Array`<`Codec`>
@@ -99,7 +99,7 @@ getcallIndex(): `Uint8Array`
*Inherited from Extrinsic.callIndex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:70](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Extrinsic.ts#L70)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:72](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Extrinsic.ts#L72)*
**Returns:** `Uint8Array`
@@ -112,7 +112,7 @@ getdata(): `Uint8Array`
*Inherited from Extrinsic.data*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:74](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Extrinsic.ts#L74)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:76](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Extrinsic.ts#L76)*
**Returns:** `Uint8Array`
@@ -127,7 +127,7 @@ getencodedLength(): `number`
*Overrides Struct.encodedLength*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:105](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Extrinsic.ts#L105)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:80](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Extrinsic.ts#L80)*
**Returns:** `number`
@@ -140,7 +140,7 @@ gethash(): `Hash`
*Inherited from Extrinsic.hash*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:79](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Extrinsic.ts#L79)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:87](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Extrinsic.ts#L87)*
**Returns:** `Hash`
@@ -153,7 +153,7 @@ getisSigned(): `boolean`
*Inherited from Extrinsic.isSigned*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:85](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Extrinsic.ts#L85)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:93](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Extrinsic.ts#L93)*
**Returns:** `boolean`
@@ -166,7 +166,7 @@ getlength(): `number`
*Inherited from Extrinsic.length*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:89](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Extrinsic.ts#L89)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:97](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Extrinsic.ts#L97)*
**Returns:** `number`
@@ -179,7 +179,7 @@ getmeta(): `FunctionMetadata`
*Inherited from Extrinsic.meta*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:93](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Extrinsic.ts#L93)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:101](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Extrinsic.ts#L101)*
**Returns:** `FunctionMetadata`
@@ -192,7 +192,7 @@ getmethod(): `Method`
*Inherited from Extrinsic.method*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:97](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Extrinsic.ts#L97)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:105](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Extrinsic.ts#L105)*
**Returns:** `Method`
@@ -205,7 +205,7 @@ getsignature(): `ExtrinsicSignature`
*Inherited from Extrinsic.signature*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:101](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Extrinsic.ts#L101)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:109](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Extrinsic.ts#L109)*
**Returns:** `ExtrinsicSignature`
@@ -236,7 +236,7 @@ ___
*Inherited from Extrinsic.addSignature*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:111](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Extrinsic.ts#L111)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:113](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Extrinsic.ts#L113)*
**Parameters:**
@@ -344,7 +344,9 @@ ___
*Inherited from Struct.getAtIndex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:135](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L135)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L145)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
**Parameters:**
@@ -395,7 +397,7 @@ ___
▸ **send**(): `Observable`<`ExtrinsicStatus`>
*Defined in [rx/SubmittableExtrinsic.ts:21](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/rx/SubmittableExtrinsic.ts#L21)*
*Defined in [rx/SubmittableExtrinsic.ts:21](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/rx/SubmittableExtrinsic.ts#L21)*
**Returns:** `Observable`<`ExtrinsicStatus`>
@@ -428,7 +430,7 @@ ___
*Overrides Extrinsic.sign*
*Defined in [rx/SubmittableExtrinsic.ts:25](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/rx/SubmittableExtrinsic.ts#L25)*
*Defined in [rx/SubmittableExtrinsic.ts:25](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/rx/SubmittableExtrinsic.ts#L25)*
**Parameters:**
@@ -449,7 +451,9 @@ ___
*Inherited from Struct.toArray*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:139](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L139)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:152](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L152)*
*__description__*: Converts the Object to an standard JavaScript Array
**Returns:** `Array`<`Codec`>
@@ -464,7 +468,7 @@ ___
*Overrides Struct.toHex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:131](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Extrinsic.ts#L131)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:125](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Extrinsic.ts#L125)*
**Returns:** `string`
@@ -479,7 +483,7 @@ ___
*Overrides Struct.toJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:135](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Extrinsic.ts#L135)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:129](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Extrinsic.ts#L129)*
**Returns:** `any`
@@ -492,7 +496,9 @@ ___
*Inherited from Struct.toString*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L158)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L180)*
*__description__*: Returns the string representation of the value
**Returns:** `string`
@@ -507,7 +513,7 @@ ___
*Overrides Struct.toU8a*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:123](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Extrinsic.ts#L123)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:133](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Extrinsic.ts#L133)*
**Parameters:**
@@ -541,7 +547,7 @@ ___
*Inherited from Extrinsic.decodeExtrinsic*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:42](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Extrinsic.ts#L42)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:44](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Extrinsic.ts#L44)*
**Parameters:**
@@ -560,7 +566,7 @@ ___
*Inherited from Struct.with*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:108](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L108)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L112)*
**Type parameters:**
docs/api/index.html
+14 -1
View File
@@ -198,6 +198,19 @@
</li>
<li class="chapter " data-level="1.4" data-path="../types/">
<a href="../types/">
types (codec implementation)
</a>
</li>
@@ -508,7 +521,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-11-30T14:57:32.065Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-30T14:58:57.607Z"},"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-03T10:26:34.541Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-03T10:28:05.942Z"},"basePath":"..","book":{"language":""}});
});
</script>
</div>
docs/api/interfaces/_base_.apioptions.md
+2 -2
View File
@@ -13,7 +13,7 @@
**● additionalTypes**: * `undefined` &#124; `object`
*
*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/Base.ts#L42)*
*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/Base.ts#L42)*
Additional types used by runtime modules. This is nessusary if the runtime modules uses non-buildin types.
@@ -24,7 +24,7 @@ ___
**● wsProvider**: *`WsProvider`*
*Defined in [Base.ts:38](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/Base.ts#L38)*
*Defined in [Base.ts:38](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/Base.ts#L38)*
WebSocket provider from rpc-provider/ws. If not specified, it will default to connecting to the localhost with the default port, i.e. `ws://127.0.0.1:9944`
docs/api/interfaces/_promise_types_.apipromiseinterface.md
+8 -8
View File
@@ -20,7 +20,7 @@
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[genesisHash](_types_.apibaseinterface.md#genesishash)*
*Defined in [types.ts:12](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/types.ts#L12)*
*Defined in [types.ts:12](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/types.ts#L12)*
___
<a id="isready"></a>
@@ -29,7 +29,7 @@ ___
**● isReady**: *`Promise`<[ApiPromiseInterface](_promise_types_.apipromiseinterface.md)>*
*Defined in [promise/types.ts:39](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/promise/types.ts#L39)*
*Defined in [promise/types.ts:39](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/promise/types.ts#L39)*
___
<a id="on"></a>
@@ -40,7 +40,7 @@ ___
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[on](_types_.apibaseinterface.md#on)*
*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/types.ts#L19)*
*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/types.ts#L19)*
#### Type declaration
▸(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `void`
@@ -63,7 +63,7 @@ ___
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[query](_types_.apibaseinterface.md#query)*
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/types.ts#L15)*
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/types.ts#L15)*
___
<a id="rpc"></a>
@@ -74,7 +74,7 @@ ___
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[rpc](_types_.apibaseinterface.md#rpc)*
*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/types.ts#L16)*
*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/types.ts#L16)*
___
<a id="runtimemetadata"></a>
@@ -85,7 +85,7 @@ ___
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[runtimeMetadata](_types_.apibaseinterface.md#runtimemetadata)*
*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/types.ts#L13)*
*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/types.ts#L13)*
___
<a id="runtimeversion"></a>
@@ -96,7 +96,7 @@ ___
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[runtimeVersion](_types_.apibaseinterface.md#runtimeversion)*
*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/types.ts#L14)*
*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/types.ts#L14)*
___
<a id="tx"></a>
@@ -107,7 +107,7 @@ ___
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[tx](_types_.apibaseinterface.md#tx)*
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/types.ts#L17)*
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/types.ts#L17)*
___
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/82dcbe5/packages/api/src/promise/types.ts#L14)*
*Defined in [promise/types.ts:14](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/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/6cab9be/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/82dcbe5/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/6cab9be/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/82dcbe5/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/6cab9be/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/82dcbe5/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/6cab9be/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/82dcbe5/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/6cab9be/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/82dcbe5/packages/api/src/promise/types.ts#L26)*
*Defined in [promise/types.ts:26](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/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/6cab9be/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/82dcbe5/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/6cab9be/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/82dcbe5/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/6cab9be/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/82dcbe5/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/6cab9be/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/82dcbe5/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/6cab9be/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/82dcbe5/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/6cab9be/packages/types/src/Method.ts#L40)*
#### Type declaration
▸(): `any`
docs/api/interfaces/_rx_types_.apirxinterface.md
+9 -9
View File
@@ -20,7 +20,7 @@
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[genesisHash](_types_.apibaseinterface.md#genesishash)*
*Defined in [types.ts:12](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/types.ts#L12)*
*Defined in [types.ts:12](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/types.ts#L12)*
___
<a id="isconnected"></a>
@@ -29,7 +29,7 @@ ___
**● isConnected**: *`Observable`<`boolean`>*
*Defined in [rx/types.ts:40](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/rx/types.ts#L40)*
*Defined in [rx/types.ts:40](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/rx/types.ts#L40)*
___
<a id="isready"></a>
@@ -38,7 +38,7 @@ ___
**● isReady**: *`Observable`<[ApiRxInterface](_rx_types_.apirxinterface.md)>*
*Defined in [rx/types.ts:41](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/rx/types.ts#L41)*
*Defined in [rx/types.ts:41](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/rx/types.ts#L41)*
___
<a id="on"></a>
@@ -49,7 +49,7 @@ ___
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[on](_types_.apibaseinterface.md#on)*
*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/types.ts#L19)*
*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/types.ts#L19)*
#### Type declaration
▸(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `void`
@@ -72,7 +72,7 @@ ___
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[query](_types_.apibaseinterface.md#query)*
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/types.ts#L15)*
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/types.ts#L15)*
___
<a id="rpc"></a>
@@ -83,7 +83,7 @@ ___
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[rpc](_types_.apibaseinterface.md#rpc)*
*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/types.ts#L16)*
*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/types.ts#L16)*
___
<a id="runtimemetadata"></a>
@@ -94,7 +94,7 @@ ___
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[runtimeMetadata](_types_.apibaseinterface.md#runtimemetadata)*
*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/types.ts#L13)*
*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/types.ts#L13)*
___
<a id="runtimeversion"></a>
@@ -105,7 +105,7 @@ ___
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[runtimeVersion](_types_.apibaseinterface.md#runtimeversion)*
*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/types.ts#L14)*
*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/types.ts#L14)*
___
<a id="tx"></a>
@@ -116,7 +116,7 @@ ___
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[tx](_types_.apibaseinterface.md#tx)*
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/types.ts#L17)*
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/types.ts#L17)*
___
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/82dcbe5/packages/api/src/rx/types.ts#L15)*
*Defined in [rx/types.ts:15](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/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/6cab9be/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/82dcbe5/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/6cab9be/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/82dcbe5/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/6cab9be/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/82dcbe5/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/6cab9be/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/82dcbe5/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/6cab9be/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/82dcbe5/packages/api/src/rx/types.ts#L27)*
*Defined in [rx/types.ts:27](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/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/6cab9be/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/82dcbe5/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/6cab9be/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/82dcbe5/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/6cab9be/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/82dcbe5/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/6cab9be/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/82dcbe5/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/6cab9be/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/82dcbe5/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/6cab9be/packages/types/src/Method.ts#L40)*
#### Type declaration
▸(): `any`
docs/api/interfaces/_types_.apibaseinterface.md
+7 -7
View File
@@ -26,7 +26,7 @@
**● genesisHash**: *`Hash`*
*Defined in [types.ts:12](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/types.ts#L12)*
*Defined in [types.ts:12](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/types.ts#L12)*
___
<a id="on"></a>
@@ -35,7 +35,7 @@ ___
**● on**: *`function`*
*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/types.ts#L19)*
*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/types.ts#L19)*
#### Type declaration
▸(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `void`
@@ -56,7 +56,7 @@ ___
**● query**: *`S`*
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/types.ts#L15)*
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/types.ts#L15)*
___
<a id="rpc"></a>
@@ -65,7 +65,7 @@ ___
**● rpc**: *`R`*
*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/types.ts#L16)*
*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/types.ts#L16)*
___
<a id="runtimemetadata"></a>
@@ -74,7 +74,7 @@ ___
**● runtimeMetadata**: *`RuntimeMetadata`*
*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/types.ts#L13)*
*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/types.ts#L13)*
___
<a id="runtimeversion"></a>
@@ -83,7 +83,7 @@ ___
**● runtimeVersion**: *`RuntimeVersion`*
*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/types.ts#L14)*
*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/types.ts#L14)*
___
<a id="tx"></a>
@@ -92,7 +92,7 @@ ___
**● tx**: *`E`*
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/types.ts#L17)*
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/types.ts#L17)*
___
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/82dcbe5/packages/api/src/promise/Combinator.ts#L7)*
*Defined in [promise/Combinator.ts:7](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/api/src/promise/Combinator.ts#L8)*
*Defined in [promise/Combinator.ts:8](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/promise/Combinator.ts#L8)*
#### Type declaration
▸(cb: *`function`*): `any`
docs/api/modules/_types_.md
+1 -1
View File
@@ -21,7 +21,7 @@
**Ƭ ApiInterface$Events**: * `RpcRxInterface$Events` &#124; "ready"
*
*Defined in [types.ts:9](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api/src/types.ts#L9)*
*Defined in [types.ts:9](https://github.com/polkadot-js/api/blob/6cab9be/packages/api/src/types.ts#L9)*
___
docs/examples/promise/01_simple_connect/index.html
+14 -1
View File
@@ -198,6 +198,19 @@
</li>
<li class="chapter " data-level="1.4" data-path="../../../types/">
<a href="../../../types/">
types (codec implementation)
</a>
</li>
@@ -474,7 +487,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-11-30T14:55:08.116Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-30T14:58:57.607Z"},"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-03T10:24:06.800Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-03T10:28:05.942Z"},"basePath":"../../..","book":{"language":""}});
});
</script>
</div>
docs/examples/promise/02_listen_to_blocks/index.html
+14 -1
View File
@@ -198,6 +198,19 @@
</li>
<li class="chapter " data-level="1.4" data-path="../../../types/">
<a href="../../../types/">
types (codec implementation)
</a>
</li>
@@ -476,7 +489,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-11-30T14:55:08.116Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-30T14:58:57.607Z"},"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-03T10:24:06.800Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-03T10:28:05.942Z"},"basePath":"../../..","book":{"language":""}});
});
</script>
</div>
docs/examples/promise/03_listen_to_balance_change/index.html
+14 -1
View File
@@ -198,6 +198,19 @@
</li>
<li class="chapter " data-level="1.4" data-path="../../../types/">
<a href="../../../types/">
types (codec implementation)
</a>
</li>
@@ -487,7 +500,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-11-30T14:55:08.116Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-30T14:58:57.607Z"},"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-03T10:24:06.800Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-03T10:28:05.942Z"},"basePath":"../../..","book":{"language":""}});
});
</script>
</div>
docs/examples/promise/05_read_storage/index.html
+14 -1
View File
@@ -198,6 +198,19 @@
</li>
<li class="chapter " data-level="1.4" data-path="../../../types/">
<a href="../../../types/">
types (codec implementation)
</a>
</li>
@@ -486,7 +499,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-11-30T14:55:08.116Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-30T14:58:57.607Z"},"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-03T10:24:06.800Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-03T10:28:05.942Z"},"basePath":"../../..","book":{"language":""}});
});
</script>
</div>
docs/examples/promise/07_transfer_dots/index.html
+14 -1
View File
@@ -198,6 +198,19 @@
</li>
<li class="chapter " data-level="1.4" data-path="../../../types/">
<a href="../../../types/">
types (codec implementation)
</a>
</li>
@@ -488,7 +501,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-11-30T14:55:08.116Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-30T14:58:57.607Z"},"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-03T10:24:06.800Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-03T10:28:05.942Z"},"basePath":"../../..","book":{"language":""}});
});
</script>
</div>
docs/examples/promise/08_system_events/index.html
+14 -1
View File
@@ -196,6 +196,19 @@
</li>
<li class="chapter " data-level="1.4" data-path="../../../types/">
<a href="../../../types/">
types (codec implementation)
</a>
</li>
@@ -479,7 +492,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Display system events","level":"3.1.6","depth":2,"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-11-30T14:55:08.116Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-30T14:58:57.607Z"},"basePath":"../../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"Display system events","level":"3.1.6","depth":2,"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-03T10:24:06.800Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-03T10:28:05.942Z"},"basePath":"../../..","book":{"language":""}});
});
</script>
</div>
docs/examples/promise/index.html
+14 -1
View File
@@ -198,6 +198,19 @@
</li>
<li class="chapter " data-level="1.4" data-path="../../types/">
<a href="../../types/">
types (codec implementation)
</a>
</li>
@@ -464,7 +477,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-11-30T14:55:08.116Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-30T14:58:57.607Z"},"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-03T10:24:06.800Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-03T10:28:05.942Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/index.html
+15 -1
View File
@@ -196,6 +196,19 @@
</li>
<li class="chapter " data-level="1.4" data-path="types/">
<a href="types/">
types (codec implementation)
</a>
</li>
@@ -418,6 +431,7 @@
<li><a href="rpc-provider/classes/_ws_index_.wsprovider.html">WsProvider</a></li>
</ul>
</li>
<li><a href="types/">types (codec implementation)</a></li>
</ul>
<h2 id="interfaces">Interfaces</h2>
<ul>
@@ -489,7 +503,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-11-30T14:55:08.108Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-30T14:58:57.607Z"},"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-03T10:24:06.792Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-03T10:28:05.942Z"},"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:44](https://github.com/polkadot-js/api/blob/82dcbe5/packages/rpc-core/src/index.ts#L44)*
*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/6cab9be/packages/rpc-core/src/index.ts#L44)*
*__constructor__*: Default constructor for the Api Object
@@ -60,7 +60,7 @@ ___
**● _provider**: *`ProviderInterface`*
*Defined in [index.ts:40](https://github.com/polkadot-js/api/blob/82dcbe5/packages/rpc-core/src/index.ts#L40)*
*Defined in [index.ts:40](https://github.com/polkadot-js/api/blob/6cab9be/packages/rpc-core/src/index.ts#L40)*
___
<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:41](https://github.com/polkadot-js/api/blob/82dcbe5/packages/rpc-core/src/index.ts#L41)*
*Defined in [index.ts:41](https://github.com/polkadot-js/api/blob/6cab9be/packages/rpc-core/src/index.ts#L41)*
___
<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:42](https://github.com/polkadot-js/api/blob/82dcbe5/packages/rpc-core/src/index.ts#L42)*
*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/6cab9be/packages/rpc-core/src/index.ts#L42)*
___
<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:43](https://github.com/polkadot-js/api/blob/82dcbe5/packages/rpc-core/src/index.ts#L43)*
*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/6cab9be/packages/rpc-core/src/index.ts#L43)*
___
<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:44](https://github.com/polkadot-js/api/blob/82dcbe5/packages/rpc-core/src/index.ts#L44)*
*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/6cab9be/packages/rpc-core/src/index.ts#L44)*
___
@@ -116,7 +116,7 @@ ___
▸ **signature**(__namedParameters: *`object`*): `string`
*Defined in [index.ts:77](https://github.com/polkadot-js/api/blob/82dcbe5/packages/rpc-core/src/index.ts#L77)*
*Defined in [index.ts:77](https://github.com/polkadot-js/api/blob/6cab9be/packages/rpc-core/src/index.ts#L77)*
*__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/82dcbe5/packages/rpc-core/src/types.ts#L17)*
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/rpc-core/src/types.ts#L18)*
*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/rpc-core/src/types.ts#L19)*
*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/rpc-core/src/types.ts#L20)*
*Defined in [types.ts:20](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/rpc-core/src/types.ts#L5)*
*Defined in [types.ts:5](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/rpc-core/src/types.ts#L8)*
*Defined in [types.ts:8](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/rpc-core/src/types.ts#L9)*
*Defined in [types.ts:9](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/rpc-core/src/types.ts#L12)*
*Defined in [types.ts:12](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/rpc-provider/src/coder/index.ts#L12)*
*Defined in [coder/index.ts:12](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/rpc-provider/src/coder/index.ts#L33)*
*Defined in [coder/index.ts:33](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/rpc-provider/src/coder/index.ts#L39)*
*Defined in [coder/index.ts:39](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/rpc-provider/src/coder/index.ts#L48)*
*Defined in [coder/index.ts:48](https://github.com/polkadot-js/api/blob/6cab9be/packages/rpc-provider/src/coder/index.ts#L48)*
**Returns:** `number`
docs/rpc-provider/classes/_http_index_.httpprovider.html
+20 -7
View File
@@ -198,6 +198,19 @@
</li>
<li class="chapter " data-level="1.4" data-path="../../types/">
<a href="../../types/">
types (codec implementation)
</a>
</li>
@@ -427,7 +440,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/82dcbe5/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/6cab9be/packages/rpc-provider/src/http/index.ts#L40" target="_blank">http/index.ts:40</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -454,7 +467,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/82dcbe5/packages/rpc-provider/src/http/index.ts#L56" target="_blank">http/index.ts:56</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/6cab9be/packages/rpc-provider/src/http/index.ts#L56" target="_blank">http/index.ts:56</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>
@@ -463,7 +476,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/82dcbe5/packages/rpc-provider/src/http/index.ts#L64" target="_blank">http/index.ts:64</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/6cab9be/packages/rpc-provider/src/http/index.ts#L64" target="_blank">http/index.ts:64</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>
@@ -491,7 +504,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/82dcbe5/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/6cab9be/packages/rpc-provider/src/http/index.ts#L71" target="_blank">http/index.ts:71</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>
@@ -518,7 +531,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/82dcbe5/packages/rpc-provider/src/http/index.ts#L93" target="_blank">http/index.ts:93</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/6cab9be/packages/rpc-provider/src/http/index.ts#L93" target="_blank">http/index.ts:93</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>
@@ -553,7 +566,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/82dcbe5/packages/rpc-provider/src/http/index.ts#L102" target="_blank">http/index.ts:102</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/6cab9be/packages/rpc-provider/src/http/index.ts#L102" target="_blank">http/index.ts:102</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>
@@ -623,7 +636,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-11-30T14:57:50.225Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-30T14:58:57.607Z"},"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-03T10:26:53.229Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-03T10:28:05.942Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/rpc-provider/classes/_http_index_.httpprovider.md
+6 -6
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/82dcbe5/packages/rpc-provider/src/http/index.ts#L40)*
*Defined in [http/index.ts:40](https://github.com/polkadot-js/api/blob/6cab9be/packages/rpc-provider/src/http/index.ts#L40)*
**Parameters:**
@@ -56,7 +56,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[isConnected](../interfaces/_types_.providerinterface.md#isconnected)*
*Defined in [http/index.ts:56](https://github.com/polkadot-js/api/blob/82dcbe5/packages/rpc-provider/src/http/index.ts#L56)*
*Defined in [http/index.ts:56](https://github.com/polkadot-js/api/blob/6cab9be/packages/rpc-provider/src/http/index.ts#L56)*
*__summary__*: Whether the node is connected or not.
@@ -72,7 +72,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[on](../interfaces/_types_.providerinterface.md#on)*
*Defined in [http/index.ts:64](https://github.com/polkadot-js/api/blob/82dcbe5/packages/rpc-provider/src/http/index.ts#L64)*
*Defined in [http/index.ts:64](https://github.com/polkadot-js/api/blob/6cab9be/packages/rpc-provider/src/http/index.ts#L64)*
*__summary__*: Events are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md).
@@ -96,7 +96,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[send](../interfaces/_types_.providerinterface.md#send)*
*Defined in [http/index.ts:71](https://github.com/polkadot-js/api/blob/82dcbe5/packages/rpc-provider/src/http/index.ts#L71)*
*Defined in [http/index.ts:71](https://github.com/polkadot-js/api/blob/6cab9be/packages/rpc-provider/src/http/index.ts#L71)*
*__summary__*: Send HTTP POST Request with Body to configured HTTP Endpoint.
@@ -118,7 +118,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[subscribe](../interfaces/_types_.providerinterface.md#subscribe)*
*Defined in [http/index.ts:93](https://github.com/polkadot-js/api/blob/82dcbe5/packages/rpc-provider/src/http/index.ts#L93)*
*Defined in [http/index.ts:93](https://github.com/polkadot-js/api/blob/6cab9be/packages/rpc-provider/src/http/index.ts#L93)*
*__summary__*: Subscriptions are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md).
@@ -142,7 +142,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[unsubscribe](../interfaces/_types_.providerinterface.md#unsubscribe)*
*Defined in [http/index.ts:102](https://github.com/polkadot-js/api/blob/82dcbe5/packages/rpc-provider/src/http/index.ts#L102)*
*Defined in [http/index.ts:102](https://github.com/polkadot-js/api/blob/6cab9be/packages/rpc-provider/src/http/index.ts#L102)*
*__summary__*: Subscriptions are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md).
docs/rpc-provider/classes/_mock_index_.mock.md
+8 -8
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/82dcbe5/packages/rpc-provider/src/mock/index.ts#L64)*
*Defined in [mock/index.ts:64](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/rpc-provider/src/mock/index.ts#L42)*
*Defined in [mock/index.ts:42](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/rpc-provider/src/mock/index.ts#L53)*
*Defined in [mock/index.ts:53](https://github.com/polkadot-js/api/blob/6cab9be/packages/rpc-provider/src/mock/index.ts#L53)*
___
@@ -63,7 +63,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[isConnected](../interfaces/_types_.providerinterface.md#isconnected)*
*Defined in [mock/index.ts:70](https://github.com/polkadot-js/api/blob/82dcbe5/packages/rpc-provider/src/mock/index.ts#L70)*
*Defined in [mock/index.ts:70](https://github.com/polkadot-js/api/blob/6cab9be/packages/rpc-provider/src/mock/index.ts#L70)*
**Returns:** `boolean`
@@ -76,7 +76,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[on](../interfaces/_types_.providerinterface.md#on)*
*Defined in [mock/index.ts:74](https://github.com/polkadot-js/api/blob/82dcbe5/packages/rpc-provider/src/mock/index.ts#L74)*
*Defined in [mock/index.ts:74](https://github.com/polkadot-js/api/blob/6cab9be/packages/rpc-provider/src/mock/index.ts#L74)*
**Parameters:**
@@ -96,7 +96,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[send](../interfaces/_types_.providerinterface.md#send)*
*Defined in [mock/index.ts:78](https://github.com/polkadot-js/api/blob/82dcbe5/packages/rpc-provider/src/mock/index.ts#L78)*
*Defined in [mock/index.ts:78](https://github.com/polkadot-js/api/blob/6cab9be/packages/rpc-provider/src/mock/index.ts#L78)*
**Parameters:**
@@ -114,7 +114,7 @@ ___
▸ **subscribe**(type: *`string`*, method: *`string`*, ...params: *`Array`<`any`>*): `Promise`<`number`>
*Defined in [mock/index.ts:86](https://github.com/polkadot-js/api/blob/82dcbe5/packages/rpc-provider/src/mock/index.ts#L86)*
*Defined in [mock/index.ts:86](https://github.com/polkadot-js/api/blob/6cab9be/packages/rpc-provider/src/mock/index.ts#L86)*
**Parameters:**
@@ -135,7 +135,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[unsubscribe](../interfaces/_types_.providerinterface.md#unsubscribe)*
*Defined in [mock/index.ts:106](https://github.com/polkadot-js/api/blob/82dcbe5/packages/rpc-provider/src/mock/index.ts#L106)*
*Defined in [mock/index.ts:106](https://github.com/polkadot-js/api/blob/6cab9be/packages/rpc-provider/src/mock/index.ts#L106)*
**Parameters:**
docs/rpc-provider/classes/_ws_index_.wsprovider.html
+23 -10
View File
@@ -61,7 +61,7 @@
<link rel="shortcut icon" href="../../gitbook/images/favicon.ico" type="image/x-icon">
<link rel="next" href="../../METHODS_RPC.html" />
<link rel="next" href="../../types/" />
<link rel="prev" href="_http_index_.httpprovider.html" />
@@ -198,6 +198,19 @@
</li>
<li class="chapter " data-level="1.4" data-path="../../types/">
<a href="../../types/">
types (codec implementation)
</a>
</li>
@@ -427,7 +440,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/82dcbe5/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/6cab9be/packages/rpc-provider/src/ws/index.ts#L75" target="_blank">ws/index.ts:75</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -459,7 +472,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/82dcbe5/packages/rpc-provider/src/ws/index.ts#L103" target="_blank">ws/index.ts:103</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/6cab9be/packages/rpc-provider/src/ws/index.ts#L103" target="_blank">ws/index.ts:103</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>
@@ -467,7 +480,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/82dcbe5/packages/rpc-provider/src/ws/index.ts#L120" target="_blank">ws/index.ts:120</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/6cab9be/packages/rpc-provider/src/ws/index.ts#L120" target="_blank">ws/index.ts:120</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>
@@ -475,7 +488,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/82dcbe5/packages/rpc-provider/src/ws/index.ts#L129" target="_blank">ws/index.ts:129</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/6cab9be/packages/rpc-provider/src/ws/index.ts#L129" target="_blank">ws/index.ts:129</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>
@@ -504,7 +517,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/82dcbe5/packages/rpc-provider/src/ws/index.ts#L139" target="_blank">ws/index.ts:139</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/6cab9be/packages/rpc-provider/src/ws/index.ts#L139" target="_blank">ws/index.ts:139</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>
@@ -538,7 +551,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/82dcbe5/packages/rpc-provider/src/ws/index.ts#L195" target="_blank">ws/index.ts:195</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/6cab9be/packages/rpc-provider/src/ws/index.ts#L195" target="_blank">ws/index.ts:195</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>
@@ -589,7 +602,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/82dcbe5/packages/rpc-provider/src/ws/index.ts#L204" target="_blank">ws/index.ts:204</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/6cab9be/packages/rpc-provider/src/ws/index.ts#L204" target="_blank">ws/index.ts:204</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>
@@ -648,7 +661,7 @@ Promise resolving to the dd of the subscription you can use with [[unsubscribe]]
</a>
<a href="../../METHODS_RPC.html" class="navigation navigation-next " aria-label="Next page: RPC">
<a href="../../types/" class="navigation navigation-next " aria-label="Next page: types (codec implementation)">
<i class="fa fa-angle-right"></i>
</a>
@@ -659,7 +672,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":"RPC","level":"2.1","depth":1,"path":"METHODS_RPC.md","ref":"METHODS_RPC.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-11-30T14:57:50.333Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-30T14:58:57.607Z"},"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-03T10:26:53.329Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-03T10:28:05.942Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/rpc-provider/classes/_ws_index_.wsprovider.md
+7 -7
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/82dcbe5/packages/rpc-provider/src/ws/index.ts#L75)*
*Defined in [ws/index.ts:75](https://github.com/polkadot-js/api/blob/6cab9be/packages/rpc-provider/src/ws/index.ts#L75)*
**Parameters:**
@@ -55,7 +55,7 @@ ___
▸ **connect**(): `void`
*Defined in [ws/index.ts:103](https://github.com/polkadot-js/api/blob/82dcbe5/packages/rpc-provider/src/ws/index.ts#L103)*
*Defined in [ws/index.ts:103](https://github.com/polkadot-js/api/blob/6cab9be/packages/rpc-provider/src/ws/index.ts#L103)*
*__summary__*: Manually connect
@@ -70,7 +70,7 @@ ___
▸ **isConnected**(): `boolean`
*Defined in [ws/index.ts:120](https://github.com/polkadot-js/api/blob/82dcbe5/packages/rpc-provider/src/ws/index.ts#L120)*
*Defined in [ws/index.ts:120](https://github.com/polkadot-js/api/blob/6cab9be/packages/rpc-provider/src/ws/index.ts#L120)*
*__summary__*: Whether the node is connected or not.
@@ -84,7 +84,7 @@ ___
▸ **on**(type: *[ProviderInterface$Emitted](../modules/_types_.md#providerinterface_emitted)*, sub: *[ProviderInterface$EmitCb](../modules/_types_.md#providerinterface_emitcb)*): `void`
*Defined in [ws/index.ts:129](https://github.com/polkadot-js/api/blob/82dcbe5/packages/rpc-provider/src/ws/index.ts#L129)*
*Defined in [ws/index.ts:129](https://github.com/polkadot-js/api/blob/6cab9be/packages/rpc-provider/src/ws/index.ts#L129)*
*__summary__*: Listens on events after having subscribed using the [subscribe](_ws_index_.wsprovider.md#subscribe) function.
@@ -104,7 +104,7 @@ ___
▸ **send**(method: *`string`*, params: *`Array`<`any`>*, subscription?: *`SubscriptionHandler`*): `Promise`<`any`>
*Defined in [ws/index.ts:139](https://github.com/polkadot-js/api/blob/82dcbe5/packages/rpc-provider/src/ws/index.ts#L139)*
*Defined in [ws/index.ts:139](https://github.com/polkadot-js/api/blob/6cab9be/packages/rpc-provider/src/ws/index.ts#L139)*
*__summary__*: Send JSON data using WebSockets to configured HTTP Endpoint or queue.
@@ -125,7 +125,7 @@ ___
▸ **subscribe**(type: *`string`*, method: *`string`*, params: *`Array`<`any`>*, callback: *[ProviderInterface$Callback](../modules/_types_.md#providerinterface_callback)*): `Promise`<`number`>
*Defined in [ws/index.ts:195](https://github.com/polkadot-js/api/blob/82dcbe5/packages/rpc-provider/src/ws/index.ts#L195)*
*Defined in [ws/index.ts:195](https://github.com/polkadot-js/api/blob/6cab9be/packages/rpc-provider/src/ws/index.ts#L195)*
*__name__*: subscribe
@@ -163,7 +163,7 @@ ___
▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`>
*Defined in [ws/index.ts:204](https://github.com/polkadot-js/api/blob/82dcbe5/packages/rpc-provider/src/ws/index.ts#L204)*
*Defined in [ws/index.ts:204](https://github.com/polkadot-js/api/blob/6cab9be/packages/rpc-provider/src/ws/index.ts#L204)*
*__summary__*: Allows unsubscribing to subscriptions made with [subscribe](_ws_index_.wsprovider.md#subscribe).
docs/rpc-provider/index.html
+14 -1
View File
@@ -198,6 +198,19 @@
</li>
<li class="chapter " data-level="1.4" data-path="../types/">
<a href="../types/">
types (codec implementation)
</a>
</li>
@@ -475,7 +488,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-11-30T14:57:50.053Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-30T14:58:57.607Z"},"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-03T10:26:53.057Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-03T10:28:05.942Z"},"basePath":"..","book":{"language":""}});
});
</script>
</div>
docs/rpc-provider/interfaces/_types_.providerinterface.md
+5 -5
View File
@@ -17,7 +17,7 @@
▸ **isConnected**(): `boolean`
*Defined in [types.ts:45](https://github.com/polkadot-js/api/blob/82dcbe5/packages/rpc-provider/src/types.ts#L45)*
*Defined in [types.ts:45](https://github.com/polkadot-js/api/blob/6cab9be/packages/rpc-provider/src/types.ts#L45)*
**Returns:** `boolean`
@@ -28,7 +28,7 @@ ___
▸ **on**(type: *[ProviderInterface$Emitted](../modules/_types_.md#providerinterface_emitted)*, sub: *[ProviderInterface$EmitCb](../modules/_types_.md#providerinterface_emitcb)*): `void`
*Defined in [types.ts:46](https://github.com/polkadot-js/api/blob/82dcbe5/packages/rpc-provider/src/types.ts#L46)*
*Defined in [types.ts:46](https://github.com/polkadot-js/api/blob/6cab9be/packages/rpc-provider/src/types.ts#L46)*
**Parameters:**
@@ -46,7 +46,7 @@ ___
▸ **send**(method: *`string`*, params: *`Array`<`any`>*): `Promise`<`any`>
*Defined in [types.ts:47](https://github.com/polkadot-js/api/blob/82dcbe5/packages/rpc-provider/src/types.ts#L47)*
*Defined in [types.ts:47](https://github.com/polkadot-js/api/blob/6cab9be/packages/rpc-provider/src/types.ts#L47)*
**Parameters:**
@@ -64,7 +64,7 @@ ___
▸ **subscribe**(type: *`string`*, method: *`string`*, params: *`Array`<`any`>*, cb: *[ProviderInterface$Callback](../modules/_types_.md#providerinterface_callback)*): `Promise`<`number`>
*Defined in [types.ts:48](https://github.com/polkadot-js/api/blob/82dcbe5/packages/rpc-provider/src/types.ts#L48)*
*Defined in [types.ts:48](https://github.com/polkadot-js/api/blob/6cab9be/packages/rpc-provider/src/types.ts#L48)*
**Parameters:**
@@ -84,7 +84,7 @@ ___
▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`>
*Defined in [types.ts:49](https://github.com/polkadot-js/api/blob/82dcbe5/packages/rpc-provider/src/types.ts#L49)*
*Defined in [types.ts:49](https://github.com/polkadot-js/api/blob/6cab9be/packages/rpc-provider/src/types.ts#L49)*
**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/82dcbe5/packages/rpc-provider/src/http/types.ts#L9)*
*Defined in [http/types.ts:9](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/rpc-provider/src/mock/types.ts#L16)*
*Defined in [mock/types.ts:16](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/rpc-provider/src/mock/types.ts#L20)*
*Defined in [mock/types.ts:20](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/rpc-provider/src/mock/types.ts#L5)*
*Defined in [mock/types.ts:5](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/rpc-provider/src/mock/types.ts#L7)*
*Defined in [mock/types.ts:7](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/rpc-provider/src/types.ts#L5)*
*Defined in [types.ts:5](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/rpc-provider/src/types.ts#L10)*
*Defined in [types.ts:10](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/rpc-provider/src/types.ts#L36)*
*Defined in [types.ts:36](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/rpc-provider/src/types.ts#L34)*
*Defined in [types.ts:34](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/rpc-provider/src/types.ts#L15)*
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/rpc-provider/src/types.ts#L38)*
*Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/rpc-provider/src/types.ts#L42)*
*Defined in [types.ts:42](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/rpc-provider/src/types.ts#L40)*
*Defined in [types.ts:40](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/rpc-rx/src/index.ts#L45)*
*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/rpc-rx/src/index.ts#L42)*
*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/rpc-rx/src/index.ts#L43)*
*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/rpc-rx/src/index.ts#L44)*
*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/rpc-rx/src/index.ts#L45)*
*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/rpc-rx/src/index.ts#L66)*
*Defined in [index.ts:66](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/rpc-rx/src/index.ts#L70)*
*Defined in [index.ts:70](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/rpc-rx/src/types.ts#L15)*
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/rpc-rx/src/types.ts#L13)*
*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/rpc-rx/src/types.ts#L7)*
*Defined in [types.ts:7](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/rpc-rx/src/types.ts#L9)*
*Defined in [types.ts:9](https://github.com/polkadot-js/api/blob/6cab9be/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/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/82dcbe5/packages/type-extrinsics/src/fromMetadata.ts#L21)*
*Defined in [fromMetadata.ts:21](https://github.com/polkadot-js/api/blob/6cab9be/packages/type-extrinsics/src/fromMetadata.ts#L21)*
Extend a storage object with the storage modules & module functions present in the metadata.
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/82dcbe5/packages/type-extrinsics/src/utils/createUnchecked.ts#L16)*
*Defined in [utils/createUnchecked.ts:16](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/type-jsonrpc/src/create/method.ts#L9)*
*Defined in [create/method.ts:9](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/type-jsonrpc/src/create/param.ts#L12)*
*Defined in [create/param.ts:12](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/type-jsonrpc/src/types.ts#L24)*
*Defined in [types.ts:24](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/type-jsonrpc/src/types.ts#L13)*
*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/type-jsonrpc/src/types.ts#L7)*
*Defined in [types.ts:7](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/type-jsonrpc/src/types.ts#L38)*
*Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/6cab9be/packages/type-jsonrpc/src/types.ts#L38)*
#### Type declaration
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/82dcbe5/packages/type-storage/src/types.ts#L17)*
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/type-storage/src/utils/createFunction.ts#L14)*
*Defined in [utils/createFunction.ts:14](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/type-storage/src/utils/createFunction.ts#L15)*
*Defined in [utils/createFunction.ts:15](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/type-storage/src/fromMetadata.ts#L20)*
*Defined in [fromMetadata.ts:20](https://github.com/polkadot-js/api/blob/6cab9be/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/_storage_.md
+2 -2
View File
@@ -8,7 +8,7 @@
**storage**: *`object`*
*Defined in [storage.ts:8](https://github.com/polkadot-js/api/blob/82dcbe5/packages/type-storage/src/storage.ts#L8)*
*Defined in [storage.ts:8](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/type-storage/src/storage.ts#L9)*
*Defined in [storage.ts:9](https://github.com/polkadot-js/api/blob/6cab9be/packages/type-storage/src/storage.ts#L9)*
___
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/82dcbe5/packages/type-storage/src/substrate.ts#L45)*
*Defined in [substrate.ts:45](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/type-storage/src/substrate.ts#L50)*
*Defined in [substrate.ts:50](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/type-storage/src/substrate.ts#L60)*
*Defined in [substrate.ts:60](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/type-storage/src/substrate.ts#L35)*
*Defined in [substrate.ts:35](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/type-storage/src/substrate.ts#L55)*
*Defined in [substrate.ts:55](https://github.com/polkadot-js/api/blob/6cab9be/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/82dcbe5/packages/type-storage/src/substrate.ts#L40)*
*Defined in [substrate.ts:40](https://github.com/polkadot-js/api/blob/6cab9be/packages/type-storage/src/substrate.ts#L40)*
___
docs/type-storage/modules/_utils_createfunction_.md
+1 -1
View File
@@ -20,7 +20,7 @@
▸ **createFunction**(section: *`Text`*, method: *`Text`*, meta: *`StorageFunctionMetadata`*, options?: *[CreateItemOptions](../interfaces/_utils_createfunction_.createitemoptions.md)*): `StorageFunction`
*Defined in [utils/createFunction.ts:28](https://github.com/polkadot-js/api/blob/82dcbe5/packages/type-storage/src/utils/createFunction.ts#L28)*
*Defined in [utils/createFunction.ts:28](https://github.com/polkadot-js/api/blob/6cab9be/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.
docs/types/SUMMARY.md
+12
View File
@@ -28,13 +28,22 @@
* [&quot;Data&quot;](modules/_data_.md)
* [Data](classes/_data_.data.md)
* [&quot;Digest&quot;](modules/_digest_.md)
* [AuthoritiesChange](classes/_digest_.authoritieschange.md)
* [ChangesTrieRoot](classes/_digest_.changestrieroot.md)
* [Digest](classes/_digest_.digest.md)
* [DigestItem](classes/_digest_.digestitem.md)
* [Other](classes/_digest_.other.md)
* [Seal](classes/_digest_.seal.md)
* [&quot;Digest.spec&quot;](modules/_digest_spec_.md)
* [&quot;Event&quot;](modules/_event_.md)
* [Event](classes/_event_.event.md)
* [EventData](classes/_event_.eventdata.md)
* [EventIndex](classes/_event_.eventindex.md)
* [&quot;EventRecord&quot;](modules/_eventrecord_.md)
* [ApplyExtrinsic](classes/_eventrecord_.applyextrinsic.md)
* [EventRecord](classes/_eventrecord_.eventrecord.md)
* [Finalization](classes/_eventrecord_.finalization.md)
* [Phase](classes/_eventrecord_.phase.md)
* [&quot;EventRecord.spec&quot;](modules/_eventrecord_spec_.md)
* [&quot;Extrinsic&quot;](modules/_extrinsic_.md)
* [Extrinsic](classes/_extrinsic_.extrinsic.md)
@@ -135,7 +144,9 @@
* [&quot;ReferendumIndex&quot;](modules/_referendumindex_.md)
* [ReferendumIndex](classes/_referendumindex_.referendumindex.md)
* [&quot;RuntimeVersion&quot;](modules/_runtimeversion_.md)
* [ApiId](classes/_runtimeversion_.apiid.md)
* [RuntimeVersion](classes/_runtimeversion_.runtimeversion.md)
* [RuntimeVersionApi](classes/_runtimeversion_.runtimeversionapi.md)
* [&quot;RuntimeVersion.spec&quot;](modules/_runtimeversion_spec_.md)
* [&quot;SessionKey&quot;](modules/_sessionkey_.md)
* [SessionKey](classes/_sessionkey_.sessionkey.md)
@@ -156,6 +167,7 @@
* [StorageFunction](interfaces/_storagekey_.storagefunction.md)
* [&quot;StorageKey.spec&quot;](modules/_storagekey_spec_.md)
* [&quot;StoredPendingChange&quot;](modules/_storedpendingchange_.md)
* [NextAuthority](classes/_storedpendingchange_.nextauthority.md)
* [StoredPendingChange](classes/_storedpendingchange_.storedpendingchange.md)
* [&quot;Text&quot;](modules/_text_.md)
* [Text](classes/_text_.text.md)
docs/types/classes/_accountid_.accountid.md
+24 -12
View File
@@ -1,5 +1,9 @@
*__name__*: AccountId
*__description__*: A wrapper around an AccountId/PublicKey representation. Since we are dealing with underlying PublicKeys (32 bytes in length), we extend from U8aFixed which is just a Uint8Array wrapper with a fixed length.
# Hierarchy
↳ [U8aFixed](_codec_u8afixed_.u8afixed.md)
@@ -25,7 +29,7 @@
*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)*
*Defined in [AccountId.ts:15](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/AccountId.ts#L15)*
*Defined in [AccountId.ts:19](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/AccountId.ts#L19)*
**Parameters:**
@@ -126,7 +130,9 @@ getencodedLength(): `number`
*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)*
*Defined in [codec/U8a.ts:28](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/U8a.ts#L28)*
*Defined in [codec/U8a.ts:35](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/U8a.ts#L35)*
*__description__*: The length of the value when encoded as a Uint8Array
**Returns:** `number`
@@ -155,7 +161,9 @@ ___
*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)*
*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/U8aFixed.ts#L32)*
*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/U8aFixed.ts#L39)*
*__description__*: Returns the number of bits in the value
**Returns:** `number`
@@ -679,7 +687,7 @@ ___
*Overrides Uint8Array.subarray*
*Defined in [codec/U8a.ts:34](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/U8a.ts#L34)*
*Defined in [codec/U8a.ts:41](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/U8a.ts#L41)*
**Parameters:**
@@ -701,7 +709,9 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:38](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/U8a.ts#L38)*
*Defined in [codec/U8a.ts:48](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/U8a.ts#L48)*
*__description__*: Returns a hex string representation of the value
**Returns:** `string`
@@ -716,7 +726,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
*Defined in [AccountId.ts:39](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/AccountId.ts#L39)*
*Defined in [AccountId.ts:43](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/AccountId.ts#L43)*
**Returns:** `any`
@@ -746,7 +756,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)*
*Defined in [AccountId.ts:43](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/AccountId.ts#L43)*
*Defined in [AccountId.ts:47](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/AccountId.ts#L47)*
**Returns:** `string`
@@ -761,13 +771,15 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
*Defined in [codec/U8a.ts:46](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/U8a.ts#L46)*
*Defined in [codec/U8a.ts:70](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/U8a.ts#L70)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
**Parameters:**
| Name | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
| Name | Type | Description |
| ------ | ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`| true when the value has none of the type-specific prefixes (internal) |
**Returns:** `Uint8Array`
@@ -793,7 +805,7 @@ ___
▸ **encode**(value: *`Uint8Array`*): `string`
*Defined in [AccountId.ts:23](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/AccountId.ts#L23)*
*Defined in [AccountId.ts:27](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/AccountId.ts#L27)*
**Parameters:**
docs/types/classes/_accountindex_.accountindex.md
+21 -13
View File
@@ -1,5 +1,9 @@
*__name__*: AccountIndex
*__description__*: A wrapper around an AccountIndex, which is a shortened, variable-length encoding for an Account. We extends from [U32](_u32_.u32.md) to provide the number-like properties.
# Hierarchy
↳ [U32](_u32_.u32.md)
@@ -20,7 +24,7 @@
*Overrides [U32](_u32_.u32.md).[constructor](_u32_.u32.md#constructor)*
*Defined in [AccountIndex.ts:26](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/AccountIndex.ts#L26)*
*Defined in [AccountIndex.ts:29](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/AccountIndex.ts#L29)*
**Parameters:**
@@ -42,7 +46,9 @@ getencodedLength(): `number`
*Inherited from [UInt](_codec_uint_.uint.md).[encodedLength](_codec_uint_.uint.md#encodedlength)*
*Defined in [codec/UInt.ts:53](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/UInt.ts#L53)*
*Defined in [codec/UInt.ts:55](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/UInt.ts#L55)*
*__description__*: The length of the value when encoded as a Uint8Array
**Returns:** `number`
@@ -180,7 +186,9 @@ ___
*Overrides BN.bitLength*
*Defined in [codec/UInt.ts:49](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/UInt.ts#L49)*
*Defined in [codec/UInt.ts:62](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/UInt.ts#L62)*
*__description__*: Returns the number of bits in the value
**Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength)
@@ -1513,7 +1521,7 @@ ___
*Overrides [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)*
*Defined in [AccountIndex.ts:86](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/AccountIndex.ts#L86)*
*Defined in [AccountIndex.ts:89](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/AccountIndex.ts#L89)*
**Returns:** `BN`
@@ -1550,7 +1558,7 @@ ___
*Overrides [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)*
*Defined in [AccountIndex.ts:92](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/AccountIndex.ts#L92)*
*Defined in [AccountIndex.ts:95](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/AccountIndex.ts#L95)*
**Returns:** `string`
@@ -1565,7 +1573,7 @@ ___
*Overrides [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)*
*Defined in [AccountIndex.ts:96](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/AccountIndex.ts#L96)*
*Defined in [AccountIndex.ts:99](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/AccountIndex.ts#L99)*
**Returns:** `any`
@@ -1616,7 +1624,7 @@ ___
*Overrides BN.toString*
*Defined in [AccountIndex.ts:100](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/AccountIndex.ts#L100)*
*Defined in [AccountIndex.ts:103](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/AccountIndex.ts#L103)*
**Returns:** `string`
@@ -1652,7 +1660,7 @@ ___
*Overrides [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)*
*Defined in [AccountIndex.ts:106](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/AccountIndex.ts#L106)*
*Defined in [AccountIndex.ts:109](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/AccountIndex.ts#L109)*
**Parameters:**
@@ -1852,7 +1860,7 @@ ___
▸ **calcLength**(_value: * `BN` &#124; `number`*): `number`
*Defined in [AccountIndex.ts:49](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/AccountIndex.ts#L49)*
*Defined in [AccountIndex.ts:52](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/AccountIndex.ts#L52)*
**Parameters:**
@@ -1869,7 +1877,7 @@ ___
▸ **decodeAccountIndex**(value: *[AnyNumber](../modules/_types_.md#anynumber)*): `BN` &#124; `Uint8Array` &#124; `number` &#124; `string`
*Defined in [AccountIndex.ts:33](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/AccountIndex.ts#L33)*
*Defined in [AccountIndex.ts:36](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/AccountIndex.ts#L36)*
**Parameters:**
@@ -1888,7 +1896,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)*
*Defined in [codec/UInt.ts:33](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/UInt.ts#L33)*
*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/UInt.ts#L36)*
**Parameters:**
@@ -1992,7 +2000,7 @@ ___
▸ **readLength**(input: *`Uint8Array`*): [`number`, `number`]
*Defined in [AccountIndex.ts:63](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/AccountIndex.ts#L63)*
*Defined in [AccountIndex.ts:66](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/AccountIndex.ts#L66)*
**Parameters:**
@@ -2030,7 +2038,7 @@ ___
▸ **writeLength**(input: *`Uint8Array`*): `Uint8Array`
*Defined in [AccountIndex.ts:77](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/AccountIndex.ts#L77)*
*Defined in [AccountIndex.ts:80](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/AccountIndex.ts#L80)*
**Parameters:**
docs/types/classes/_address_.address.md
+12 -8
View File
@@ -1,5 +1,9 @@
*__name__*: Address
*__description__*: A wrapper around an AccountId and/or AccountIndex that is encoded with a prefix. Since we are dealing with underlying publicKeys (or shorter encoded addresses), we extend from Base with an AccountId/AccountIndex wrapper. Basically the Address is encoded as `[ <prefix-byte>, ...publicKey/...bytes ]` as per spec
# Hierarchy
[Base](_codec_base_.base.md)< [AccountId](_accountid_.accountid.md) &#124; [AccountIndex](_accountindex_.accountindex.md)>
@@ -16,7 +20,7 @@
*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)*
*Defined in [Address.ts:22](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Address.ts#L22)*
*Defined in [Address.ts:25](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Address.ts#L25)*
**Parameters:**
@@ -36,7 +40,7 @@ ___
getencodedLength(): `number`
*Defined in [Address.ts:67](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Address.ts#L67)*
*Defined in [Address.ts:64](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Address.ts#L64)*
**Returns:** `number`
@@ -47,7 +51,7 @@ ___
getrawLength(): `number`
*Defined in [Address.ts:61](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Address.ts#L61)*
*Defined in [Address.ts:75](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Address.ts#L75)*
**Returns:** `number`
@@ -61,7 +65,7 @@ ___
▸ **toHex**(): `string`
*Defined in [Address.ts:78](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Address.ts#L78)*
*Defined in [Address.ts:81](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Address.ts#L81)*
**Returns:** `string`
@@ -72,7 +76,7 @@ ___
▸ **toJSON**(): `any`
*Defined in [Address.ts:82](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Address.ts#L82)*
*Defined in [Address.ts:85](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Address.ts#L85)*
**Returns:** `any`
@@ -83,7 +87,7 @@ ___
▸ **toString**(): `string`
*Defined in [Address.ts:86](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Address.ts#L86)*
*Defined in [Address.ts:89](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Address.ts#L89)*
**Returns:** `string`
@@ -94,7 +98,7 @@ ___
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Defined in [Address.ts:90](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Address.ts#L90)*
*Defined in [Address.ts:93](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Address.ts#L93)*
**Parameters:**
@@ -111,7 +115,7 @@ ___
▸ **decodeAddress**(value: *`AnyAddress`*): [AccountId](_accountid_.accountid.md) &#124; [AccountIndex](_accountindex_.accountindex.md)
*Defined in [Address.ts:29](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Address.ts#L29)*
*Defined in [Address.ts:32](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Address.ts#L32)*
**Parameters:**
docs/types/classes/_authorityid_.authorityid.md
+20 -12
View File
@@ -27,7 +27,7 @@
*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)*
*Defined in [AccountId.ts:15](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/AccountId.ts#L15)*
*Defined in [AccountId.ts:19](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/AccountId.ts#L19)*
**Parameters:**
@@ -128,7 +128,9 @@ getencodedLength(): `number`
*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)*
*Defined in [codec/U8a.ts:28](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/U8a.ts#L28)*
*Defined in [codec/U8a.ts:35](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/U8a.ts#L35)*
*__description__*: The length of the value when encoded as a Uint8Array
**Returns:** `number`
@@ -157,7 +159,9 @@ ___
*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)*
*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/U8aFixed.ts#L32)*
*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/U8aFixed.ts#L39)*
*__description__*: Returns the number of bits in the value
**Returns:** `number`
@@ -681,7 +685,7 @@ ___
*Overrides Uint8Array.subarray*
*Defined in [codec/U8a.ts:34](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/U8a.ts#L34)*
*Defined in [codec/U8a.ts:41](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/U8a.ts#L41)*
**Parameters:**
@@ -703,7 +707,9 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:38](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/U8a.ts#L38)*
*Defined in [codec/U8a.ts:48](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/U8a.ts#L48)*
*__description__*: Returns a hex string representation of the value
**Returns:** `string`
@@ -720,7 +726,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
*Defined in [AccountId.ts:39](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/AccountId.ts#L39)*
*Defined in [AccountId.ts:43](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/AccountId.ts#L43)*
**Returns:** `any`
@@ -752,7 +758,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)*
*Defined in [AccountId.ts:43](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/AccountId.ts#L43)*
*Defined in [AccountId.ts:47](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/AccountId.ts#L47)*
**Returns:** `string`
@@ -767,13 +773,15 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
*Defined in [codec/U8a.ts:46](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/U8a.ts#L46)*
*Defined in [codec/U8a.ts:70](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/U8a.ts#L70)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
**Parameters:**
| Name | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
| Name | Type | Description |
| ------ | ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`| true when the value has none of the type-specific prefixes (internal) |
**Returns:** `Uint8Array`
@@ -801,7 +809,7 @@ ___
*Inherited from [AccountId](_accountid_.accountid.md).[encode](_accountid_.accountid.md#encode)*
*Defined in [AccountId.ts:23](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/AccountId.ts#L23)*
*Defined in [AccountId.ts:27](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/AccountId.ts#L27)*
**Parameters:**
docs/types/classes/_balance_.balance.md
+27 -11
View File
@@ -1,5 +1,9 @@
*__name__*: Balance
*__description__*: The Substrate Balance representation as a [U128](_u128_.u128.md).
# Hierarchy
↳ [U128](_u128_.u128.md)
@@ -22,7 +26,7 @@
*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)*
*Defined in [U128.ts:9](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/U128.ts#L9)*
*Defined in [U128.ts:14](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/U128.ts#L14)*
**Parameters:**
@@ -44,7 +48,9 @@ getencodedLength(): `number`
*Inherited from [UInt](_codec_uint_.uint.md).[encodedLength](_codec_uint_.uint.md#encodedlength)*
*Defined in [codec/UInt.ts:53](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/UInt.ts#L53)*
*Defined in [codec/UInt.ts:55](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/UInt.ts#L55)*
*__description__*: The length of the value when encoded as a Uint8Array
**Returns:** `number`
@@ -182,7 +188,9 @@ ___
*Overrides BN.bitLength*
*Defined in [codec/UInt.ts:49](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/UInt.ts#L49)*
*Defined in [codec/UInt.ts:62](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/UInt.ts#L62)*
*__description__*: Returns the number of bits in the value
**Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength)
@@ -1515,7 +1523,9 @@ ___
*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/82dcbe5/packages/types/src/codec/UInt.ts#L71)*
*Defined in [codec/UInt.ts:69](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/UInt.ts#L69)*
*__description__*: Returns the BN representation of the number. (Compatibility)
**Returns:** `BN`
@@ -1552,7 +1562,9 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)*
*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/UInt.ts#L57)*
*Defined in [codec/UInt.ts:76](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/UInt.ts#L76)*
*__description__*: Returns a hex string representation of the value
**Returns:** `string`
@@ -1569,7 +1581,9 @@ ___
*Overrides BN.toJSON*
*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/UInt.ts#L61)*
*Defined in [codec/UInt.ts:83](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/UInt.ts#L83)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
**Returns:** `any`
@@ -1663,13 +1677,15 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)*
*Defined in [codec/UInt.ts:67](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/UInt.ts#L67)*
*Defined in [codec/UInt.ts:93](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/UInt.ts#L93)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
**Parameters:**
| Name | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
| Name | Type | Description |
| ------ | ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`| true when the value has none of the type-specific prefixes (internal) |
**Returns:** `Uint8Array`
@@ -1865,7 +1881,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)*
*Defined in [codec/UInt.ts:33](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/UInt.ts#L33)*
*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/UInt.ts#L36)*
**Parameters:**
docs/types/classes/_bft_.bftauthoritysignature.md
+33 -15
View File
@@ -1,5 +1,9 @@
*__name__*: BftAuthoritySignature
*__description__*: Represents a Bft Hash and Signature pairing, typically used in reporting network behaviour.
# Type parameters
#### S : [ConstructorDef](../modules/_types_.md#constructordef)
#### T : `object`
@@ -25,7 +29,7 @@
*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)*
*Defined in [Bft.ts:19](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Bft.ts#L19)*
*Defined in [Bft.ts:23](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Bft.ts#L23)*
**Parameters:**
@@ -72,7 +76,7 @@ getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L125)*
*Defined in [codec/Struct.ts:129](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L129)*
**Returns:** `E`
@@ -83,7 +87,7 @@ ___
getauthorityId(): [AuthorityId](_authorityid_.authorityid.md)
*Defined in [Bft.ts:27](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Bft.ts#L27)*
*Defined in [Bft.ts:31](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Bft.ts#L31)*
**Returns:** [AuthorityId](_authorityid_.authorityid.md)
@@ -96,7 +100,9 @@ getencodedLength(): `number`
*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)*
*Defined in [codec/Struct.ts:129](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L129)*
*Defined in [codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L136)*
*__description__*: The length of the value when encoded as a Uint8Array
**Returns:** `number`
@@ -107,7 +113,7 @@ ___
getsignature(): [Signature](_signature_.signature.md)
*Defined in [Bft.ts:31](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Bft.ts#L31)*
*Defined in [Bft.ts:35](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Bft.ts#L35)*
**Returns:** [Signature](_signature_.signature.md)
@@ -224,7 +230,9 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)*
*Defined in [codec/Struct.ts:135](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L135)*
*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L145)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
**Parameters:**
@@ -297,7 +305,9 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)*
*Defined in [codec/Struct.ts:139](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L139)*
*Defined in [codec/Struct.ts:152](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L152)*
*__description__*: Converts the Object to an standard JavaScript Array
**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)>
@@ -312,7 +322,9 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)*
*Defined in [codec/Struct.ts:143](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L143)*
*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L159)*
*__description__*: Returns a hex string representation of the value
**Returns:** `string`
@@ -329,7 +341,9 @@ ___
*Overrides [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
*Defined in [codec/Tuple.ts:27](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Tuple.ts#L27)*
*Defined in [codec/Tuple.ts:34](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Tuple.ts#L34)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
**Returns:** `any`
@@ -344,7 +358,9 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)*
*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L158)*
*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L180)*
*__description__*: Returns the string representation of the value
**Returns:** `string`
@@ -359,13 +375,15 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
*Defined in [codec/Struct.ts:162](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L162)*
*Defined in [codec/Struct.ts:188](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L188)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
**Parameters:**
| Name | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
| Name | Type | Description |
| ------ | ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`| true when the value has none of the type-specific prefixes (internal) |
**Returns:** `Uint8Array`
@@ -395,7 +413,7 @@ ___
*Overrides [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Tuple.ts:17](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Tuple.ts#L17)*
*Defined in [codec/Tuple.ts:21](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Tuple.ts#L21)*
**Type parameters:**
docs/types/classes/_bft_.bfthashsignature.md
+33 -15
View File
@@ -1,5 +1,9 @@
*__name__*: BftHashSignature
*__description__*: Represents a Bft Hash and Signature pairing, typically used in reporting network behaviour.
# Type parameters
#### S : [ConstructorDef](../modules/_types_.md#constructordef)
#### T : `object`
@@ -25,7 +29,7 @@
*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)*
*Defined in [Bft.ts:43](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Bft.ts#L43)*
*Defined in [Bft.ts:51](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Bft.ts#L51)*
**Parameters:**
@@ -72,7 +76,7 @@ getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L125)*
*Defined in [codec/Struct.ts:129](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L129)*
**Returns:** `E`
@@ -85,7 +89,9 @@ getencodedLength(): `number`
*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)*
*Defined in [codec/Struct.ts:129](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L129)*
*Defined in [codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L136)*
*__description__*: The length of the value when encoded as a Uint8Array
**Returns:** `number`
@@ -96,7 +102,7 @@ ___
gethash(): [Hash](_hash_.hash.md)
*Defined in [Bft.ts:51](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Bft.ts#L51)*
*Defined in [Bft.ts:59](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Bft.ts#L59)*
**Returns:** [Hash](_hash_.hash.md)
@@ -107,7 +113,7 @@ ___
getsignature(): [Signature](_signature_.signature.md)
*Defined in [Bft.ts:55](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Bft.ts#L55)*
*Defined in [Bft.ts:63](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Bft.ts#L63)*
**Returns:** [Signature](_signature_.signature.md)
@@ -224,7 +230,9 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)*
*Defined in [codec/Struct.ts:135](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L135)*
*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L145)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
**Parameters:**
@@ -297,7 +305,9 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)*
*Defined in [codec/Struct.ts:139](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L139)*
*Defined in [codec/Struct.ts:152](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L152)*
*__description__*: Converts the Object to an standard JavaScript Array
**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)>
@@ -312,7 +322,9 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)*
*Defined in [codec/Struct.ts:143](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L143)*
*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L159)*
*__description__*: Returns a hex string representation of the value
**Returns:** `string`
@@ -329,7 +341,9 @@ ___
*Overrides [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
*Defined in [codec/Tuple.ts:27](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Tuple.ts#L27)*
*Defined in [codec/Tuple.ts:34](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Tuple.ts#L34)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
**Returns:** `any`
@@ -344,7 +358,9 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)*
*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L158)*
*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L180)*
*__description__*: Returns the string representation of the value
**Returns:** `string`
@@ -359,13 +375,15 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
*Defined in [codec/Struct.ts:162](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L162)*
*Defined in [codec/Struct.ts:188](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L188)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
**Parameters:**
| Name | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
| Name | Type | Description |
| ------ | ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`| true when the value has none of the type-specific prefixes (internal) |
**Returns:** `Uint8Array`
@@ -395,7 +413,7 @@ ___
*Overrides [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Tuple.ts:17](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Tuple.ts#L17)*
*Defined in [codec/Tuple.ts:21](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Tuple.ts#L21)*
**Type parameters:**
docs/types/classes/_block_.block.md
+34 -16
View File
@@ -1,5 +1,9 @@
*__name__*: Block
*__description__*: A block encoded with header and extrinsics
# Type parameters
#### S : [ConstructorDef](../modules/_types_.md#constructordef)
#### T : `object`
@@ -25,7 +29,7 @@
*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)*
*Defined in [Block.ts:20](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Block.ts#L20)*
*Defined in [Block.ts:24](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Block.ts#L24)*
**Parameters:**
@@ -72,7 +76,7 @@ getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L125)*
*Defined in [codec/Struct.ts:129](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L129)*
**Returns:** `E`
@@ -85,7 +89,9 @@ getencodedLength(): `number`
*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)*
*Defined in [codec/Struct.ts:129](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L129)*
*Defined in [codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L136)*
*__description__*: The length of the value when encoded as a Uint8Array
**Returns:** `number`
@@ -96,7 +102,7 @@ ___
getextrinsics(): [Extrinsics](_extrinsics_.extrinsics.md)
*Defined in [Block.ts:28](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Block.ts#L28)*
*Defined in [Block.ts:32](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Block.ts#L32)*
**Returns:** [Extrinsics](_extrinsics_.extrinsics.md)
@@ -107,7 +113,7 @@ ___
gethash(): [Hash](_hash_.hash.md)
*Defined in [Block.ts:33](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Block.ts#L33)*
*Defined in [Block.ts:37](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Block.ts#L37)*
**Returns:** [Hash](_hash_.hash.md)
@@ -118,7 +124,7 @@ ___
getheader(): [Header](_header_.header.md)
*Defined in [Block.ts:39](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Block.ts#L39)*
*Defined in [Block.ts:43](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Block.ts#L43)*
**Returns:** [Header](_header_.header.md)
@@ -235,7 +241,9 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)*
*Defined in [codec/Struct.ts:135](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L135)*
*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L145)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
**Parameters:**
@@ -308,7 +316,9 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)*
*Defined in [codec/Struct.ts:139](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L139)*
*Defined in [codec/Struct.ts:152](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L152)*
*__description__*: Converts the Object to an standard JavaScript Array
**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)>
@@ -323,7 +333,9 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)*
*Defined in [codec/Struct.ts:143](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L143)*
*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L159)*
*__description__*: Returns a hex string representation of the value
**Returns:** `string`
@@ -338,7 +350,9 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L147)*
*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L166)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
**Returns:** `any`
@@ -353,7 +367,9 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)*
*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L158)*
*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L180)*
*__description__*: Returns the string representation of the value
**Returns:** `string`
@@ -368,13 +384,15 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
*Defined in [codec/Struct.ts:162](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L162)*
*Defined in [codec/Struct.ts:188](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L188)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
**Parameters:**
| Name | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
| Name | Type | Description |
| ------ | ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`| true when the value has none of the type-specific prefixes (internal) |
**Returns:** `Uint8Array`
@@ -402,7 +420,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Struct.ts:108](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L108)*
*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L112)*
**Type parameters:**
docs/types/classes/_blocknumber_.blocknumber.md
+27 -11
View File
@@ -1,5 +1,9 @@
*__name__*: BlockNumber
*__description__*: A representation of a Substrate BlockNumber, implemented as a [U64](_u64_.u64.md)
# Hierarchy
↳ [U64](_u64_.u64.md)
@@ -22,7 +26,7 @@
*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)*
*Defined in [U64.ts:9](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/U64.ts#L9)*
*Defined in [U64.ts:14](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/U64.ts#L14)*
**Parameters:**
@@ -44,7 +48,9 @@ getencodedLength(): `number`
*Inherited from [UInt](_codec_uint_.uint.md).[encodedLength](_codec_uint_.uint.md#encodedlength)*
*Defined in [codec/UInt.ts:53](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/UInt.ts#L53)*
*Defined in [codec/UInt.ts:55](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/UInt.ts#L55)*
*__description__*: The length of the value when encoded as a Uint8Array
**Returns:** `number`
@@ -182,7 +188,9 @@ ___
*Overrides BN.bitLength*
*Defined in [codec/UInt.ts:49](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/UInt.ts#L49)*
*Defined in [codec/UInt.ts:62](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/UInt.ts#L62)*
*__description__*: Returns the number of bits in the value
**Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength)
@@ -1515,7 +1523,9 @@ ___
*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/82dcbe5/packages/types/src/codec/UInt.ts#L71)*
*Defined in [codec/UInt.ts:69](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/UInt.ts#L69)*
*__description__*: Returns the BN representation of the number. (Compatibility)
**Returns:** `BN`
@@ -1552,7 +1562,9 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)*
*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/UInt.ts#L57)*
*Defined in [codec/UInt.ts:76](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/UInt.ts#L76)*
*__description__*: Returns a hex string representation of the value
**Returns:** `string`
@@ -1569,7 +1581,9 @@ ___
*Overrides BN.toJSON*
*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/UInt.ts#L61)*
*Defined in [codec/UInt.ts:83](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/UInt.ts#L83)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
**Returns:** `any`
@@ -1663,13 +1677,15 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)*
*Defined in [codec/UInt.ts:67](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/UInt.ts#L67)*
*Defined in [codec/UInt.ts:93](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/UInt.ts#L93)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
**Parameters:**
| Name | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
| Name | Type | Description |
| ------ | ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`| true when the value has none of the type-specific prefixes (internal) |
**Returns:** `Uint8Array`
@@ -1865,7 +1881,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)*
*Defined in [codec/UInt.ts:33](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/UInt.ts#L33)*
*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/UInt.ts#L36)*
**Parameters:**
docs/types/classes/_bool_.bool.md
+10 -6
View File
@@ -1,5 +1,9 @@
*__name__*: Bool
*__description__*: Representation for a boolean value in the system
# Hierarchy
`Boolean`
@@ -18,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:9](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Bool.ts#L9)*
*Defined in [Bool.ts:14](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Bool.ts#L14)*
**Parameters:**
@@ -50,7 +54,7 @@ ___
getencodedLength(): `number`
*Defined in [Bool.ts:26](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Bool.ts#L26)*
*Defined in [Bool.ts:31](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Bool.ts#L31)*
**Returns:** `number`
@@ -66,7 +70,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)*
*Defined in [Bool.ts:34](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Bool.ts#L34)*
*Defined in [Bool.ts:39](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Bool.ts#L39)*
**Returns:** `string`
@@ -79,7 +83,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)*
*Defined in [Bool.ts:30](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Bool.ts#L30)*
*Defined in [Bool.ts:35](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Bool.ts#L35)*
**Returns:** `any`
@@ -92,7 +96,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)*
*Defined in [Bool.ts:42](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Bool.ts#L42)*
*Defined in [Bool.ts:43](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Bool.ts#L43)*
**Returns:** `string`
@@ -105,7 +109,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)*
*Defined in [Bool.ts:38](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Bool.ts#L38)*
*Defined in [Bool.ts:47](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Bool.ts#L47)*
**Parameters:**
docs/types/classes/_bytes_.bytes.md
+19 -7
View File
@@ -1,11 +1,17 @@
*__name__*: Bytes
*__description__*: A Bytes wrapper for Vec. The significant difference between this and a normal Uint8Array is that this version allows for length-encoding. (i.e. it is a variable-item codec, the same as what is found in [Text](_text_.text.md) and [Vector](_codec_vector_.vector.md))
# Hierarchy
↳ [U8a](_codec_u8a_.u8a.md)
**↳ Bytes**
↳ [Other](_digest_.other.md)
↳ [StorageData](_storagedata_.storagedata.md)
↳ [StorageKey](_storagekey_.storagekey.md)
@@ -29,7 +35,7 @@
*Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)*
*Defined in [Bytes.ts:14](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Bytes.ts#L14)*
*Defined in [Bytes.ts:18](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Bytes.ts#L18)*
**Parameters:**
@@ -130,7 +136,7 @@ getencodedLength(): `number`
*Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)*
*Defined in [Bytes.ts:57](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Bytes.ts#L57)*
*Defined in [Bytes.ts:61](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Bytes.ts#L61)*
**Returns:** `number`
@@ -670,7 +676,7 @@ ___
*Overrides Uint8Array.subarray*
*Defined in [codec/U8a.ts:34](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/U8a.ts#L34)*
*Defined in [codec/U8a.ts:41](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/U8a.ts#L41)*
**Parameters:**
@@ -692,7 +698,9 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:38](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/U8a.ts#L38)*
*Defined in [codec/U8a.ts:48](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/U8a.ts#L48)*
*__description__*: Returns a hex string representation of the value
**Returns:** `string`
@@ -707,7 +715,9 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
*Defined in [codec/U8a.ts:42](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/U8a.ts#L42)*
*Defined in [codec/U8a.ts:55](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/U8a.ts#L55)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
**Returns:** `any`
@@ -739,7 +749,9 @@ ___
*Overrides Uint8Array.toString*
*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/U8a.ts#L50)*
*Defined in [codec/U8a.ts:62](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/U8a.ts#L62)*
*__description__*: Returns the string representation of the value
**Returns:** `string`
@@ -754,7 +766,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
*Defined in [Bytes.ts:61](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Bytes.ts#L61)*
*Defined in [Bytes.ts:65](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Bytes.ts#L65)*
**Parameters:**
docs/types/classes/_codec_base_.base.md
+4 -2
View File
@@ -1,6 +1,8 @@
A type extends the Base class, when it holds a value
*__name__*: Base
*__description__*: A type extends the Base class, when it holds a value
# Type parameters
#### T
@@ -28,7 +30,7 @@ A type extends the Base class, when it holds a value
⊕ **new Base**(value?: *`any`*): [Base](_codec_base_.base.md)
*Defined in [codec/Base.ts:9](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Base.ts#L9)*
*Defined in [codec/Base.ts:10](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Base.ts#L10)*
**Parameters:**
docs/types/classes/_codec_compact_.compact.md
+38 -18
View File
@@ -1,5 +1,9 @@
*__name__*: Compact
*__description__*: A compact length-encoding codec wrapper. It performs the same function as Length, however differs in that it uses a variable number of bytes to do the actual encoding. This is mostly used by other types to add length-prefixed encoding, or in the case of wrapped types, taking a number and making the compact representation thereof
# Hierarchy
[Base](_codec_base_.base.md)< [UInt](_codec_uint_.uint.md) &#124; [Moment](_moment_.moment.md)>
@@ -20,7 +24,7 @@
*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)*
*Defined in [codec/Compact.ts:29](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Compact.ts#L29)*
*Defined in [codec/Compact.ts:22](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Compact.ts#L22)*
**Parameters:**
@@ -41,7 +45,7 @@ ___
**● addLengthPrefix**: *`compactAddLength`* = compactAddLength
*Defined in [codec/Compact.ts:47](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Compact.ts#L47)*
*Defined in [codec/Compact.ts:40](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Compact.ts#L40)*
Prepend a Uint8Array with its compact length.
*__param__*: The Uint8Array to be prefixed
@@ -53,7 +57,7 @@ ___
**● decodeU8a**: *`compactFromU8a`* = compactFromU8a
*Defined in [codec/Compact.ts:48](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Compact.ts#L48)*
*Defined in [codec/Compact.ts:41](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Compact.ts#L41)*
___
<a id="encodeu8a"></a>
@@ -62,7 +66,7 @@ ___
**● encodeU8a**: *`compactToU8a`* = compactToU8a
*Defined in [codec/Compact.ts:49](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Compact.ts#L49)*
*Defined in [codec/Compact.ts:42](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Compact.ts#L42)*
___
@@ -74,7 +78,9 @@ ___
getencodedLength(): `number`
*Defined in [codec/Compact.ts:79](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Compact.ts#L79)*
*Defined in [codec/Compact.ts:71](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Compact.ts#L71)*
*__description__*: The length of the value when encoded as a Uint8Array
**Returns:** `number`
@@ -88,7 +94,9 @@ ___
▸ **bitLength**(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength)
*Defined in [codec/Compact.ts:75](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Compact.ts#L75)*
*Defined in [codec/Compact.ts:78](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Compact.ts#L78)*
*__description__*: Returns the number of bits in the value
**Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength)
@@ -99,7 +107,9 @@ ___
▸ **toBn**(): `BN`
*Defined in [codec/Compact.ts:83](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Compact.ts#L83)*
*Defined in [codec/Compact.ts:85](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Compact.ts#L85)*
*__description__*: Returns the BN representation of the number
**Returns:** `BN`
@@ -112,7 +122,9 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)*
*Defined in [codec/Compact.ts:87](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Compact.ts#L87)*
*Defined in [codec/Compact.ts:92](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Compact.ts#L92)*
*__description__*: Returns a hex string representation of the value
**Returns:** `any`
@@ -125,7 +137,9 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)*
*Defined in [codec/Compact.ts:91](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Compact.ts#L91)*
*Defined in [codec/Compact.ts:99](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Compact.ts#L99)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
**Returns:** `any`
@@ -136,7 +150,9 @@ ___
▸ **toNumber**(): `number`
*Defined in [codec/Compact.ts:95](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Compact.ts#L95)*
*Defined in [codec/Compact.ts:106](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Compact.ts#L106)*
*__description__*: Returns the number representation for the value
**Returns:** `number`
@@ -149,7 +165,9 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)*
*Defined in [codec/Compact.ts:99](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Compact.ts#L99)*
*Defined in [codec/Compact.ts:113](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Compact.ts#L113)*
*__description__*: Returns the string representation of the value
**Returns:** `string`
@@ -162,13 +180,15 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)*
*Defined in [codec/Compact.ts:103](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Compact.ts#L103)*
*Defined in [codec/Compact.ts:121](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Compact.ts#L121)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
**Parameters:**
| Name | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
| Name | Type | Description |
| ------ | ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`| true when the value has none of the type-specific prefixes (internal) |
**Returns:** `Uint8Array`
@@ -179,7 +199,7 @@ ___
▸ **decodeCompact**(Type: *[Constructor](../modules/_types_.md#constructor)< [UInt](_codec_uint_.uint.md) &#124; [Moment](_moment_.moment.md)>*, value: *[AnyNumber](../modules/_types_.md#anynumber)*): [Moment](_moment_.moment.md) &#124; [UInt](_codec_uint_.uint.md)
*Defined in [codec/Compact.ts:57](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Compact.ts#L57)*
*Defined in [codec/Compact.ts:50](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Compact.ts#L50)*
**Parameters:**
@@ -197,7 +217,7 @@ ___
▸ **stripLengthPrefix**(u8a: *`Uint8Array`*, bitLength?: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `Uint8Array`
*Defined in [codec/Compact.ts:51](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Compact.ts#L51)*
*Defined in [codec/Compact.ts:44](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Compact.ts#L44)*
**Parameters:**
@@ -215,7 +235,7 @@ ___
▸ **with**(Type: *[Constructor](../modules/_types_.md#constructor)< [UInt](_codec_uint_.uint.md) &#124; [Moment](_moment_.moment.md)>*): [Constructor](../modules/_types_.md#constructor)<[Compact](_codec_compact_.compact.md)>
*Defined in [codec/Compact.ts:34](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Compact.ts#L34)*
*Defined in [codec/Compact.ts:27](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Compact.ts#L27)*
**Parameters:**
docs/types/classes/_codec_enum_.enum.md
+27 -11
View File
@@ -1,5 +1,9 @@
*__name__*: Enum
*__description__*: A codec wrapper for an enum. Enums are encoded as a single byte, where the byte is a zero-indexed value. This class allows you to retrieve the value either by `toNumber()` exposing the actual raw index, or `toString()` returning a string representation (as provided as part of the constructor)
# Hierarchy
[Base](_codec_base_.base.md)<`number`>
@@ -26,7 +30,7 @@
*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)*
*Defined in [codec/Enum.ts:22](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Enum.ts#L22)*
*Defined in [codec/Enum.ts:25](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Enum.ts#L25)*
**Parameters:**
@@ -47,7 +51,9 @@ ___
getencodedLength(): `number`
*Defined in [codec/Enum.ts:42](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Enum.ts#L42)*
*Defined in [codec/Enum.ts:48](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Enum.ts#L48)*
*__description__*: The length of the value when encoded as a Uint8Array
**Returns:** `number`
@@ -63,7 +69,9 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)*
*Defined in [codec/Enum.ts:46](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Enum.ts#L46)*
*Defined in [codec/Enum.ts:55](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Enum.ts#L55)*
*__description__*: Returns a hex string representation of the value
**Returns:** `string`
@@ -76,7 +84,9 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)*
*Defined in [codec/Enum.ts:50](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Enum.ts#L50)*
*Defined in [codec/Enum.ts:62](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Enum.ts#L62)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
**Returns:** `any`
@@ -87,7 +97,9 @@ ___
▸ **toNumber**(): `number`
*Defined in [codec/Enum.ts:54](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Enum.ts#L54)*
*Defined in [codec/Enum.ts:69](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Enum.ts#L69)*
*__description__*: Returns the number representation for the value
**Returns:** `number`
@@ -100,7 +112,9 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)*
*Defined in [codec/Enum.ts:58](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Enum.ts#L58)*
*Defined in [codec/Enum.ts:76](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Enum.ts#L76)*
*__description__*: Returns the string representation of the value
**Returns:** `string`
@@ -113,13 +127,15 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)*
*Defined in [codec/Enum.ts:62](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Enum.ts#L62)*
*Defined in [codec/Enum.ts:84](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Enum.ts#L84)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
**Parameters:**
| Name | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
| Name | Type | Description |
| ------ | ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`| true when the value has none of the type-specific prefixes (internal) |
**Returns:** `Uint8Array`
@@ -130,7 +146,7 @@ ___
▸ **decodeEnum**(value?: * [Enum](_codec_enum_.enum.md) &#124; `Uint8Array` &#124; `number`*): `number`
*Defined in [codec/Enum.ts:32](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Enum.ts#L32)*
*Defined in [codec/Enum.ts:35](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Enum.ts#L35)*
**Parameters:**
docs/types/classes/_codec_enumtype_.enumtype.md
+51 -14
View File
@@ -1,5 +1,9 @@
*__name__*: EnumType
*__description__*: This implements an enum, that based on the value wraps a different type. It is effectively an extension to enum where the value type is determined by the actual index.
# Type parameters
#### T
# Hierarchy
@@ -12,6 +16,8 @@
↳ [DigestItem](_digest_.digestitem.md)
↳ [Phase](_eventrecord_.phase.md)
↳ [ExtrinsicStatus](_extrinsicstatus_.extrinsicstatus.md)
↳ [MisbehaviorKind](_misbehaviorreport_.misbehaviorkind.md)
@@ -30,7 +36,7 @@
*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)*
*Defined in [codec/EnumType.ts:25](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/EnumType.ts#L25)*
*Defined in [codec/EnumType.ts:28](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/EnumType.ts#L28)*
**Parameters:**
@@ -52,10 +58,25 @@ ___
getencodedLength(): `number`
*Defined in [codec/EnumType.ts:93](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/EnumType.ts#L93)*
*Defined in [codec/EnumType.ts:87](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/EnumType.ts#L87)*
*__description__*: The length of the value when encoded as a Uint8Array
**Returns:** `number`
___
<a id="isnone"></a>
## isNone
getisNone(): `boolean`
*Defined in [codec/EnumType.ts:94](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/EnumType.ts#L94)*
*__description__*: Checks if the Enum points to a [Null](_null_.null.md) type
**Returns:** `boolean`
___
<a id="isnull"></a>
@@ -63,7 +84,9 @@ ___
getisNull(): `boolean`
*Defined in [codec/EnumType.ts:81](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/EnumType.ts#L81)*
*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/EnumType.ts#L101)*
*__description__*: Checks if the Enum points to a [Null](_null_.null.md) type (deprecated, use isNone)
**Returns:** `boolean`
@@ -74,7 +97,9 @@ ___
gettype(): `string`
*Defined in [codec/EnumType.ts:85](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/EnumType.ts#L85)*
*Defined in [codec/EnumType.ts:108](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/EnumType.ts#L108)*
*__description__*: The name of the type this enum value represents
**Returns:** `string`
@@ -85,7 +110,9 @@ ___
getvalue(): [Codec](../interfaces/_types_.codec.md)
*Defined in [codec/EnumType.ts:89](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/EnumType.ts#L89)*
*Defined in [codec/EnumType.ts:115](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/EnumType.ts#L115)*
*__description__*: The value of the enum
**Returns:** [Codec](../interfaces/_types_.codec.md)
@@ -101,7 +128,9 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)*
*Defined in [codec/EnumType.ts:97](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/EnumType.ts#L97)*
*Defined in [codec/EnumType.ts:122](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/EnumType.ts#L122)*
*__description__*: Returns a hex string representation of the value
**Returns:** `string`
@@ -114,7 +143,9 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)*
*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/EnumType.ts#L101)*
*Defined in [codec/EnumType.ts:129](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/EnumType.ts#L129)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
**Returns:** `any`
@@ -125,7 +156,9 @@ ___
▸ **toNumber**(): `number`
*Defined in [codec/EnumType.ts:105](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/EnumType.ts#L105)*
*Defined in [codec/EnumType.ts:136](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/EnumType.ts#L136)*
*__description__*: Returns the number representation for the value
**Returns:** `number`
@@ -138,7 +171,9 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)*
*Defined in [codec/EnumType.ts:109](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/EnumType.ts#L109)*
*Defined in [codec/EnumType.ts:143](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/EnumType.ts#L143)*
*__description__*: Returns the string representation of the value
**Returns:** `string`
@@ -151,13 +186,15 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)*
*Defined in [codec/EnumType.ts:113](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/EnumType.ts#L113)*
*Defined in [codec/EnumType.ts:151](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/EnumType.ts#L151)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
**Parameters:**
| Name | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
| Name | Type | Description |
| ------ | ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`| true when the value has none of the type-specific prefixes (internal) |
**Returns:** `Uint8Array`
@@ -168,7 +205,7 @@ ___
▸ **decodeEnumType**<`T`>(def: *`TypesDef`*, value?: *`any`*, index?: * `number` &#124; [EnumType](_codec_enumtype_.enumtype.md)<`T`>*): `object`
*Defined in [codec/EnumType.ts:44](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/EnumType.ts#L44)*
*Defined in [codec/EnumType.ts:47](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/EnumType.ts#L47)*
**Type parameters:**
docs/types/classes/_codec_option_.option.md
+37 -15
View File
@@ -1,5 +1,9 @@
*__name__*: Option
*__description__*: An Option is an optional field. Basically the first byte indicates that there is is value to follow. If the byte is `1` there is an actual value. So the Option implements that - decodes, checks for optionality and wraps the required structure with a value if/as required/found.
# Type parameters
#### T : [Codec](../interfaces/_types_.codec.md)
# Hierarchy
@@ -22,7 +26,7 @@
*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)*
*Defined in [codec/Option.ts:15](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Option.ts#L15)*
*Defined in [codec/Option.ts:19](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Option.ts#L19)*
**Parameters:**
@@ -43,7 +47,9 @@ ___
getencodedLength(): `number`
*Defined in [codec/Option.ts:57](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Option.ts#L57)*
*Defined in [codec/Option.ts:52](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Option.ts#L52)*
*__description__*: The length of the value when encoded as a Uint8Array
**Returns:** `number`
@@ -54,7 +60,9 @@ ___
getisNone(): `boolean`
*Defined in [codec/Option.ts:45](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Option.ts#L45)*
*Defined in [codec/Option.ts:60](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Option.ts#L60)*
*__description__*: Checks if the Option has no value
**Returns:** `boolean`
@@ -65,7 +73,9 @@ ___
getisSome(): `boolean`
*Defined in [codec/Option.ts:49](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Option.ts#L49)*
*Defined in [codec/Option.ts:67](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Option.ts#L67)*
*__description__*: Checks if the Option has a value
**Returns:** `boolean`
@@ -76,7 +86,9 @@ ___
getvalue(): [Codec](../interfaces/_types_.codec.md)
*Defined in [codec/Option.ts:53](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Option.ts#L53)*
*Defined in [codec/Option.ts:74](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Option.ts#L74)*
*__description__*: The actual value for the Option
**Returns:** [Codec](../interfaces/_types_.codec.md)
@@ -92,7 +104,9 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)*
*Defined in [codec/Option.ts:61](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Option.ts#L61)*
*Defined in [codec/Option.ts:81](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Option.ts#L81)*
*__description__*: Returns a hex string representation of the value
**Returns:** `string`
@@ -105,7 +119,9 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)*
*Defined in [codec/Option.ts:65](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Option.ts#L65)*
*Defined in [codec/Option.ts:88](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Option.ts#L88)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
**Returns:** `any`
@@ -118,7 +134,9 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)*
*Defined in [codec/Option.ts:84](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Option.ts#L84)*
*Defined in [codec/Option.ts:95](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Option.ts#L95)*
*__description__*: Returns the string representation of the value
**Returns:** `string`
@@ -131,13 +149,15 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)*
*Defined in [codec/Option.ts:69](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Option.ts#L69)*
*Defined in [codec/Option.ts:103](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Option.ts#L103)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
**Parameters:**
| Name | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
| Name | Type | Description |
| ------ | ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`| true when the value has none of the type-specific prefixes (internal) |
**Returns:** `Uint8Array`
@@ -148,7 +168,9 @@ ___
▸ **unwrap**(): `T`
*Defined in [codec/Option.ts:88](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Option.ts#L88)*
*Defined in [codec/Option.ts:121](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Option.ts#L121)*
*__description__*: Returns the value that the Option represents (if available)
**Returns:** `T`
@@ -159,7 +181,7 @@ ___
▸ **decodeOption**<`O`>(Type: *[Constructor](../modules/_types_.md#constructor)*, value?: *`any`*): [Codec](../interfaces/_types_.codec.md)
*Defined in [codec/Option.ts:22](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Option.ts#L22)*
*Defined in [codec/Option.ts:26](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Option.ts#L26)*
**Type parameters:**
@@ -180,7 +202,7 @@ ___
▸ **with**<`O`>(Type: *[Constructor](../modules/_types_.md#constructor)*): [Constructor](../modules/_types_.md#constructor)<[Option](_codec_option_.option.md)<`O`>>
*Defined in [codec/Option.ts:37](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Option.ts#L37)*
*Defined in [codec/Option.ts:41](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Option.ts#L41)*
**Type parameters:**
docs/types/classes/_codec_set_.set.md
+34 -14
View File
@@ -1,5 +1,9 @@
*__name__*: Set
*__description__*: An Set is an array of string values, represented an an encoded type by a bitwise representation of the values.
# Hierarchy
[Base](_codec_base_.base.md)<`Array`<`string`>>
@@ -20,7 +24,7 @@
*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)*
*Defined in [codec/Set.ts:19](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Set.ts#L19)*
*Defined in [codec/Set.ts:22](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Set.ts#L22)*
**Parameters:**
@@ -41,7 +45,9 @@ ___
getencodedLength(): `number`
*Defined in [codec/Set.ts:66](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Set.ts#L66)*
*Defined in [codec/Set.ts:72](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Set.ts#L72)*
*__description__*: The length of the value when encoded as a Uint8Array
**Returns:** `number`
@@ -52,7 +58,9 @@ ___
getisEmpty(): `boolean`
*Defined in [codec/Set.ts:70](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Set.ts#L70)*
*Defined in [codec/Set.ts:79](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Set.ts#L79)*
*__description__*: true is the Set contains no values
**Returns:** `boolean`
@@ -63,7 +71,9 @@ ___
getvalueEncoded(): `number`
*Defined in [codec/Set.ts:78](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Set.ts#L78)*
*Defined in [codec/Set.ts:93](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Set.ts#L93)*
*__description__*: The encoded value for the set members
**Returns:** `number`
@@ -74,7 +84,9 @@ ___
getvalues(): `Array`<`string`>
*Defined in [codec/Set.ts:74](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Set.ts#L74)*
*Defined in [codec/Set.ts:86](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Set.ts#L86)*
*__description__*: The actual set values as a Array
**Returns:** `Array`<`string`>
@@ -90,7 +102,9 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)*
*Defined in [codec/Set.ts:82](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Set.ts#L82)*
*Defined in [codec/Set.ts:100](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Set.ts#L100)*
*__description__*: Returns a hex string representation of the value
**Returns:** `string`
@@ -103,7 +117,9 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)*
*Defined in [codec/Set.ts:86](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Set.ts#L86)*
*Defined in [codec/Set.ts:107](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Set.ts#L107)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
**Returns:** `any`
@@ -116,7 +132,9 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)*
*Defined in [codec/Set.ts:94](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Set.ts#L94)*
*Defined in [codec/Set.ts:114](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Set.ts#L114)*
*__description__*: Returns the string representation of the value
**Returns:** `string`
@@ -129,13 +147,15 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)*
*Defined in [codec/Set.ts:90](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Set.ts#L90)*
*Defined in [codec/Set.ts:122](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Set.ts#L122)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
**Parameters:**
| Name | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
| Name | Type | Description |
| ------ | ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`| true when the value has none of the type-specific prefixes (internal) |
**Returns:** `Uint8Array`
@@ -146,7 +166,7 @@ ___
▸ **decodeSet**(setValues: *`SetValues`*, value?: * `Array`<`string`> &#124; `Uint8Array` &#124; `number`*): `Array`<`string`>
*Defined in [codec/Set.ts:29](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Set.ts#L29)*
*Defined in [codec/Set.ts:32](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Set.ts#L32)*
**Parameters:**
@@ -164,7 +184,7 @@ ___
▸ **encodeSet**(setValues: *`SetValues`*, value: *`Array`<`string`>*): `number`
*Defined in [codec/Set.ts:60](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Set.ts#L60)*
*Defined in [codec/Set.ts:63](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Set.ts#L63)*
**Parameters:**
docs/types/classes/_codec_struct_.struct.md
+31 -13
View File
@@ -1,5 +1,9 @@
*__name__*: Struct
*__description__*: A Struct defines an Object with key/values - where the values are Codec values. It removes a lot of repetition from the actual coding, define a structure type, pass it the key/Codec values in the constructor and it manages the decoding. It is important that the constructor values matches 100% to the order in th Rust code, i.e. don't go crazy and make it alphabetical, it needs to decoded in the specific defined order.
# Type parameters
#### S : [ConstructorDef](../modules/_types_.md#constructordef)
#### T : `object`
@@ -89,7 +93,7 @@
⊕ **new Struct**(Types: *`S`*, value?: * `V` &#124; `Array`<`any`>*, jsonMap?: *`Map`<`keyof S`, `string`>*): [Struct](_codec_struct_.struct.md)
*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L25)*
*Defined in [codec/Struct.ts:29](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L29)*
**Parameters:**
@@ -145,7 +149,7 @@ ___
getType(): `E`
*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L125)*
*Defined in [codec/Struct.ts:129](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L129)*
**Returns:** `E`
@@ -156,7 +160,9 @@ ___
getencodedLength(): `number`
*Defined in [codec/Struct.ts:129](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L129)*
*Defined in [codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L136)*
*__description__*: The length of the value when encoded as a Uint8Array
**Returns:** `number`
@@ -271,7 +277,9 @@ ___
▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md)
*Defined in [codec/Struct.ts:135](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L135)*
*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L145)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
**Parameters:**
@@ -342,7 +350,9 @@ ___
▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)>
*Defined in [codec/Struct.ts:139](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L139)*
*Defined in [codec/Struct.ts:152](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L152)*
*__description__*: Converts the Object to an standard JavaScript Array
**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)>
@@ -355,7 +365,9 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)*
*Defined in [codec/Struct.ts:143](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L143)*
*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L159)*
*__description__*: Returns a hex string representation of the value
**Returns:** `string`
@@ -368,7 +380,9 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)*
*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L147)*
*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L166)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
**Returns:** `any`
@@ -381,7 +395,9 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)*
*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L158)*
*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L180)*
*__description__*: Returns the string representation of the value
**Returns:** `string`
@@ -394,13 +410,15 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)*
*Defined in [codec/Struct.ts:162](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L162)*
*Defined in [codec/Struct.ts:188](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L188)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
**Parameters:**
| Name | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
| Name | Type | Description |
| ------ | ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`| true when the value has none of the type-specific prefixes (internal) |
**Returns:** `Uint8Array`
@@ -426,7 +444,7 @@ ___
▸ **with**<`S`>(Types: *`S`*): [Constructor](../modules/_types_.md#constructor)<[Struct](_codec_struct_.struct.md)<`S`>>
*Defined in [codec/Struct.ts:108](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L108)*
*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L112)*
**Type parameters:**
docs/types/classes/_codec_tuple_.tuple.md
+39 -13
View File
@@ -1,5 +1,9 @@
*__name__*: Tuple
*__description__*: A Tuple defines an anonymous Object with key/values - where the values are Codec values. It is a specialization of the Struct type where the toJSON operates on Array structures, while the U8a encoding is handled in the same way as a Struct
# Type parameters
#### S : [ConstructorDef](../modules/_types_.md#constructordef)
#### T : `object`
@@ -13,12 +17,20 @@
↳ [OuterEventMetadataEvent](_metadata_.outereventmetadataevent.md)
↳ [Seal](_digest_.seal.md)
↳ [EventData](_event_.eventdata.md)
↳ [KeyValueOption](_keyvalue_.keyvalueoption.md)
↳ [BftAuthoritySignature](_bft_.bftauthoritysignature.md)
↳ [BftHashSignature](_bft_.bfthashsignature.md)
↳ [RuntimeVersionApi](_runtimeversion_.runtimeversionapi.md)
↳ [NextAuthority](_storedpendingchange_.nextauthority.md)
# Implements
* [Codec](../interfaces/_types_.codec.md)
@@ -33,7 +45,7 @@
*Inherited from [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)*
*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L25)*
*Defined in [codec/Struct.ts:29](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L29)*
**Parameters:**
@@ -82,7 +94,7 @@ getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L125)*
*Defined in [codec/Struct.ts:129](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L129)*
**Returns:** `E`
@@ -95,7 +107,9 @@ getencodedLength(): `number`
*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)*
*Defined in [codec/Struct.ts:129](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L129)*
*Defined in [codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L136)*
*__description__*: The length of the value when encoded as a Uint8Array
**Returns:** `number`
@@ -212,7 +226,9 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)*
*Defined in [codec/Struct.ts:135](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L135)*
*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L145)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
**Parameters:**
@@ -285,7 +301,9 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)*
*Defined in [codec/Struct.ts:139](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L139)*
*Defined in [codec/Struct.ts:152](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L152)*
*__description__*: Converts the Object to an standard JavaScript Array
**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)>
@@ -300,7 +318,9 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)*
*Defined in [codec/Struct.ts:143](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L143)*
*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L159)*
*__description__*: Returns a hex string representation of the value
**Returns:** `string`
@@ -315,7 +335,9 @@ ___
*Overrides [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
*Defined in [codec/Tuple.ts:27](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Tuple.ts#L27)*
*Defined in [codec/Tuple.ts:34](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Tuple.ts#L34)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
**Returns:** `any`
@@ -330,7 +352,9 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)*
*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L158)*
*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L180)*
*__description__*: Returns the string representation of the value
**Returns:** `string`
@@ -345,13 +369,15 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
*Defined in [codec/Struct.ts:162](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L162)*
*Defined in [codec/Struct.ts:188](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L188)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
**Parameters:**
| Name | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
| Name | Type | Description |
| ------ | ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`| true when the value has none of the type-specific prefixes (internal) |
**Returns:** `Uint8Array`
@@ -379,7 +405,7 @@ ___
*Overrides [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Tuple.ts:17](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Tuple.ts#L17)*
*Defined in [codec/Tuple.ts:21](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Tuple.ts#L21)*
**Type parameters:**
docs/types/classes/_codec_typeregistry_.typeregistry.md
+4 -4
View File
@@ -12,7 +12,7 @@
**● defaultRegistry**: *[TypeRegistry](_codec_typeregistry_.typeregistry.md)* = new TypeRegistry()
*Defined in [codec/TypeRegistry.ts:9](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/TypeRegistry.ts#L9)*
*Defined in [codec/TypeRegistry.ts:9](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/TypeRegistry.ts#L9)*
___
@@ -24,7 +24,7 @@ ___
▸ **get**(name: *`string`*): `undefined` &#124; `object`
*Defined in [codec/TypeRegistry.ts:35](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/TypeRegistry.ts#L35)*
*Defined in [codec/TypeRegistry.ts:35](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/TypeRegistry.ts#L35)*
**Parameters:**
@@ -43,7 +43,7 @@ ___
▸ **register**(name: *`string`*, type: *[Constructor](../modules/_types_.md#constructor)*): `void`
*Defined in [codec/TypeRegistry.ts:13](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/TypeRegistry.ts#L13)*
*Defined in [codec/TypeRegistry.ts:13](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/TypeRegistry.ts#L13)*
**Parameters:**
@@ -53,7 +53,7 @@ ___
**Returns:** `void`
*Defined in [codec/TypeRegistry.ts:14](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/TypeRegistry.ts#L14)*
*Defined in [codec/TypeRegistry.ts:14](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/TypeRegistry.ts#L14)*
**Parameters:**
docs/types/classes/_codec_u8a_.u8a.md
+24 -10
View File
@@ -1,5 +1,9 @@
*__name__*: U8a
*__description__*: A basic wrapper around Uint8Array, with no frills and no fuss. It does differ from other implementations wher it will consume the full Uint8Array as passed to it. As such it is meant to be subclassed where the wrapper takes care of the actual lengths instead of used directly.
# Hierarchy
`Uint8Array`
@@ -29,7 +33,7 @@
⊕ **new U8a**(value: *[AnyU8a](../modules/_types_.md#anyu8a)*): [U8a](_codec_u8a_.u8a.md)
*Defined in [codec/U8a.ts:13](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/U8a.ts#L13)*
*Defined in [codec/U8a.ts:17](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/U8a.ts#L17)*
**Parameters:**
@@ -137,7 +141,9 @@ ___
getencodedLength(): `number`
*Defined in [codec/U8a.ts:28](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/U8a.ts#L28)*
*Defined in [codec/U8a.ts:35](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/U8a.ts#L35)*
*__description__*: The length of the value when encoded as a Uint8Array
**Returns:** `number`
@@ -675,7 +681,7 @@ ___
*Overrides Uint8Array.subarray*
*Defined in [codec/U8a.ts:34](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/U8a.ts#L34)*
*Defined in [codec/U8a.ts:41](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/U8a.ts#L41)*
**Parameters:**
@@ -695,7 +701,9 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)*
*Defined in [codec/U8a.ts:38](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/U8a.ts#L38)*
*Defined in [codec/U8a.ts:48](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/U8a.ts#L48)*
*__description__*: Returns a hex string representation of the value
**Returns:** `string`
@@ -708,7 +716,9 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)*
*Defined in [codec/U8a.ts:42](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/U8a.ts#L42)*
*Defined in [codec/U8a.ts:55](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/U8a.ts#L55)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
**Returns:** `any`
@@ -738,7 +748,9 @@ ___
*Overrides Uint8Array.toString*
*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/U8a.ts#L50)*
*Defined in [codec/U8a.ts:62](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/U8a.ts#L62)*
*__description__*: Returns the string representation of the value
**Returns:** `string`
@@ -751,13 +763,15 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)*
*Defined in [codec/U8a.ts:46](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/U8a.ts#L46)*
*Defined in [codec/U8a.ts:70](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/U8a.ts#L70)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
**Parameters:**
| Name | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
| Name | Type | Description |
| ------ | ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`| true when the value has none of the type-specific prefixes (internal) |
**Returns:** `Uint8Array`
docs/types/classes/_codec_u8afixed_.u8afixed.md
+31 -11
View File
@@ -1,5 +1,9 @@
*__name__*: U8aFixed
*__description__*: A U8a that manages a a sequence of bytes up to the specified bitLength. Not meant to be used directly, rather is should be subclassed with the specific lengths.
# Hierarchy
↳ [U8a](_codec_u8a_.u8a.md)
@@ -12,6 +16,10 @@
↳ [H256](_h256_.h256.md)
↳ [EventIndex](_event_.eventindex.md)
↳ [ApiId](_runtimeversion_.apiid.md)
# Implements
* [Codec](../interfaces/_types_.codec.md)
@@ -29,7 +37,7 @@
*Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)*
*Defined in [codec/U8aFixed.ts:15](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/U8aFixed.ts#L15)*
*Defined in [codec/U8aFixed.ts:19](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/U8aFixed.ts#L19)*
**Parameters:**
@@ -131,7 +139,9 @@ getencodedLength(): `number`
*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)*
*Defined in [codec/U8a.ts:28](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/U8a.ts#L28)*
*Defined in [codec/U8a.ts:35](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/U8a.ts#L35)*
*__description__*: The length of the value when encoded as a Uint8Array
**Returns:** `number`
@@ -158,7 +168,9 @@ ___
▸ **bitLength**(): `number`
*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/U8aFixed.ts#L32)*
*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/U8aFixed.ts#L39)*
*__description__*: Returns the number of bits in the value
**Returns:** `number`
@@ -682,7 +694,7 @@ ___
*Overrides Uint8Array.subarray*
*Defined in [codec/U8a.ts:34](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/U8a.ts#L34)*
*Defined in [codec/U8a.ts:41](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/U8a.ts#L41)*
**Parameters:**
@@ -704,7 +716,9 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:38](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/U8a.ts#L38)*
*Defined in [codec/U8a.ts:48](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/U8a.ts#L48)*
*__description__*: Returns a hex string representation of the value
**Returns:** `string`
@@ -719,7 +733,9 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
*Defined in [codec/U8a.ts:42](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/U8a.ts#L42)*
*Defined in [codec/U8a.ts:55](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/U8a.ts#L55)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
**Returns:** `any`
@@ -751,7 +767,9 @@ ___
*Overrides Uint8Array.toString*
*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/U8a.ts#L50)*
*Defined in [codec/U8a.ts:62](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/U8a.ts#L62)*
*__description__*: Returns the string representation of the value
**Returns:** `string`
@@ -766,13 +784,15 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
*Defined in [codec/U8a.ts:46](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/U8a.ts#L46)*
*Defined in [codec/U8a.ts:70](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/U8a.ts#L70)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
**Parameters:**
| Name | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
| Name | Type | Description |
| ------ | ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`| true when the value has none of the type-specific prefixes (internal) |
**Returns:** `Uint8Array`
docs/types/classes/_codec_uint_.uint.md
+27 -11
View File
@@ -1,5 +1,9 @@
*__name__*: UInt
*__description__*: A generic number codec. For Substrate all numbers are LE encoded, this handles the encoding and decoding of those numbers. Upon construction the bitLength is provided and any additional use keeps the number to this length.
# Hierarchy
`BN`
@@ -32,7 +36,7 @@
*Overrides BN.__constructor*
*Defined in [codec/UInt.ts:22](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/UInt.ts#L22)*
*Defined in [codec/UInt.ts:25](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/UInt.ts#L25)*
**Parameters:**
@@ -54,7 +58,9 @@ ___
getencodedLength(): `number`
*Defined in [codec/UInt.ts:53](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/UInt.ts#L53)*
*Defined in [codec/UInt.ts:55](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/UInt.ts#L55)*
*__description__*: The length of the value when encoded as a Uint8Array
**Returns:** `number`
@@ -190,7 +196,9 @@ ___
*Overrides BN.bitLength*
*Defined in [codec/UInt.ts:49](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/UInt.ts#L49)*
*Defined in [codec/UInt.ts:62](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/UInt.ts#L62)*
*__description__*: Returns the number of bits in the value
**Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength)
@@ -1521,7 +1529,9 @@ ___
▸ **toBn**(): `BN`
*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/UInt.ts#L71)*
*Defined in [codec/UInt.ts:69](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/UInt.ts#L69)*
*__description__*: Returns the BN representation of the number. (Compatibility)
**Returns:** `BN`
@@ -1556,7 +1566,9 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)*
*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/UInt.ts#L57)*
*Defined in [codec/UInt.ts:76](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/UInt.ts#L76)*
*__description__*: Returns a hex string representation of the value
**Returns:** `string`
@@ -1571,7 +1583,9 @@ ___
*Overrides BN.toJSON*
*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/UInt.ts#L61)*
*Defined in [codec/UInt.ts:83](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/UInt.ts#L83)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
**Returns:** `any`
@@ -1663,13 +1677,15 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)*
*Defined in [codec/UInt.ts:67](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/UInt.ts#L67)*
*Defined in [codec/UInt.ts:93](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/UInt.ts#L93)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
**Parameters:**
| Name | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
| Name | Type | Description |
| ------ | ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`| true when the value has none of the type-specific prefixes (internal) |
**Returns:** `Uint8Array`
@@ -1863,7 +1879,7 @@ ___
▸ **decodeUInt**(value: *[AnyNumber](../modules/_types_.md#anynumber)*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `string`
*Defined in [codec/UInt.ts:33](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/UInt.ts#L33)*
*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/UInt.ts#L36)*
**Parameters:**
docs/types/classes/_codec_vector_.vector.md
+33 -15
View File
@@ -1,5 +1,9 @@
*__name__*: Vector
*__description__*: This manages codec arrays. Intrernally it keeps track of the length (as decoded) and allows construction with the passed `Type` in the constructor. It is an extension to Array, providing specific encoding/decoding on top of the base type.
# Type parameters
#### T : [Codec](../interfaces/_types_.codec.md)
# Hierarchy
@@ -10,6 +14,8 @@
↳ [Extrinsics](_extrinsics_.extrinsics.md)
↳ [AuthoritiesChange](_digest_.authoritieschange.md)
↳ [Broadcast](_extrinsicstatus_.broadcast.md)
# Implements
@@ -27,7 +33,7 @@
⊕ **new Vector**(Type: *[Constructor](../modules/_types_.md#constructor)<`T`>*, value?: * [Vector](_codec_vector_.vector.md)<`any`> &#124; `Uint8Array` &#124; `string` &#124; `Array`<`any`>*): [Vector](_codec_vector_.vector.md)
*Defined in [codec/Vector.ts:18](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Vector.ts#L18)*
*Defined in [codec/Vector.ts:20](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Vector.ts#L20)*
**Parameters:**
@@ -73,7 +79,7 @@ ___
getType(): `string`
*Defined in [codec/Vector.ts:62](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Vector.ts#L62)*
*Defined in [codec/Vector.ts:64](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Vector.ts#L64)*
**Returns:** `string`
@@ -84,7 +90,9 @@ ___
getencodedLength(): `number`
*Defined in [codec/Vector.ts:66](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Vector.ts#L66)*
*Defined in [codec/Vector.ts:71](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Vector.ts#L71)*
*__description__*: The length of the value when encoded as a Uint8Array
**Returns:** `number`
@@ -250,7 +258,7 @@ ___
*Overrides Array.filter*
*Defined in [codec/Vector.ts:112](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Vector.ts#L112)*
*Defined in [codec/Vector.ts:133](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Vector.ts#L133)*
**Parameters:**
@@ -666,7 +674,7 @@ ___
*Overrides Array.map*
*Defined in [codec/Vector.ts:116](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Vector.ts#L116)*
*Defined in [codec/Vector.ts:137](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Vector.ts#L137)*
**Type parameters:**
@@ -970,7 +978,9 @@ ___
▸ **toArray**(): `Array`<`T`>
*Defined in [codec/Vector.ts:72](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Vector.ts#L72)*
*Defined in [codec/Vector.ts:80](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Vector.ts#L80)*
*__description__*: Converts the Object to an standard JavaScript Array
**Returns:** `Array`<`T`>
@@ -983,7 +993,9 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)*
*Defined in [codec/Vector.ts:76](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Vector.ts#L76)*
*Defined in [codec/Vector.ts:87](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Vector.ts#L87)*
*__description__*: Returns a hex string representation of the value
**Returns:** `string`
@@ -996,7 +1008,9 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)*
*Defined in [codec/Vector.ts:80](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Vector.ts#L80)*
*Defined in [codec/Vector.ts:94](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Vector.ts#L94)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
**Returns:** `any`
@@ -1026,7 +1040,9 @@ ___
*Overrides Array.toString*
*Defined in [codec/Vector.ts:86](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Vector.ts#L86)*
*Defined in [codec/Vector.ts:103](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Vector.ts#L103)*
*__description__*: Returns the string representation of the value
**Returns:** `string`
@@ -1039,13 +1055,15 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)*
*Defined in [codec/Vector.ts:95](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Vector.ts#L95)*
*Defined in [codec/Vector.ts:116](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Vector.ts#L116)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
**Parameters:**
| Name | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
| Name | Type | Description |
| ------ | ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`| true when the value has none of the type-specific prefixes (internal) |
**Returns:** `Uint8Array`
@@ -1092,7 +1110,7 @@ ___
▸ **decodeVector**<`T`>(Type: *[Constructor](../modules/_types_.md#constructor)<`T`>*, value: * [Vector](_codec_vector_.vector.md)<`any`> &#124; `Uint8Array` &#124; `string` &#124; `Array`<`any`>*): `Array`<`T`>
*Defined in [codec/Vector.ts:28](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Vector.ts#L28)*
*Defined in [codec/Vector.ts:30](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Vector.ts#L30)*
**Type parameters:**
@@ -1113,7 +1131,7 @@ ___
▸ **with**<`O`>(Type: *[Constructor](../modules/_types_.md#constructor)<`O`>*): [Constructor](../modules/_types_.md#constructor)<[Vector](_codec_vector_.vector.md)<`O`>>
*Defined in [codec/Vector.ts:54](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Vector.ts#L54)*
*Defined in [codec/Vector.ts:56](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Vector.ts#L56)*
**Type parameters:**
docs/types/classes/_data_.data.md
+24 -10
View File
@@ -1,5 +1,9 @@
*__name__*: Data
*__description__*: A raw data structure. It is just an encoding of a U8a, without any length encoding
# Hierarchy
↳ [U8a](_codec_u8a_.u8a.md)
@@ -23,7 +27,7 @@
*Inherited from [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)*
*Defined in [codec/U8a.ts:13](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/U8a.ts#L13)*
*Defined in [codec/U8a.ts:17](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/U8a.ts#L17)*
**Parameters:**
@@ -124,7 +128,9 @@ getencodedLength(): `number`
*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)*
*Defined in [codec/U8a.ts:28](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/U8a.ts#L28)*
*Defined in [codec/U8a.ts:35](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/U8a.ts#L35)*
*__description__*: The length of the value when encoded as a Uint8Array
**Returns:** `number`
@@ -664,7 +670,7 @@ ___
*Overrides Uint8Array.subarray*
*Defined in [codec/U8a.ts:34](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/U8a.ts#L34)*
*Defined in [codec/U8a.ts:41](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/U8a.ts#L41)*
**Parameters:**
@@ -686,7 +692,9 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:38](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/U8a.ts#L38)*
*Defined in [codec/U8a.ts:48](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/U8a.ts#L48)*
*__description__*: Returns a hex string representation of the value
**Returns:** `string`
@@ -701,7 +709,9 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
*Defined in [codec/U8a.ts:42](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/U8a.ts#L42)*
*Defined in [codec/U8a.ts:55](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/U8a.ts#L55)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
**Returns:** `any`
@@ -733,7 +743,9 @@ ___
*Overrides Uint8Array.toString*
*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/U8a.ts#L50)*
*Defined in [codec/U8a.ts:62](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/U8a.ts#L62)*
*__description__*: Returns the string representation of the value
**Returns:** `string`
@@ -748,13 +760,15 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
*Defined in [codec/U8a.ts:46](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/U8a.ts#L46)*
*Defined in [codec/U8a.ts:70](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/U8a.ts#L70)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
**Parameters:**
| Name | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
| Name | Type | Description |
| ------ | ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`| true when the value has none of the type-specific prefixes (internal) |
**Returns:** `Uint8Array`
docs/types/classes/_digest_.authoritieschange.md
+1157
View File
File diff suppressed because it is too large Load Diff
docs/types/classes/_digest_.changestrieroot.md
+808
View File
@@ -0,0 +1,808 @@
*__name__*: ChangesTrieRoot
*__description__*: Log for changes to the Trie root
# Hierarchy
↳ [Hash](_hash_.hash.md)
**↳ ChangesTrieRoot**
# Implements
* [Codec](../interfaces/_types_.codec.md)
# Indexable
\[index: `number`\]:&nbsp;`number`
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new ChangesTrieRoot**(value?: *[AnyU8a](../modules/_types_.md#anyu8a)*): [ChangesTrieRoot](_digest_.changestrieroot.md)
*Inherited from [H256](_h256_.h256.md).[constructor](_h256_.h256.md#constructor)*
*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)*
*Defined in [H256.ts:15](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/H256.ts#L15)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| `Optional` value | [AnyU8a](../modules/_types_.md#anyu8a) |
**Returns:** [ChangesTrieRoot](_digest_.changestrieroot.md)
___
# Properties
<a id="bytes_per_element"></a>
## BYTES_PER_ELEMENT
**● BYTES_PER_ELEMENT**: *`number`*
*Inherited from Uint8Array.BYTES_PER_ELEMENT*
*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1886*
The size in bytes of each element in the array.
___
<a id="___tostringtag"></a>
## __@toStringTag
**● __@toStringTag**: *"UInt8Array"*
*Inherited from Uint8Array.[Symbol.toStringTag]*
*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276*
___
<a id="buffer"></a>
## buffer
**● buffer**: *`ArrayBufferLike`*
*Inherited from Uint8Array.buffer*
*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1891*
The ArrayBuffer instance referenced by the array.
___
<a id="bytelength"></a>
## byteLength
**● byteLength**: *`number`*
*Inherited from Uint8Array.byteLength*
*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1896*
The length in bytes of the array.
___
<a id="byteoffset"></a>
## byteOffset
**● byteOffset**: *`number`*
*Inherited from Uint8Array.byteOffset*
*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1901*
The offset in bytes of the array.
___
<a id="length"></a>
## length
**● length**: *`number`*
*Inherited from Uint8Array.length*
*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2000*
The length of the array.
___
# Accessors
<a id="encodedlength"></a>
## encodedLength
getencodedLength(): `number`
*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)*
*Defined in [codec/U8a.ts:35](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/U8a.ts#L35)*
*__description__*: The length of the value when encoded as a Uint8Array
**Returns:** `number`
___
# Methods
<a id="___iterator"></a>
## __@iterator
▸ **__@iterator**(): `IterableIterator`<`number`>
*Inherited from Uint8Array.[Symbol.iterator]*
*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267*
**Returns:** `IterableIterator`<`number`>
___
<a id="bitlength"></a>
## bitLength
▸ **bitLength**(): `number`
*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/6cab9be/packages/types/src/codec/U8aFixed.ts#L39)*
*__description__*: Returns the number of bits in the value
**Returns:** `number`
___
<a id="copywithin"></a>
## copyWithin
▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: * `undefined` &#124; `number`*): `this`
*Inherited from Uint8Array.copyWithin*
*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1912*
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target
**Parameters:**
| Name | Type | Description |
| ------ | ------ | ------ |
| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. |
| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. |
| `Optional` end | `undefined` &#124; `number`| If not specified, length of the this object is used as its default value. |
**Returns:** `this`
___
<a id="entries"></a>
## entries
▸ **entries**(): `IterableIterator`<[`number`, `number`]>
*Inherited from Uint8Array.entries*
*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271*
Returns an array of key, value pairs for every entry in the array
**Returns:** `IterableIterator`<[`number`, `number`]>
___
<a id="every"></a>
## every
▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean`
*Inherited from Uint8Array.every*
*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1922*
Determines whether all the members of an array satisfy the specified test.
**Parameters:**
| Name | Type | Description |
| ------ | ------ | ------ |
| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. |
| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. |
**Returns:** `boolean`
___
<a id="fill"></a>
## fill
▸ **fill**(value: *`number`*, start?: * `undefined` &#124; `number`*, end?: * `undefined` &#124; `number`*): `this`
*Inherited from Uint8Array.fill*
*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1932*
Returns the this object after filling the section identified by start and end with value
**Parameters:**
| Name | Type | Description |
| ------ | ------ | ------ |
| value | `number` | value to fill array section with |
| `Optional` start | `undefined` &#124; `number`| index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. |
| `Optional` end | `undefined` &#124; `number`| index to stop filling the array at. If end is negative, it is treated as length+end. |
**Returns:** `this`
___
<a id="filter"></a>
## filter
▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array`
*Inherited from Uint8Array.filter*
*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1941*
Returns the elements of an array that meet the condition specified in a callback function.
**Parameters:**
| Name | Type | Description |
| ------ | ------ | ------ |
| callbackfn | `function` | A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array. |
| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. |
**Returns:** `Uint8Array`
___
<a id="find"></a>
## find
▸ **find**(predicate: *`function`*, thisArg?: *`any`*): `number` &#124; `undefined`
*Inherited from Uint8Array.find*
*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1952*
Returns the value of the first element in the array where predicate is true, and undefined otherwise.
**Parameters:**
| Name | Type | Description |
| ------ | ------ | ------ |
| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. |
| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. |
**Returns:** `number` &#124; `undefined`
___
<a id="findindex"></a>
## findIndex
▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number`
*Inherited from Uint8Array.findIndex*
*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1963*
Returns the index of the first element in the array where predicate is true, and -1 otherwise.
**Parameters:**
| Name | Type | Description |
| ------ | ------ | ------ |
| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. |
| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. |
**Returns:** `number`
___
<a id="foreach"></a>
## forEach
▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void`
*Inherited from Uint8Array.forEach*
*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972*
Performs the specified action for each element in an array.
**Parameters:**
| Name | Type | Description |
| ------ | ------ | ------ |
| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. |
| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. |
**Returns:** `void`
___
<a id="includes"></a>
## includes
▸ **includes**(searchElement: *`number`*, fromIndex?: * `undefined` &#124; `number`*): `boolean`
*Inherited from Uint8Array.includes*
*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54*
Determines whether an array includes a certain element, returning true or false as appropriate.
**Parameters:**
| Name | Type | Description |
| ------ | ------ | ------ |
| searchElement | `number` | The element to search for. |
| `Optional` fromIndex | `undefined` &#124; `number`| The position in this array at which to begin searching for searchElement. |
**Returns:** `boolean`
___
<a id="indexof"></a>
## indexOf
▸ **indexOf**(searchElement: *`number`*, fromIndex?: * `undefined` &#124; `number`*): `number`
*Inherited from Uint8Array.indexOf*
*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1980*
Returns the index of the first occurrence of a value in an array.
**Parameters:**
| Name | Type | Description |
| ------ | ------ | ------ |
| searchElement | `number` | The value to locate in the array. |
| `Optional` fromIndex | `undefined` &#124; `number`| The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. |
**Returns:** `number`
___
<a id="join"></a>
## join
▸ **join**(separator?: * `undefined` &#124; `string`*): `string`
*Inherited from Uint8Array.join*
*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1987*
Adds all the elements of an array separated by the specified separator string.
**Parameters:**
| Name | Type | Description |
| ------ | ------ | ------ |
| `Optional` separator | `undefined` &#124; `string`| A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. |
**Returns:** `string`
___
<a id="keys"></a>
## keys
▸ **keys**(): `IterableIterator`<`number`>
*Inherited from Uint8Array.keys*
*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275*
Returns an list of keys in the array
**Returns:** `IterableIterator`<`number`>
___
<a id="lastindexof"></a>
## lastIndexOf
▸ **lastIndexOf**(searchElement: *`number`*, fromIndex?: * `undefined` &#124; `number`*): `number`
*Inherited from Uint8Array.lastIndexOf*
*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1995*
Returns the index of the last occurrence of a value in an array.
**Parameters:**
| Name | Type | Description |
| ------ | ------ | ------ |
| searchElement | `number` | The value to locate in the array. |
| `Optional` fromIndex | `undefined` &#124; `number`| The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. |
**Returns:** `number`
___
<a id="map"></a>
## map
▸ **map**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array`
*Inherited from Uint8Array.map*
*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2010*
Calls a defined callback function on each element of an array, and returns an array that contains the results.
**Parameters:**
| Name | Type | Description |
| ------ | ------ | ------ |
| callbackfn | `function` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. |
| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. |
**Returns:** `Uint8Array`
___
<a id="reduce"></a>
## reduce
▸ **reduce**(callbackfn: *`function`*): `number`
▸ **reduce**(callbackfn: *`function`*, initialValue: *`number`*): `number`
▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U`
*Inherited from Uint8Array.reduce*
*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2022*
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
**Parameters:**
| Name | Type | Description |
| ------ | ------ | ------ |
| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. |
**Returns:** `number`
*Inherited from Uint8Array.reduce*
*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2023*
**Parameters:**
| Name | Type |
| ------ | ------ |
| callbackfn | `function` |
| initialValue | `number` |
**Returns:** `number`
*Inherited from Uint8Array.reduce*
*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2035*
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
**Type parameters:**
#### U
**Parameters:**
| Name | Type | Description |
| ------ | ------ | ------ |
| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. |
| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. |
**Returns:** `U`
___
<a id="reduceright"></a>
## reduceRight
▸ **reduceRight**(callbackfn: *`function`*): `number`
▸ **reduceRight**(callbackfn: *`function`*, initialValue: *`number`*): `number`
▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U`
*Inherited from Uint8Array.reduceRight*
*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2047*
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
**Parameters:**
| Name | Type | Description |
| ------ | ------ | ------ |
| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. |
**Returns:** `number`
*Inherited from Uint8Array.reduceRight*
*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048*
**Parameters:**
| Name | Type |
| ------ | ------ |
| callbackfn | `function` |
| initialValue | `number` |
**Returns:** `number`
*Inherited from Uint8Array.reduceRight*
*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2060*
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
**Type parameters:**
#### U
**Parameters:**
| Name | Type | Description |
| ------ | ------ | ------ |
| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. |
| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. |
**Returns:** `U`
___
<a id="reverse"></a>
## reverse
▸ **reverse**(): `Uint8Array`
*Inherited from Uint8Array.reverse*
*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2065*
Reverses the elements in an Array.
**Returns:** `Uint8Array`
___
<a id="set"></a>
## set
▸ **set**(array: *`ArrayLike`<`number`>*, offset?: * `undefined` &#124; `number`*): `void`
*Inherited from Uint8Array.set*
*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2072*
Sets a value or an array of values.
**Parameters:**
| Name | Type | Description |
| ------ | ------ | ------ |
| array | `ArrayLike`<`number`> | A typed or untyped array of values to set. |
| `Optional` offset | `undefined` &#124; `number`| The index in the current array at which the values are to be written. |
**Returns:** `void`
___
<a id="slice"></a>
## slice
▸ **slice**(start?: * `undefined` &#124; `number`*, end?: * `undefined` &#124; `number`*): `Uint8Array`
*Inherited from Uint8Array.slice*
*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2079*
Returns a section of an array.
**Parameters:**
| Name | Type | Description |
| ------ | ------ | ------ |
| `Optional` start | `undefined` &#124; `number`| The beginning of the specified portion of the array. |
| `Optional` end | `undefined` &#124; `number`| The end of the specified portion of the array. |
**Returns:** `Uint8Array`
___
<a id="some"></a>
## some
▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean`
*Inherited from Uint8Array.some*
*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2089*
Determines whether the specified callback function returns true for any element of an array.
**Parameters:**
| Name | Type | Description |
| ------ | ------ | ------ |
| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. |
| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. |
**Returns:** `boolean`
___
<a id="sort"></a>
## sort
▸ **sort**(compareFn?: * `undefined` &#124; `function`*): `this`
*Inherited from Uint8Array.sort*
*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2096*
Sorts an array.
**Parameters:**
| Name | Type | Description |
| ------ | ------ | ------ |
| `Optional` compareFn | `undefined` &#124; `function`| The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. |
**Returns:** `this`
___
<a id="subarray"></a>
## subarray
▸ **subarray**(begin: *`number`*, end?: * `undefined` &#124; `number`*): `Uint8Array`
*Inherited from [U8a](_codec_u8a_.u8a.md).[subarray](_codec_u8a_.u8a.md#subarray)*
*Overrides Uint8Array.subarray*
*Defined in [codec/U8a.ts:41](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/U8a.ts#L41)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| begin | `number` |
| `Optional` end | `undefined` &#124; `number`|
**Returns:** `Uint8Array`
___
<a id="tohex"></a>
## toHex
▸ **toHex**(): `string`
*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)*
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:48](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/U8a.ts#L48)*
*__description__*: Returns a hex string representation of the value
**Returns:** `string`
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)*
*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
*Defined in [codec/U8a.ts:55](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/U8a.ts#L55)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
**Returns:** `any`
___
<a id="tolocalestring"></a>
## toLocaleString
▸ **toLocaleString**(): `string`
*Inherited from Uint8Array.toLocaleString*
*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2109*
Converts a number to a string by using the current locale.
**Returns:** `string`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)*
*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)*
*Overrides Uint8Array.toString*
*Defined in [codec/U8a.ts:62](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/U8a.ts#L62)*
*__description__*: Returns the string representation of the value
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)*
*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
*Defined in [codec/U8a.ts:70](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/U8a.ts#L70)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
**Parameters:**
| Name | Type | Description |
| ------ | ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`| true when the value has none of the type-specific prefixes (internal) |
**Returns:** `Uint8Array`
___
<a id="values"></a>
## values
▸ **values**(): `IterableIterator`<`number`>
*Inherited from Uint8Array.values*
*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279*
Returns an list of values in the array
**Returns:** `IterableIterator`<`number`>
___
docs/types/classes/_digest_.digest.md
+32 -14
View File
@@ -1,5 +1,9 @@
*__name__*: Digest
*__description__*: A [Header](_header_.header.md) Digest
# Type parameters
#### S : [ConstructorDef](../modules/_types_.md#constructordef)
#### T : `object`
@@ -25,7 +29,7 @@
*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)*
*Defined in [Digest.ts:53](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Digest.ts#L53)*
*Defined in [Digest.ts:83](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Digest.ts#L83)*
**Parameters:**
@@ -72,7 +76,7 @@ getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L125)*
*Defined in [codec/Struct.ts:129](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L129)*
**Returns:** `E`
@@ -85,7 +89,9 @@ getencodedLength(): `number`
*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)*
*Defined in [codec/Struct.ts:129](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L129)*
*Defined in [codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L136)*
*__description__*: The length of the value when encoded as a Uint8Array
**Returns:** `number`
@@ -96,7 +102,7 @@ ___
getlogs(): [Vector](_codec_vector_.vector.md)<[DigestItem](_digest_.digestitem.md)>
*Defined in [Digest.ts:60](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Digest.ts#L60)*
*Defined in [Digest.ts:90](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Digest.ts#L90)*
**Returns:** [Vector](_codec_vector_.vector.md)<[DigestItem](_digest_.digestitem.md)>
@@ -213,7 +219,9 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)*
*Defined in [codec/Struct.ts:135](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L135)*
*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L145)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
**Parameters:**
@@ -286,7 +294,9 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)*
*Defined in [codec/Struct.ts:139](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L139)*
*Defined in [codec/Struct.ts:152](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L152)*
*__description__*: Converts the Object to an standard JavaScript Array
**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)>
@@ -301,7 +311,9 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)*
*Defined in [codec/Struct.ts:143](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L143)*
*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L159)*
*__description__*: Returns a hex string representation of the value
**Returns:** `string`
@@ -316,7 +328,9 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L147)*
*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L166)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
**Returns:** `any`
@@ -331,7 +345,9 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)*
*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L158)*
*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L180)*
*__description__*: Returns the string representation of the value
**Returns:** `string`
@@ -346,13 +362,15 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
*Defined in [codec/Struct.ts:162](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L162)*
*Defined in [codec/Struct.ts:188](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L188)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
**Parameters:**
| Name | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
| Name | Type | Description |
| ------ | ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`| true when the value has none of the type-specific prefixes (internal) |
**Returns:** `Uint8Array`
@@ -380,7 +398,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Struct.ts:108](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L108)*
*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L112)*
**Type parameters:**
docs/types/classes/_digest_.digestitem.md
+52 -15
View File
@@ -1,8 +1,12 @@
*__name__*: DigestItem
*__description__*: A [EnumType](_codec_enumtype_.enumtype.md) the specifies the specific item in the logs of a [Digest](_digest_.digest.md)
# Hierarchy
↳ [EnumType](_codec_enumtype_.enumtype.md)< `AuthoritiesChange` &#124; `ChangesTrieRoot` &#124; `Other` &#124; `Seal`>
↳ [EnumType](_codec_enumtype_.enumtype.md)< [AuthoritiesChange](_digest_.authoritieschange.md) &#124; [ChangesTrieRoot](_digest_.changestrieroot.md) &#124; [Other](_digest_.other.md) &#124; [Seal](_digest_.seal.md)>
**↳ DigestItem**
@@ -20,7 +24,7 @@
*Overrides [EnumType](_codec_enumtype_.enumtype.md).[constructor](_codec_enumtype_.enumtype.md#constructor)*
*Defined in [Digest.ts:42](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/Digest.ts#L42)*
*Defined in [Digest.ts:67](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/Digest.ts#L67)*
**Parameters:**
@@ -42,10 +46,27 @@ getencodedLength(): `number`
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[encodedLength](_codec_enumtype_.enumtype.md#encodedlength)*
*Defined in [codec/EnumType.ts:93](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/EnumType.ts#L93)*
*Defined in [codec/EnumType.ts:87](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/EnumType.ts#L87)*
*__description__*: The length of the value when encoded as a Uint8Array
**Returns:** `number`
___
<a id="isnone"></a>
## isNone
getisNone(): `boolean`
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNone](_codec_enumtype_.enumtype.md#isnone)*
*Defined in [codec/EnumType.ts:94](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/EnumType.ts#L94)*
*__description__*: Checks if the Enum points to a [Null](_null_.null.md) type
**Returns:** `boolean`
___
<a id="isnull"></a>
@@ -55,7 +76,9 @@ getisNull(): `boolean`
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNull](_codec_enumtype_.enumtype.md#isnull)*
*Defined in [codec/EnumType.ts:81](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/EnumType.ts#L81)*
*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/EnumType.ts#L101)*
*__description__*: Checks if the Enum points to a [Null](_null_.null.md) type (deprecated, use isNone)
**Returns:** `boolean`
@@ -68,7 +91,9 @@ gettype(): `string`
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[type](_codec_enumtype_.enumtype.md#type)*
*Defined in [codec/EnumType.ts:85](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/EnumType.ts#L85)*
*Defined in [codec/EnumType.ts:108](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/EnumType.ts#L108)*
*__description__*: The name of the type this enum value represents
**Returns:** `string`
@@ -81,7 +106,9 @@ getvalue(): [Codec](../interfaces/_types_.codec.md)
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[value](_codec_enumtype_.enumtype.md#value)*
*Defined in [codec/EnumType.ts:89](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/EnumType.ts#L89)*
*Defined in [codec/EnumType.ts:115](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/EnumType.ts#L115)*
*__description__*: The value of the enum
**Returns:** [Codec](../interfaces/_types_.codec.md)
@@ -99,7 +126,9 @@ ___
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toHex](_codec_enumtype_.enumtype.md#tohex)*
*Defined in [codec/EnumType.ts:97](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/EnumType.ts#L97)*
*Defined in [codec/EnumType.ts:122](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/EnumType.ts#L122)*
*__description__*: Returns a hex string representation of the value
**Returns:** `string`
@@ -114,7 +143,9 @@ ___
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toJSON](_codec_enumtype_.enumtype.md#tojson)*
*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/EnumType.ts#L101)*
*Defined in [codec/EnumType.ts:129](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/EnumType.ts#L129)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
**Returns:** `any`
@@ -127,7 +158,9 @@ ___
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)*
*Defined in [codec/EnumType.ts:105](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/EnumType.ts#L105)*
*Defined in [codec/EnumType.ts:136](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/EnumType.ts#L136)*
*__description__*: Returns the number representation for the value
**Returns:** `number`
@@ -142,7 +175,9 @@ ___
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toString](_codec_enumtype_.enumtype.md#tostring)*
*Defined in [codec/EnumType.ts:109](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/EnumType.ts#L109)*
*Defined in [codec/EnumType.ts:143](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/EnumType.ts#L143)*
*__description__*: Returns the string representation of the value
**Returns:** `string`
@@ -157,13 +192,15 @@ ___
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toU8a](_codec_enumtype_.enumtype.md#tou8a)*
*Defined in [codec/EnumType.ts:113](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/EnumType.ts#L113)*
*Defined in [codec/EnumType.ts:151](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/EnumType.ts#L151)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
**Parameters:**
| Name | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
| Name | Type | Description |
| ------ | ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`| true when the value has none of the type-specific prefixes (internal) |
**Returns:** `Uint8Array`
@@ -176,7 +213,7 @@ ___
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[decodeEnumType](_codec_enumtype_.enumtype.md#decodeenumtype)*
*Defined in [codec/EnumType.ts:44](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/EnumType.ts#L44)*
*Defined in [codec/EnumType.ts:47](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/EnumType.ts#L47)*
**Type parameters:**

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