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

[CI Skip] 0.42.5

Browse Source
This commit is contained in:
Travis CI
2019-02-09 05:21:50 +00:00
parent c1672e8eee
commit fd4cc604dd
410 changed files with 3773 additions and 3568 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/GLOSSARY.html
+1 -1
View File
@@ -2168,7 +2168,7 @@
<script> <script>
var gitbook = gitbook || []; var gitbook = gitbook || [];
gitbook.push(function() { 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":"2019-02-08T14:45:12.580Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-08T14:49:34.586Z"},"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":"2019-02-09T05:16:44.127Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-09T05:21:07.515Z"},"basePath":".","book":{"language":""}});
}); });
</script> </script>
</div> </div>
docs/METHODS_EVENTS.html
+1 -1
View File
@@ -2377,7 +2377,7 @@
<script> <script>
var gitbook = gitbook || []; var gitbook = gitbook || [];
gitbook.push(function() { 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":"Unsubscribe from listening","level":"3.1.4","depth":2,"path":"examples/promise/04_unsubscribe/README.md","ref":"examples/promise/04_unsubscribe/README.md","articles":[]},{"title":"Read chain state","level":"3.1.5","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.6","depth":2,"path":"examples/promise/06_make_transfer/README.md","ref":"examples/promise/06_make_transfer/README.md","articles":[]},{"title":"Display system events","level":"3.1.7","depth":2,"path":"examples/promise/08_system_events/README.md","ref":"examples/promise/08_system_events/README.md","articles":[]},{"title":"Transaction with events","level":"3.1.8","depth":2,"path":"examples/promise/09_transfer_events/README.md","ref":"examples/promise/09_transfer_events/README.md","articles":[]},{"title":"Upgrade via sudo","level":"3.1.9","depth":2,"path":"examples/promise/10_upgrade_chain/README.md","ref":"examples/promise/10_upgrade_chain/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":"2019-02-08T14:47:54.338Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-08T14:49:34.586Z"},"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":"Unsubscribe from listening","level":"3.1.4","depth":2,"path":"examples/promise/04_unsubscribe/README.md","ref":"examples/promise/04_unsubscribe/README.md","articles":[]},{"title":"Read chain state","level":"3.1.5","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.6","depth":2,"path":"examples/promise/06_make_transfer/README.md","ref":"examples/promise/06_make_transfer/README.md","articles":[]},{"title":"Display system events","level":"3.1.7","depth":2,"path":"examples/promise/08_system_events/README.md","ref":"examples/promise/08_system_events/README.md","articles":[]},{"title":"Transaction with events","level":"3.1.8","depth":2,"path":"examples/promise/09_transfer_events/README.md","ref":"examples/promise/09_transfer_events/README.md","articles":[]},{"title":"Upgrade via sudo","level":"3.1.9","depth":2,"path":"examples/promise/10_upgrade_chain/README.md","ref":"examples/promise/10_upgrade_chain/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":"2019-02-09T05:19:25.926Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-09T05:21:07.515Z"},"basePath":".","book":{"language":""}});
}); });
</script> </script>
</div> </div>
docs/METHODS_EXTRINSICS.html
+1 -1
View File
@@ -2443,7 +2443,7 @@
<script> <script>
var gitbook = gitbook || []; var gitbook = gitbook || [];
gitbook.push(function() { 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":"2019-02-08T14:47:54.338Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-08T14:49:34.586Z"},"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":"2019-02-09T05:19:25.926Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-09T05:21:07.515Z"},"basePath":".","book":{"language":""}});
}); });
</script> </script>
</div> </div>
docs/METHODS_RPC.html
+1 -1
View File
@@ -2302,7 +2302,7 @@
<script> <script>
var gitbook = gitbook || []; var gitbook = gitbook || [];
gitbook.push(function() { gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"RPC","level":"2.1","depth":1,"next":{"title":"Chain state (runtime)","level":"2.2","depth":1,"path":"METHODS_STORAGE.md","ref":"METHODS_STORAGE.md","articles":[]},"previous":{"title":"types (codec implementation)","level":"1.4","depth":1,"path":"types/README.md","ref":"types/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"METHODS_RPC.md","mtime":"2019-02-08T14:47:54.338Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-08T14:49:34.586Z"},"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":"2019-02-09T05:19:25.926Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-09T05:21:07.515Z"},"basePath":".","book":{"language":""}});
}); });
</script> </script>
</div> </div>
docs/METHODS_STORAGE.html
+1 -1
View File
@@ -2670,7 +2670,7 @@
<script> <script>
var gitbook = gitbook || []; var gitbook = gitbook || [];
gitbook.push(function() { 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":"2019-02-08T14:47:54.358Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-08T14:49:34.586Z"},"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":"2019-02-09T05:19:25.930Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-09T05:21:07.515Z"},"basePath":".","book":{"language":""}});
}); });
</script> </script>
</div> </div>
docs/api-derive/interfaces/_index_.derive.md
+6 -6
View File
@@ -12,7 +12,7 @@
**● accounts**: *`ReturnTypes`<[&quot;accounts/index&quot;](../modules/_accounts_index_.md)>* **● accounts**: *`ReturnTypes`<[&quot;accounts/index&quot;](../modules/_accounts_index_.md)>*
*Defined in [index.ts:27](https://github.com/polkadot-js/api/blob/b2f0618/packages/api-derive/src/index.ts#L27)* *Defined in [index.ts:27](https://github.com/polkadot-js/api/blob/c1672e8/packages/api-derive/src/index.ts#L27)*
___ ___
<a id="balances"></a> <a id="balances"></a>
@@ -21,7 +21,7 @@ ___
**● balances**: *`ReturnTypes`<[&quot;balances/index&quot;](../modules/_balances_index_.md)>* **● balances**: *`ReturnTypes`<[&quot;balances/index&quot;](../modules/_balances_index_.md)>*
*Defined in [index.ts:28](https://github.com/polkadot-js/api/blob/b2f0618/packages/api-derive/src/index.ts#L28)* *Defined in [index.ts:28](https://github.com/polkadot-js/api/blob/c1672e8/packages/api-derive/src/index.ts#L28)*
___ ___
<a id="chain"></a> <a id="chain"></a>
@@ -30,7 +30,7 @@ ___
**● chain**: *`ReturnTypes`<[&quot;chain/index&quot;](../modules/_chain_index_.md)>* **● chain**: *`ReturnTypes`<[&quot;chain/index&quot;](../modules/_chain_index_.md)>*
*Defined in [index.ts:29](https://github.com/polkadot-js/api/blob/b2f0618/packages/api-derive/src/index.ts#L29)* *Defined in [index.ts:29](https://github.com/polkadot-js/api/blob/c1672e8/packages/api-derive/src/index.ts#L29)*
___ ___
<a id="democracy"></a> <a id="democracy"></a>
@@ -39,7 +39,7 @@ ___
**● democracy**: *`ReturnTypes`<[&quot;democracy/index&quot;](../modules/_democracy_index_.md)>* **● democracy**: *`ReturnTypes`<[&quot;democracy/index&quot;](../modules/_democracy_index_.md)>*
*Defined in [index.ts:30](https://github.com/polkadot-js/api/blob/b2f0618/packages/api-derive/src/index.ts#L30)* *Defined in [index.ts:30](https://github.com/polkadot-js/api/blob/c1672e8/packages/api-derive/src/index.ts#L30)*
___ ___
<a id="session"></a> <a id="session"></a>
@@ -48,7 +48,7 @@ ___
**● session**: *`ReturnTypes`<[&quot;session/index&quot;](../modules/_session_index_.md)>* **● session**: *`ReturnTypes`<[&quot;session/index&quot;](../modules/_session_index_.md)>*
*Defined in [index.ts:31](https://github.com/polkadot-js/api/blob/b2f0618/packages/api-derive/src/index.ts#L31)* *Defined in [index.ts:31](https://github.com/polkadot-js/api/blob/c1672e8/packages/api-derive/src/index.ts#L31)*
___ ___
<a id="staking"></a> <a id="staking"></a>
@@ -57,7 +57,7 @@ ___
**● staking**: *`ReturnTypes`<[&quot;staking/index&quot;](../modules/_staking_index_.md)>* **● staking**: *`ReturnTypes`<[&quot;staking/index&quot;](../modules/_staking_index_.md)>*
*Defined in [index.ts:32](https://github.com/polkadot-js/api/blob/b2f0618/packages/api-derive/src/index.ts#L32)* *Defined in [index.ts:32](https://github.com/polkadot-js/api/blob/c1672e8/packages/api-derive/src/index.ts#L32)*
___ ___
docs/api-derive/modules/_accounts_idandindex_.md
+2 -2
View File
@@ -8,7 +8,7 @@
**Ƭ AccountIdAndIndex**: *[`undefined` | `AccountId`, `undefined` | `AccountIndex`]* **Ƭ AccountIdAndIndex**: *[`undefined` | `AccountId`, `undefined` | `AccountIndex`]*
*Defined in [accounts/idAndIndex.ts:16](https://github.com/polkadot-js/api/blob/b2f0618/packages/api-derive/src/accounts/idAndIndex.ts#L16)* *Defined in [accounts/idAndIndex.ts:16](https://github.com/polkadot-js/api/blob/c1672e8/packages/api-derive/src/accounts/idAndIndex.ts#L16)*
___ ___
@@ -20,7 +20,7 @@ ___
▸ **idAndIndex**(api: *`ApiInterface$Rx`*): `(Anonymous function)` ▸ **idAndIndex**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [accounts/idAndIndex.ts:18](https://github.com/polkadot-js/api/blob/b2f0618/packages/api-derive/src/accounts/idAndIndex.ts#L18)* *Defined in [accounts/idAndIndex.ts:18](https://github.com/polkadot-js/api/blob/c1672e8/packages/api-derive/src/accounts/idAndIndex.ts#L18)*
**Parameters:** **Parameters:**
docs/api-derive/modules/_accounts_idtoindex_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **idToIndex**(api: *`ApiInterface$Rx`*): `(Anonymous function)` ▸ **idToIndex**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [accounts/idToIndex.ts:13](https://github.com/polkadot-js/api/blob/b2f0618/packages/api-derive/src/accounts/idToIndex.ts#L13)* *Defined in [accounts/idToIndex.ts:13](https://github.com/polkadot-js/api/blob/c1672e8/packages/api-derive/src/accounts/idToIndex.ts#L13)*
**Parameters:** **Parameters:**
docs/api-derive/modules/_accounts_indexes_.md
+2 -2
View File
@@ -8,7 +8,7 @@
**Ƭ AccountIndexes**: *`object`* **Ƭ AccountIndexes**: *`object`*
*Defined in [accounts/indexes.ts:13](https://github.com/polkadot-js/api/blob/b2f0618/packages/api-derive/src/accounts/indexes.ts#L13)* *Defined in [accounts/indexes.ts:13](https://github.com/polkadot-js/api/blob/c1672e8/packages/api-derive/src/accounts/indexes.ts#L13)*
#### Type declaration #### Type declaration
@@ -24,7 +24,7 @@ ___
▸ **indexes**(api: *`ApiInterface$Rx`*): `(Anonymous function)` ▸ **indexes**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [accounts/indexes.ts:15](https://github.com/polkadot-js/api/blob/b2f0618/packages/api-derive/src/accounts/indexes.ts#L15)* *Defined in [accounts/indexes.ts:15](https://github.com/polkadot-js/api/blob/c1672e8/packages/api-derive/src/accounts/indexes.ts#L15)*
**Parameters:** **Parameters:**
docs/api-derive/modules/_accounts_indextoid_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **indexToId**(api: *`ApiInterface$Rx`*): `(Anonymous function)` ▸ **indexToId**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [accounts/indexToId.ts:14](https://github.com/polkadot-js/api/blob/b2f0618/packages/api-derive/src/accounts/indexToId.ts#L14)* *Defined in [accounts/indexToId.ts:14](https://github.com/polkadot-js/api/blob/c1672e8/packages/api-derive/src/accounts/indexToId.ts#L14)*
**Parameters:** **Parameters:**
docs/api-derive/modules/_balances_fees_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **fees**(api: *`ApiInterface$Rx`*): `(Anonymous function)` ▸ **fees**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [balances/fees.ts:13](https://github.com/polkadot-js/api/blob/b2f0618/packages/api-derive/src/balances/fees.ts#L13)* *Defined in [balances/fees.ts:13](https://github.com/polkadot-js/api/blob/c1672e8/packages/api-derive/src/balances/fees.ts#L13)*
**Parameters:** **Parameters:**
docs/api-derive/modules/_balances_validatingbalance_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **validatingBalance**(api: *`ApiInterface$Rx`*): `(Anonymous function)` ▸ **validatingBalance**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [balances/validatingBalance.ts:16](https://github.com/polkadot-js/api/blob/b2f0618/packages/api-derive/src/balances/validatingBalance.ts#L16)* *Defined in [balances/validatingBalance.ts:16](https://github.com/polkadot-js/api/blob/c1672e8/packages/api-derive/src/balances/validatingBalance.ts#L16)*
**Parameters:** **Parameters:**
docs/api-derive/modules/_balances_validatingbalances_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **validatingBalances**(api: *`ApiInterface$Rx`*): `(Anonymous function)` ▸ **validatingBalances**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [balances/validatingBalances.ts:14](https://github.com/polkadot-js/api/blob/b2f0618/packages/api-derive/src/balances/validatingBalances.ts#L14)* *Defined in [balances/validatingBalances.ts:14](https://github.com/polkadot-js/api/blob/c1672e8/packages/api-derive/src/balances/validatingBalances.ts#L14)*
**Parameters:** **Parameters:**
docs/api-derive/modules/_balances_votingbalance_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **votingBalance**(api: *`ApiInterface$Rx`*): `(Anonymous function)` ▸ **votingBalance**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [balances/votingBalance.ts:16](https://github.com/polkadot-js/api/blob/b2f0618/packages/api-derive/src/balances/votingBalance.ts#L16)* *Defined in [balances/votingBalance.ts:16](https://github.com/polkadot-js/api/blob/c1672e8/packages/api-derive/src/balances/votingBalance.ts#L16)*
**Parameters:** **Parameters:**
docs/api-derive/modules/_balances_votingbalances_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **votingBalances**(api: *`ApiInterface$Rx`*): `(Anonymous function)` ▸ **votingBalances**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [balances/votingBalances.ts:13](https://github.com/polkadot-js/api/blob/b2f0618/packages/api-derive/src/balances/votingBalances.ts#L13)* *Defined in [balances/votingBalances.ts:13](https://github.com/polkadot-js/api/blob/c1672e8/packages/api-derive/src/balances/votingBalances.ts#L13)*
**Parameters:** **Parameters:**
docs/api-derive/modules/_balances_votingbalancesnominatorsfor_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **votingBalancesNominatorsFor**(api: *`ApiInterface$Rx`*): `(Anonymous function)` ▸ **votingBalancesNominatorsFor**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [balances/votingBalancesNominatorsFor.ts:16](https://github.com/polkadot-js/api/blob/b2f0618/packages/api-derive/src/balances/votingBalancesNominatorsFor.ts#L16)* *Defined in [balances/votingBalancesNominatorsFor.ts:16](https://github.com/polkadot-js/api/blob/c1672e8/packages/api-derive/src/balances/votingBalancesNominatorsFor.ts#L16)*
**Parameters:** **Parameters:**
docs/api-derive/modules/_chain_bestnumber_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **bestNumber**(api: *`ApiInterface$Rx`*): `(Anonymous function)` ▸ **bestNumber**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [chain/bestNumber.ts:23](https://github.com/polkadot-js/api/blob/b2f0618/packages/api-derive/src/chain/bestNumber.ts#L23)* *Defined in [chain/bestNumber.ts:23](https://github.com/polkadot-js/api/blob/c1672e8/packages/api-derive/src/chain/bestNumber.ts#L23)*
*__description__*: Get the latest block number. *__description__*: Get the latest block number.
docs/api-derive/modules/_chain_bestnumberfinalised_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **bestNumberFinalised**(api: *`ApiInterface$Rx`*): `(Anonymous function)` ▸ **bestNumberFinalised**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [chain/bestNumberFinalised.ts:23](https://github.com/polkadot-js/api/blob/b2f0618/packages/api-derive/src/chain/bestNumberFinalised.ts#L23)* *Defined in [chain/bestNumberFinalised.ts:23](https://github.com/polkadot-js/api/blob/c1672e8/packages/api-derive/src/chain/bestNumberFinalised.ts#L23)*
*__description__*: Get the latest finalised block number. example *__description__*: Get the latest finalised block number. example
docs/api-derive/modules/_chain_bestnumberlag_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **bestNumberLag**(api: *`ApiInterface$Rx`*): `(Anonymous function)` ▸ **bestNumberLag**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [chain/bestNumberLag.ts:25](https://github.com/polkadot-js/api/blob/b2f0618/packages/api-derive/src/chain/bestNumberLag.ts#L25)* *Defined in [chain/bestNumberLag.ts:25](https://github.com/polkadot-js/api/blob/c1672e8/packages/api-derive/src/chain/bestNumberLag.ts#L25)*
*__description__*: Calculates the lag between finalised head and best head *__description__*: Calculates the lag between finalised head and best head
docs/api-derive/modules/_chain_getheader_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **getHeader**(api: *`ApiInterface$Rx`*): `(Anonymous function)` ▸ **getHeader**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [chain/getHeader.ts:25](https://github.com/polkadot-js/api/blob/b2f0618/packages/api-derive/src/chain/getHeader.ts#L25)* *Defined in [chain/getHeader.ts:25](https://github.com/polkadot-js/api/blob/c1672e8/packages/api-derive/src/chain/getHeader.ts#L25)*
*__description__*: Get the a specific block header and extend it with the author *__description__*: Get the a specific block header and extend it with the author
docs/api-derive/modules/_chain_subscribenewhead_.md
+2 -2
View File
@@ -8,7 +8,7 @@
**Ƭ HeaderAndValidators**: *[`Header`, `Array`<`AccountId`>]* **Ƭ HeaderAndValidators**: *[`Header`, `Array`<`AccountId`>]*
*Defined in [chain/subscribeNewHead.ts:13](https://github.com/polkadot-js/api/blob/b2f0618/packages/api-derive/src/chain/subscribeNewHead.ts#L13)* *Defined in [chain/subscribeNewHead.ts:13](https://github.com/polkadot-js/api/blob/c1672e8/packages/api-derive/src/chain/subscribeNewHead.ts#L13)*
___ ___
@@ -20,7 +20,7 @@ ___
▸ **subscribeNewHead**(api: *`ApiInterface$Rx`*): `(Anonymous function)` ▸ **subscribeNewHead**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [chain/subscribeNewHead.ts:26](https://github.com/polkadot-js/api/blob/b2f0618/packages/api-derive/src/chain/subscribeNewHead.ts#L26)* *Defined in [chain/subscribeNewHead.ts:26](https://github.com/polkadot-js/api/blob/c1672e8/packages/api-derive/src/chain/subscribeNewHead.ts#L26)*
*__description__*: Subscribe to block headers and extend it with the author *__description__*: Subscribe to block headers and extend it with the author
docs/api-derive/modules/_democracy_referenduminfos_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **referendumInfos**(api: *`ApiInterface$Rx`*): `(Anonymous function)` ▸ **referendumInfos**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [democracy/referendumInfos.ts:13](https://github.com/polkadot-js/api/blob/b2f0618/packages/api-derive/src/democracy/referendumInfos.ts#L13)* *Defined in [democracy/referendumInfos.ts:13](https://github.com/polkadot-js/api/blob/c1672e8/packages/api-derive/src/democracy/referendumInfos.ts#L13)*
**Parameters:** **Parameters:**
docs/api-derive/modules/_democracy_referendums_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **referendums**(api: *`ApiInterface$Rx`*): `(Anonymous function)` ▸ **referendums**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [democracy/referendums.ts:13](https://github.com/polkadot-js/api/blob/b2f0618/packages/api-derive/src/democracy/referendums.ts#L13)* *Defined in [democracy/referendums.ts:13](https://github.com/polkadot-js/api/blob/c1672e8/packages/api-derive/src/democracy/referendums.ts#L13)*
**Parameters:** **Parameters:**
docs/api-derive/modules/_democracy_referendumvotesfor_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **referendumVotesFor**(api: *`ApiInterface$Rx`*): `(Anonymous function)` ▸ **referendumVotesFor**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [democracy/referendumVotesFor.ts:17](https://github.com/polkadot-js/api/blob/b2f0618/packages/api-derive/src/democracy/referendumVotesFor.ts#L17)* *Defined in [democracy/referendumVotesFor.ts:17](https://github.com/polkadot-js/api/blob/c1672e8/packages/api-derive/src/democracy/referendumVotesFor.ts#L17)*
**Parameters:** **Parameters:**
docs/api-derive/modules/_democracy_votes_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **votes**(api: *`ApiInterface$Rx`*): `(Anonymous function)` ▸ **votes**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [democracy/votes.ts:12](https://github.com/polkadot-js/api/blob/b2f0618/packages/api-derive/src/democracy/votes.ts#L12)* *Defined in [democracy/votes.ts:12](https://github.com/polkadot-js/api/blob/c1672e8/packages/api-derive/src/democracy/votes.ts#L12)*
**Parameters:** **Parameters:**
docs/api-derive/modules/_index_.md
+1 -1
View File
@@ -20,7 +20,7 @@
▸ **decorateDerive**(api: *`ApiInterface$Rx`*): [Derive](../interfaces/_index_.derive.md) ▸ **decorateDerive**(api: *`ApiInterface$Rx`*): [Derive](../interfaces/_index_.derive.md)
*Defined in [index.ts:35](https://github.com/polkadot-js/api/blob/b2f0618/packages/api-derive/src/index.ts#L35)* *Defined in [index.ts:35](https://github.com/polkadot-js/api/blob/c1672e8/packages/api-derive/src/index.ts#L35)*
**Parameters:** **Parameters:**
docs/api-derive/modules/_session_eralength_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **eraLength**(api: *`ApiInterface$Rx`*): `(Anonymous function)` ▸ **eraLength**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [session/eraLength.ts:13](https://github.com/polkadot-js/api/blob/b2f0618/packages/api-derive/src/session/eraLength.ts#L13)* *Defined in [session/eraLength.ts:13](https://github.com/polkadot-js/api/blob/c1672e8/packages/api-derive/src/session/eraLength.ts#L13)*
**Parameters:** **Parameters:**
docs/api-derive/modules/_session_eraprogress_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **eraProgress**(api: *`ApiInterface$Rx`*): `(Anonymous function)` ▸ **eraProgress**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [session/eraProgress.ts:14](https://github.com/polkadot-js/api/blob/b2f0618/packages/api-derive/src/session/eraProgress.ts#L14)* *Defined in [session/eraProgress.ts:14](https://github.com/polkadot-js/api/blob/c1672e8/packages/api-derive/src/session/eraProgress.ts#L14)*
**Parameters:** **Parameters:**
docs/api-derive/modules/_session_sessionprogress_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **sessionProgress**(api: *`ApiInterface$Rx`*): `(Anonymous function)` ▸ **sessionProgress**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [session/sessionProgress.ts:14](https://github.com/polkadot-js/api/blob/b2f0618/packages/api-derive/src/session/sessionProgress.ts#L14)* *Defined in [session/sessionProgress.ts:14](https://github.com/polkadot-js/api/blob/c1672e8/packages/api-derive/src/session/sessionProgress.ts#L14)*
**Parameters:** **Parameters:**
docs/api-derive/modules/_staking_intentionsbalances_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **intentionsBalances**(api: *`ApiInterface$Rx`*): `(Anonymous function)` ▸ **intentionsBalances**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [staking/intentionsBalances.ts:18](https://github.com/polkadot-js/api/blob/b2f0618/packages/api-derive/src/staking/intentionsBalances.ts#L18)* *Defined in [staking/intentionsBalances.ts:18](https://github.com/polkadot-js/api/blob/c1672e8/packages/api-derive/src/staking/intentionsBalances.ts#L18)*
Get the balances for all intentions and their nominators Get the balances for all intentions and their nominators
docs/api-derive/modules/_types_.md
+4 -4
View File
@@ -8,7 +8,7 @@
**Ƭ DerivedBalances**: *`object`* **Ƭ DerivedBalances**: *`object`*
*Defined in [types.ts:8](https://github.com/polkadot-js/api/blob/b2f0618/packages/api-derive/src/types.ts#L8)* *Defined in [types.ts:8](https://github.com/polkadot-js/api/blob/c1672e8/packages/api-derive/src/types.ts#L8)*
#### Type declaration #### Type declaration
@@ -19,7 +19,7 @@ ___
**Ƭ DerivedBalancesMap**: *`object`* **Ƭ DerivedBalancesMap**: *`object`*
*Defined in [types.ts:26](https://github.com/polkadot-js/api/blob/b2f0618/packages/api-derive/src/types.ts#L26)* *Defined in [types.ts:26](https://github.com/polkadot-js/api/blob/c1672e8/packages/api-derive/src/types.ts#L26)*
#### Type declaration #### Type declaration
@@ -32,7 +32,7 @@ ___
**Ƭ DerivedFees**: *`object`* **Ƭ DerivedFees**: *`object`*
*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/b2f0618/packages/api-derive/src/types.ts#L18)* *Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/c1672e8/packages/api-derive/src/types.ts#L18)*
#### Type declaration #### Type declaration
@@ -43,7 +43,7 @@ ___
**Ƭ DerivedReferendumVote**: *`object`* **Ƭ DerivedReferendumVote**: *`object`*
*Defined in [types.ts:30](https://github.com/polkadot-js/api/blob/b2f0618/packages/api-derive/src/types.ts#L30)* *Defined in [types.ts:30](https://github.com/polkadot-js/api/blob/c1672e8/packages/api-derive/src/types.ts#L30)*
#### Type declaration #### Type declaration
docs/api-derive/modules/_util_cache_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **cache**(fn: *`Function`*, map?: *`WeakMap`<`object`, `any`>*): `(Anonymous function)` ▸ **cache**(fn: *`Function`*, map?: *`WeakMap`<`object`, `any`>*): `(Anonymous function)`
*Defined in [util/cache.ts:23](https://github.com/polkadot-js/api/blob/b2f0618/packages/api-derive/src/util/cache.ts#L23)* *Defined in [util/cache.ts:23](https://github.com/polkadot-js/api/blob/c1672e8/packages/api-derive/src/util/cache.ts#L23)*
Create memoization for a 2-currified function. Create memoization for a 2-currified function.
docs/api/SUMMARY.md
+1
View File
@@ -27,6 +27,7 @@
* [QueryableModuleStorage](interfaces/_types_.queryablemodulestorage.md) * [QueryableModuleStorage](interfaces/_types_.queryablemodulestorage.md)
* [QueryableStorage](interfaces/_types_.queryablestorage.md) * [QueryableStorage](interfaces/_types_.queryablestorage.md)
* [QueryableStorageFunctionBase](interfaces/_types_.queryablestoragefunctionbase.md) * [QueryableStorageFunctionBase](interfaces/_types_.queryablestoragefunctionbase.md)
* [Signer](interfaces/_types_.signer.md)
* [SubmittableExtrinsicFunction](interfaces/_types_.submittableextrinsicfunction.md) * [SubmittableExtrinsicFunction](interfaces/_types_.submittableextrinsicfunction.md)
* [SubmittableExtrinsics](interfaces/_types_.submittableextrinsics.md) * [SubmittableExtrinsics](interfaces/_types_.submittableextrinsics.md)
* [SubmittableModuleExtrinsics](interfaces/_types_.submittablemoduleextrinsics.md) * [SubmittableModuleExtrinsics](interfaces/_types_.submittablemoduleextrinsics.md)
docs/api/classes/_base_.apibase.md
+32 -13
View File
@@ -27,7 +27,7 @@
⊕ **new ApiBase**(provider?: *[ApiOptions](../interfaces/_types_.apioptions.md) | `ProviderInterface`*, type: *[ApiType](../modules/_types_.md#apitype)*): [ApiBase](_base_.apibase.md) ⊕ **new ApiBase**(provider?: *[ApiOptions](../interfaces/_types_.apioptions.md) | `ProviderInterface`*, type: *[ApiType](../modules/_types_.md#apitype)*): [ApiBase](_base_.apibase.md)
*Defined in [Base.ts:72](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L72)* *Defined in [Base.ts:72](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L72)*
*__description__*: Create an instance of the class *__description__*: Create an instance of the class
@@ -62,7 +62,7 @@ ___
getderive(): [Derive](../interfaces/_types_.derive.md)<`CodecResult`, `SubscriptionResult`> getderive(): [Derive](../interfaces/_types_.derive.md)<`CodecResult`, `SubscriptionResult`>
*Defined in [Base.ts:172](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L172)* *Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L180)*
*__description__*: Derived results that are injected into the API, allowing for combinations of various query results. *__description__*: Derived results that are injected into the API, allowing for combinations of various query results.
@@ -83,7 +83,7 @@ ___
getgenesisHash(): `Hash` getgenesisHash(): `Hash`
*Defined in [Base.ts:122](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L122)* *Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L123)*
*__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. *__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.
@@ -96,7 +96,7 @@ ___
gethasSubscriptions(): `boolean` gethasSubscriptions(): `boolean`
*Defined in [Base.ts:131](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L131)* *Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L132)*
*__description__*: `true` when subscriptions are supported *__description__*: `true` when subscriptions are supported
@@ -109,7 +109,7 @@ ___
getquery(): [QueryableStorage](../interfaces/_types_.queryablestorage.md)<`CodecResult`, `SubscriptionResult`> getquery(): [QueryableStorage](../interfaces/_types_.queryablestorage.md)<`CodecResult`, `SubscriptionResult`>
*Defined in [Base.ts:192](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L192)* *Defined in [Base.ts:200](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L200)*
*__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata. *__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.
@@ -132,7 +132,7 @@ ___
getrpc(): [DecoratedRpc](../interfaces/_types_.decoratedrpc.md)<`CodecResult`, `SubscriptionResult`> getrpc(): [DecoratedRpc](../interfaces/_types_.decoratedrpc.md)<`CodecResult`, `SubscriptionResult`>
*Defined in [Base.ts:212](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L212)* *Defined in [Base.ts:220](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L220)*
*__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. *__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.
@@ -155,7 +155,7 @@ ___
getruntimeMetadata(): `Metadata` getruntimeMetadata(): `Metadata`
*Defined in [Base.ts:138](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L138)* *Defined in [Base.ts:139](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L139)*
*__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection. *__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.
@@ -168,7 +168,7 @@ ___
getruntimeVersion(): `RuntimeVersion` getruntimeVersion(): `RuntimeVersion`
*Defined in [Base.ts:147](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L147)* *Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L148)*
*__description__*: Contains the version information for the current runtime. *__description__*: Contains the version information for the current runtime.
@@ -181,7 +181,7 @@ ___
gettx(): [SubmittableExtrinsics](../interfaces/_types_.submittableextrinsics.md)<`CodecResult`, `SubscriptionResult`> gettx(): [SubmittableExtrinsics](../interfaces/_types_.submittableextrinsics.md)<`CodecResult`, `SubscriptionResult`>
*Defined in [Base.ts:230](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L230)* *Defined in [Base.ts:238](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L238)*
*__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. *__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.
@@ -204,7 +204,7 @@ ___
gettype(): [ApiType](../modules/_types_.md#apitype) gettype(): [ApiType](../modules/_types_.md#apitype)
*Defined in [Base.ts:156](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L156)* *Defined in [Base.ts:157](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L157)*
*__description__*: The type of this API instance, either 'rxjs' or 'promise' *__description__*: The type of this API instance, either 'rxjs' or 'promise'
@@ -220,7 +220,7 @@ ___
▸ **disconnect**(): `void` ▸ **disconnect**(): `void`
*Defined in [Base.ts:239](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L239)* *Defined in [Base.ts:247](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L247)*
*__description__*: Disconnect from the underlying provider, halting all comms *__description__*: Disconnect from the underlying provider, halting all comms
@@ -233,7 +233,7 @@ ___
▸ **on**(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this` ▸ **on**(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this`
*Defined in [Base.ts:262](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L262)* *Defined in [Base.ts:270](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L270)*
*__description__*: Attach an eventemitter handler to listen to a specific event *__description__*: Attach an eventemitter handler to listen to a specific event
@@ -265,7 +265,7 @@ ___
▸ **once**(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this` ▸ **once**(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this`
*Defined in [Base.ts:287](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L287)* *Defined in [Base.ts:295](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L295)*
*__description__*: Attach an one-time eventemitter handler to listen to a specific event *__description__*: Attach an one-time eventemitter handler to listen to a specific event
@@ -291,4 +291,23 @@ api.once('disconnected', () => {
**Returns:** `this` **Returns:** `this`
___ ___
<a id="setsigner"></a>
## setSigner
▸ **setSigner**(signer: *[Signer](../interfaces/_types_.signer.md)*): `void`
*Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L164)*
*__description__*: Set an external signer which will be used to sign extrinsic when account passed in is not KeyringPair
**Parameters:**
| Name | Type |
| ------ | ------ |
| signer | [Signer](../interfaces/_types_.signer.md) |
**Returns:** `void`
___
docs/api/classes/_promise_combinator_.combinator.md
+2 -2
View File
@@ -12,7 +12,7 @@
⊕ **new Combinator**(fns: *`Array`<[CombinatorFunction](../modules/_promise_combinator_.md#combinatorfunction) | [[CombinatorFunction](../modules/_promise_combinator_.md#combinatorfunction), `Array`]>*, callback: *[CombinatorCallback](../modules/_promise_combinator_.md#combinatorcallback)*): [Combinator](_promise_combinator_.combinator.md) ⊕ **new Combinator**(fns: *`Array`<[CombinatorFunction](../modules/_promise_combinator_.md#combinatorfunction) | [[CombinatorFunction](../modules/_promise_combinator_.md#combinatorfunction), `Array`]>*, callback: *[CombinatorCallback](../modules/_promise_combinator_.md#combinatorcallback)*): [Combinator](_promise_combinator_.combinator.md)
*Defined in [promise/Combinator.ts:21](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/promise/Combinator.ts#L21)* *Defined in [promise/Combinator.ts:21](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/promise/Combinator.ts#L21)*
**Parameters:** **Parameters:**
@@ -33,7 +33,7 @@ ___
▸ **unsubscribe**(): `void` ▸ **unsubscribe**(): `void`
*Defined in [promise/Combinator.ts:67](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/promise/Combinator.ts#L67)* *Defined in [promise/Combinator.ts:67](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/promise/Combinator.ts#L67)*
**Returns:** `void` **Returns:** `void`
docs/api/classes/_promise_index_.apipromise.html
+42 -18
View File
@@ -2211,7 +2211,7 @@
<h2 id="constructor">constructor</h2> <h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new ApiPromise</strong>(options?: <em><a href="../interfaces/_types_.apioptions.md">ApiOptions</a> | <code>ProviderInterface</code></em>): <a href="_promise_index_.apipromise.html">ApiPromise</a></p> <p>&#x2295; <strong>new ApiPromise</strong>(options?: <em><a href="../interfaces/_types_.apioptions.md">ApiOptions</a> | <code>ProviderInterface</code></em>): <a href="_promise_index_.apipromise.html">ApiPromise</a></p>
<p><em>Overrides <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#constructor">constructor</a></em></p> <p><em>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/b2f0618/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/c1672e8/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>description</strong></em>: Creates an instance of the ApiPromise class</p>
<p><em><strong>example</strong></em>: </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> <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>
@@ -2247,7 +2247,7 @@
<h2 id="derive">derive</h2> <h2 id="derive">derive</h2>
<p>getderive(): <a href="../interfaces/_types_.derive.md">Derive</a>&lt;<a href="">CodecResult</a>, <a href="">SubscriptionResult</a>&gt;</p> <p>getderive(): <a href="../interfaces/_types_.derive.md">Derive</a>&lt;<a href="">CodecResult</a>, <a href="">SubscriptionResult</a>&gt;</p>
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#derive">derive</a></em></p> <p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#derive">derive</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L172" target="_blank">Base.ts:172</a></em></p> <p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L180" target="_blank">Base.ts:180</a></em></p>
<p><em><strong>description</strong></em>: Derived results that are injected into the API, allowing for combinations of various query results.</p> <p><em><strong>description</strong></em>: Derived results that are injected into the API, allowing for combinations of various query results.</p>
<p><em><strong>example</strong></em>: </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">derive</span><span class="sunlight-operator">.</span><span class="sunlight-ident">chain</span><span class="sunlight-operator">.</span><span class="sunlight-ident">bestNumber</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">(</span><span class="sunlight-ident">number</span><span class="sunlight-punctuation">)</span>&#xA0;<span class="sunlight-operator">=</span><span class="sunlight-operator">&gt;</span>&#xA0;<span class="sunlight-punctuation">{</span> <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">derive</span><span class="sunlight-operator">.</span><span class="sunlight-ident">chain</span><span class="sunlight-operator">.</span><span class="sunlight-ident">bestNumber</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">(</span><span class="sunlight-ident">number</span><span class="sunlight-punctuation">)</span>&#xA0;<span class="sunlight-operator">=</span><span class="sunlight-operator">&gt;</span>&#xA0;<span class="sunlight-punctuation">{</span>
@@ -2260,7 +2260,7 @@
<h2 id="genesishash">genesisHash</h2> <h2 id="genesishash">genesisHash</h2>
<p>getgenesisHash(): <code>Hash</code></p> <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>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/b2f0618/packages/api/src/Base.ts#L122" target="_blank">Base.ts:122</a></em></p> <p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L123" target="_blank">Base.ts:123</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><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> <p><strong>Returns:</strong> <code>Hash</code></p>
<hr> <hr>
@@ -2268,14 +2268,14 @@
<h2 id="hassubscriptions">hasSubscriptions</h2> <h2 id="hassubscriptions">hasSubscriptions</h2>
<p>gethasSubscriptions(): <code>boolean</code></p> <p>gethasSubscriptions(): <code>boolean</code></p>
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#hassubscriptions">hasSubscriptions</a></em></p> <p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#hassubscriptions">hasSubscriptions</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L131" target="_blank">Base.ts:131</a></em></p> <p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L132" target="_blank">Base.ts:132</a></em></p>
<p><em><strong>description</strong></em>: <code>true</code> when subscriptions are supported</p> <p><em><strong>description</strong></em>: <code>true</code> when subscriptions are supported</p>
<p><strong>Returns:</strong> <code>boolean</code></p> <p><strong>Returns:</strong> <code>boolean</code></p>
<hr> <hr>
<p><a id="isready"></a></p> <p><a id="isready"></a></p>
<h2 id="isready">isReady</h2> <h2 id="isready">isReady</h2>
<p>getisReady(): <code>Promise</code>&lt;<a href="_promise_index_.apipromise.html">ApiPromise</a>&gt;</p> <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/b2f0618/packages/api/src/promise/index.ts#L163" target="_blank">promise/index.ts:163</a></em></p> <p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/promise/index.ts#L163" target="_blank">promise/index.ts:163</a></em></p>
<p><em><strong>description</strong></em>: Promise that returns the first time we are connected and loaded</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> <p><strong>Returns:</strong> <code>Promise</code>&lt;<a href="_promise_index_.apipromise.html">ApiPromise</a>&gt;</p>
<hr> <hr>
@@ -2283,7 +2283,7 @@
<h2 id="query">query</h2> <h2 id="query">query</h2>
<p>getquery(): <a href="../interfaces/_types_.queryablestorage.md">QueryableStorage</a>&lt;<a href="">CodecResult</a>, <a href="">SubscriptionResult</a>&gt;</p> <p>getquery(): <a href="../interfaces/_types_.queryablestorage.md">QueryableStorage</a>&lt;<a href="">CodecResult</a>, <a href="">SubscriptionResult</a>&gt;</p>
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#query">query</a></em></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/b2f0618/packages/api/src/Base.ts#L192" target="_blank">Base.ts:192</a></em></p> <p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L200" target="_blank">Base.ts:200</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><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>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> <p><em><strong>example</strong></em>: </p>
@@ -2297,7 +2297,7 @@
<h2 id="rpc">rpc</h2> <h2 id="rpc">rpc</h2>
<p>getrpc(): <a href="../interfaces/_types_.decoratedrpc.md">DecoratedRpc</a>&lt;<a href="">CodecResult</a>, <a href="">SubscriptionResult</a>&gt;</p> <p>getrpc(): <a href="../interfaces/_types_.decoratedrpc.md">DecoratedRpc</a>&lt;<a href="">CodecResult</a>, <a href="">SubscriptionResult</a>&gt;</p>
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#rpc">rpc</a></em></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/b2f0618/packages/api/src/Base.ts#L212" target="_blank">Base.ts:212</a></em></p> <p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L220" target="_blank">Base.ts:220</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><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>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> <p><em><strong>example</strong></em>: </p>
@@ -2311,7 +2311,7 @@
<h2 id="runtimemetadata">runtimeMetadata</h2> <h2 id="runtimemetadata">runtimeMetadata</h2>
<p>getruntimeMetadata(): <code>Metadata</code></p> <p>getruntimeMetadata(): <code>Metadata</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>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/b2f0618/packages/api/src/Base.ts#L138" target="_blank">Base.ts:138</a></em></p> <p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L139" target="_blank">Base.ts:139</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><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>Metadata</code></p> <p><strong>Returns:</strong> <code>Metadata</code></p>
<hr> <hr>
@@ -2319,7 +2319,7 @@
<h2 id="runtimeversion">runtimeVersion</h2> <h2 id="runtimeversion">runtimeVersion</h2>
<p>getruntimeVersion(): <code>RuntimeVersion</code></p> <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>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/b2f0618/packages/api/src/Base.ts#L147" target="_blank">Base.ts:147</a></em></p> <p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L148" target="_blank">Base.ts:148</a></em></p>
<p><em><strong>description</strong></em>: Contains the version information for the current runtime.</p> <p><em><strong>description</strong></em>: Contains the version information for the current runtime.</p>
<p><strong>Returns:</strong> <code>RuntimeVersion</code></p> <p><strong>Returns:</strong> <code>RuntimeVersion</code></p>
<hr> <hr>
@@ -2327,7 +2327,7 @@
<h2 id="tx">tx</h2> <h2 id="tx">tx</h2>
<p>gettx(): <a href="../interfaces/_types_.submittableextrinsics.md">SubmittableExtrinsics</a>&lt;<a href="">CodecResult</a>, <a href="">SubscriptionResult</a>&gt;</p> <p>gettx(): <a href="../interfaces/_types_.submittableextrinsics.md">SubmittableExtrinsics</a>&lt;<a href="">CodecResult</a>, <a href="">SubscriptionResult</a>&gt;</p>
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#tx">tx</a></em></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/b2f0618/packages/api/src/Base.ts#L230" target="_blank">Base.ts:230</a></em></p> <p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L238" target="_blank">Base.ts:238</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>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> <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> <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>
@@ -2342,7 +2342,7 @@
<h2 id="type">type</h2> <h2 id="type">type</h2>
<p>gettype(): <a href="../modules/_types_.md#apitype">ApiType</a></p> <p>gettype(): <a href="../modules/_types_.md#apitype">ApiType</a></p>
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#type">type</a></em></p> <p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#type">type</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L156" target="_blank">Base.ts:156</a></em></p> <p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L157" target="_blank">Base.ts:157</a></em></p>
<p><em><strong>description</strong></em>: The type of this API instance, either &apos;rxjs&apos; or &apos;promise&apos;</p> <p><em><strong>description</strong></em>: The type of this API instance, either &apos;rxjs&apos; or &apos;promise&apos;</p>
<p><strong>Returns:</strong> <a href="../modules/_types_.md#apitype">ApiType</a></p> <p><strong>Returns:</strong> <a href="../modules/_types_.md#apitype">ApiType</a></p>
<hr> <hr>
@@ -2350,14 +2350,14 @@
<p><a id="clone"></a></p> <p><a id="clone"></a></p>
<h2 id="clone">clone</h2> <h2 id="clone">clone</h2>
<p>&#x25B8; <strong>clone</strong>(): <a href="_promise_index_.apipromise.html">ApiPromise</a></p> <p>&#x25B8; <strong>clone</strong>(): <a href="_promise_index_.apipromise.html">ApiPromise</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/promise/index.ts#L170" target="_blank">promise/index.ts:170</a></em></p> <p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/promise/index.ts#L170" target="_blank">promise/index.ts:170</a></em></p>
<p><em><strong>description</strong></em>: Returns a clone of this ApiPromise instance (new underlying provider connection)</p> <p><em><strong>description</strong></em>: Returns a clone of this ApiPromise instance (new underlying provider connection)</p>
<p><strong>Returns:</strong> <a href="_promise_index_.apipromise.html">ApiPromise</a></p> <p><strong>Returns:</strong> <a href="_promise_index_.apipromise.html">ApiPromise</a></p>
<hr> <hr>
<p><a id="combinelatest"></a></p> <p><a id="combinelatest"></a></p>
<h2 id="combinelatest">combineLatest</h2> <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> | [<a href="../modules/_promise_combinator_.md#combinatorfunction">CombinatorFunction</a>, <code>Array</code>]&gt;</em>, callback: <em><a href="../modules/_promise_combinator_.md#combinatorcallback">CombinatorCallback</a></em>): <a href="">SubscriptionResult</a></p> <p>&#x25B8; <strong>combineLatest</strong>(fns: <em><code>Array</code>&lt;<a href="../modules/_promise_combinator_.md#combinatorfunction">CombinatorFunction</a> | [<a href="../modules/_promise_combinator_.md#combinatorfunction">CombinatorFunction</a>, <code>Array</code>]&gt;</em>, callback: <em><a href="../modules/_promise_combinator_.md#combinatorcallback">CombinatorCallback</a></em>): <a href="">SubscriptionResult</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/promise/index.ts#L197" target="_blank">promise/index.ts:197</a></em></p> <p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/promise/index.ts#L197" target="_blank">promise/index.ts:197</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>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> <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> <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>
@@ -2401,7 +2401,7 @@
<p>&#x25B8; <strong>disconnect</strong>(): <code>void</code></p> <p>&#x25B8; <strong>disconnect</strong>(): <code>void</code></p>
<p><em>Implementation of <a href="../interfaces/_promise_types_.apipromiseinterface.md">ApiPromiseInterface</a>.<a href="../interfaces/_promise_types_.apipromiseinterface.md#disconnect">disconnect</a></em></p> <p><em>Implementation of <a href="../interfaces/_promise_types_.apipromiseinterface.md">ApiPromiseInterface</a>.<a href="../interfaces/_promise_types_.apipromiseinterface.md#disconnect">disconnect</a></em></p>
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#disconnect">disconnect</a></em></p> <p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#disconnect">disconnect</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L239" target="_blank">Base.ts:239</a></em></p> <p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L247" target="_blank">Base.ts:247</a></em></p>
<p><em><strong>description</strong></em>: Disconnect from the underlying provider, halting all comms</p> <p><em><strong>description</strong></em>: Disconnect from the underlying provider, halting all comms</p>
<p><strong>Returns:</strong> <code>void</code></p> <p><strong>Returns:</strong> <code>void</code></p>
<hr> <hr>
@@ -2409,7 +2409,7 @@
<h2 id="on">on</h2> <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>this</code></p> <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>this</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>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/b2f0618/packages/api/src/Base.ts#L262" target="_blank">Base.ts:262</a></em></p> <p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L270" target="_blank">Base.ts:270</a></em></p>
<p><em><strong>description</strong></em>: Attach an eventemitter handler to listen to a specific event</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> <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;connected&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> <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;connected&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>
@@ -2448,7 +2448,7 @@
<h2 id="once">once</h2> <h2 id="once">once</h2>
<p>&#x25B8; <strong>once</strong>(type: <em><a href="../modules/_types_.md#apiinterface_events">ApiInterface$Events</a></em>, handler: <em><code>function</code></em>): <code>this</code></p> <p>&#x25B8; <strong>once</strong>(type: <em><a href="../modules/_types_.md#apiinterface_events">ApiInterface$Events</a></em>, handler: <em><code>function</code></em>): <code>this</code></p>
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#once">once</a></em></p> <p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#once">once</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L287" target="_blank">Base.ts:287</a></em></p> <p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L295" target="_blank">Base.ts:295</a></em></p>
<p><em><strong>description</strong></em>: Attach an one-time eventemitter handler to listen to a specific event</p> <p><em><strong>description</strong></em>: Attach an one-time eventemitter handler to listen to a specific event</p>
<p><em><strong>example</strong></em>: </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">once</span><span class="sunlight-punctuation">(</span><span class="sunlight-string">&apos;connected&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> <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">once</span><span class="sunlight-punctuation">(</span><span class="sunlight-string">&apos;connected&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>
@@ -2483,10 +2483,34 @@
</table> </table>
<p><strong>Returns:</strong> <code>this</code></p> <p><strong>Returns:</strong> <code>this</code></p>
<hr> <hr>
<p><a id="setsigner"></a></p>
<h2 id="setsigner">setSigner</h2>
<p>&#x25B8; <strong>setSigner</strong>(signer: <em><a href="../interfaces/_types_.signer.md">Signer</a></em>): <code>void</code></p>
<p><em>Implementation of <a href="../interfaces/_promise_types_.apipromiseinterface.md">ApiPromiseInterface</a>.<a href="../interfaces/_promise_types_.apipromiseinterface.md#setsigner">setSigner</a></em></p>
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#setsigner">setSigner</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L164" target="_blank">Base.ts:164</a></em></p>
<p><em><strong>description</strong></em>: Set an external signer which will be used to sign extrinsic when account passed in is not KeyringPair</p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>signer</td>
<td><a href="../interfaces/_types_.signer.md">Signer</a></td>
</tr>
</tbody>
</table>
<p><strong>Returns:</strong> <code>void</code></p>
<hr>
<p><a id="create"></a></p> <p><a id="create"></a></p>
<h2 id="static-create"><code>&lt;Static&gt;</code> create</h2> <h2 id="static-create"><code>&lt;Static&gt;</code> create</h2>
<p>&#x25B8; <strong>create</strong>(options?: <em><a href="../interfaces/_types_.apioptions.md">ApiOptions</a> | <code>ProviderInterface</code></em>): <code>Promise</code>&lt;<a href="_promise_index_.apipromise.html">ApiPromise</a>&gt;</p> <p>&#x25B8; <strong>create</strong>(options?: <em><a href="../interfaces/_types_.apioptions.md">ApiOptions</a> | <code>ProviderInterface</code></em>): <code>Promise</code>&lt;<a href="_promise_index_.apipromise.html">ApiPromise</a>&gt;</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/b2f0618/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/c1672e8/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>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> <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> <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>
@@ -2562,7 +2586,7 @@
<script> <script>
var gitbook = gitbook || []; var gitbook = gitbook || [];
gitbook.push(function() { 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":"2019-02-08T14:48:02.094Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-08T14:49:34.586Z"},"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":"2019-02-09T05:19:33.870Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-09T05:21:07.515Z"},"basePath":"../..","book":{"language":""}});
}); });
</script> </script>
</div> </div>
docs/api/classes/_promise_index_.apipromise.md
+40 -17
View File
@@ -106,7 +106,7 @@ ApiPromise.create().then((api) => {
*Overrides [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)* *Overrides [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
*Defined in [promise/index.ts:128](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/promise/index.ts#L128)* *Defined in [promise/index.ts:128](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/promise/index.ts#L128)*
*__description__*: Creates an instance of the ApiPromise class *__description__*: Creates an instance of the ApiPromise class
@@ -142,7 +142,7 @@ getderive(): [Derive](../interfaces/_types_.derive.md)<[CodecResult](), [Subscri
*Inherited from [ApiBase](_base_.apibase.md).[derive](_base_.apibase.md#derive)* *Inherited from [ApiBase](_base_.apibase.md).[derive](_base_.apibase.md#derive)*
*Defined in [Base.ts:172](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L172)* *Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L180)*
*__description__*: Derived results that are injected into the API, allowing for combinations of various query results. *__description__*: Derived results that are injected into the API, allowing for combinations of various query results.
@@ -165,7 +165,7 @@ getgenesisHash(): `Hash`
*Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)* *Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)*
*Defined in [Base.ts:122](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L122)* *Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L123)*
*__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. *__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.
@@ -180,7 +180,7 @@ gethasSubscriptions(): `boolean`
*Inherited from [ApiBase](_base_.apibase.md).[hasSubscriptions](_base_.apibase.md#hassubscriptions)* *Inherited from [ApiBase](_base_.apibase.md).[hasSubscriptions](_base_.apibase.md#hassubscriptions)*
*Defined in [Base.ts:131](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L131)* *Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L132)*
*__description__*: `true` when subscriptions are supported *__description__*: `true` when subscriptions are supported
@@ -193,7 +193,7 @@ ___
getisReady(): `Promise`<[ApiPromise](_promise_index_.apipromise.md)> getisReady(): `Promise`<[ApiPromise](_promise_index_.apipromise.md)>
*Defined in [promise/index.ts:163](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/promise/index.ts#L163)* *Defined in [promise/index.ts:163](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/promise/index.ts#L163)*
*__description__*: Promise that returns the first time we are connected and loaded *__description__*: Promise that returns the first time we are connected and loaded
@@ -208,7 +208,7 @@ getquery(): [QueryableStorage](../interfaces/_types_.queryablestorage.md)<[Codec
*Inherited from [ApiBase](_base_.apibase.md).[query](_base_.apibase.md#query)* *Inherited from [ApiBase](_base_.apibase.md).[query](_base_.apibase.md#query)*
*Defined in [Base.ts:192](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L192)* *Defined in [Base.ts:200](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L200)*
*__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata. *__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.
@@ -233,7 +233,7 @@ getrpc(): [DecoratedRpc](../interfaces/_types_.decoratedrpc.md)<[CodecResult](),
*Inherited from [ApiBase](_base_.apibase.md).[rpc](_base_.apibase.md#rpc)* *Inherited from [ApiBase](_base_.apibase.md).[rpc](_base_.apibase.md#rpc)*
*Defined in [Base.ts:212](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L212)* *Defined in [Base.ts:220](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L220)*
*__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. *__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.
@@ -258,7 +258,7 @@ getruntimeMetadata(): `Metadata`
*Inherited from [ApiBase](_base_.apibase.md).[runtimeMetadata](_base_.apibase.md#runtimemetadata)* *Inherited from [ApiBase](_base_.apibase.md).[runtimeMetadata](_base_.apibase.md#runtimemetadata)*
*Defined in [Base.ts:138](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L138)* *Defined in [Base.ts:139](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L139)*
*__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection. *__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.
@@ -273,7 +273,7 @@ getruntimeVersion(): `RuntimeVersion`
*Inherited from [ApiBase](_base_.apibase.md).[runtimeVersion](_base_.apibase.md#runtimeversion)* *Inherited from [ApiBase](_base_.apibase.md).[runtimeVersion](_base_.apibase.md#runtimeversion)*
*Defined in [Base.ts:147](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L147)* *Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L148)*
*__description__*: Contains the version information for the current runtime. *__description__*: Contains the version information for the current runtime.
@@ -288,7 +288,7 @@ gettx(): [SubmittableExtrinsics](../interfaces/_types_.submittableextrinsics.md)
*Inherited from [ApiBase](_base_.apibase.md).[tx](_base_.apibase.md#tx)* *Inherited from [ApiBase](_base_.apibase.md).[tx](_base_.apibase.md#tx)*
*Defined in [Base.ts:230](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L230)* *Defined in [Base.ts:238](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L238)*
*__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. *__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.
@@ -313,7 +313,7 @@ gettype(): [ApiType](../modules/_types_.md#apitype)
*Inherited from [ApiBase](_base_.apibase.md).[type](_base_.apibase.md#type)* *Inherited from [ApiBase](_base_.apibase.md).[type](_base_.apibase.md#type)*
*Defined in [Base.ts:156](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L156)* *Defined in [Base.ts:157](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L157)*
*__description__*: The type of this API instance, either 'rxjs' or 'promise' *__description__*: The type of this API instance, either 'rxjs' or 'promise'
@@ -329,7 +329,7 @@ ___
▸ **clone**(): [ApiPromise](_promise_index_.apipromise.md) ▸ **clone**(): [ApiPromise](_promise_index_.apipromise.md)
*Defined in [promise/index.ts:170](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/promise/index.ts#L170)* *Defined in [promise/index.ts:170](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/promise/index.ts#L170)*
*__description__*: Returns a clone of this ApiPromise instance (new underlying provider connection) *__description__*: Returns a clone of this ApiPromise instance (new underlying provider connection)
@@ -342,7 +342,7 @@ ___
▸ **combineLatest**(fns: *`Array`<[CombinatorFunction](../modules/_promise_combinator_.md#combinatorfunction) | [[CombinatorFunction](../modules/_promise_combinator_.md#combinatorfunction), `Array`]>*, callback: *[CombinatorCallback](../modules/_promise_combinator_.md#combinatorcallback)*): [SubscriptionResult]() ▸ **combineLatest**(fns: *`Array`<[CombinatorFunction](../modules/_promise_combinator_.md#combinatorfunction) | [[CombinatorFunction](../modules/_promise_combinator_.md#combinatorfunction), `Array`]>*, callback: *[CombinatorCallback](../modules/_promise_combinator_.md#combinatorcallback)*): [SubscriptionResult]()
*Defined in [promise/index.ts:197](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/promise/index.ts#L197)* *Defined in [promise/index.ts:197](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/promise/index.ts#L197)*
*__description__*: Creates a combinator that can be used to combine the latest results from multiple subscriptions *__description__*: Creates a combinator that can be used to combine the latest results from multiple subscriptions
@@ -381,7 +381,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[disconnect](_base_.apibase.md#disconnect)* *Inherited from [ApiBase](_base_.apibase.md).[disconnect](_base_.apibase.md#disconnect)*
*Defined in [Base.ts:239](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L239)* *Defined in [Base.ts:247](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L247)*
*__description__*: Disconnect from the underlying provider, halting all comms *__description__*: Disconnect from the underlying provider, halting all comms
@@ -396,7 +396,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[on](_base_.apibase.md#on)* *Inherited from [ApiBase](_base_.apibase.md).[on](_base_.apibase.md#on)*
*Defined in [Base.ts:262](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L262)* *Defined in [Base.ts:270](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L270)*
*__description__*: Attach an eventemitter handler to listen to a specific event *__description__*: Attach an eventemitter handler to listen to a specific event
@@ -430,7 +430,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[once](_base_.apibase.md#once)* *Inherited from [ApiBase](_base_.apibase.md).[once](_base_.apibase.md#once)*
*Defined in [Base.ts:287](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L287)* *Defined in [Base.ts:295](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L295)*
*__description__*: Attach an one-time eventemitter handler to listen to a specific event *__description__*: Attach an one-time eventemitter handler to listen to a specific event
@@ -455,6 +455,29 @@ api.once('disconnected', () => {
**Returns:** `this` **Returns:** `this`
___
<a id="setsigner"></a>
## setSigner
▸ **setSigner**(signer: *[Signer](../interfaces/_types_.signer.md)*): `void`
*Implementation of [ApiPromiseInterface](../interfaces/_promise_types_.apipromiseinterface.md).[setSigner](../interfaces/_promise_types_.apipromiseinterface.md#setsigner)*
*Inherited from [ApiBase](_base_.apibase.md).[setSigner](_base_.apibase.md#setsigner)*
*Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L164)*
*__description__*: Set an external signer which will be used to sign extrinsic when account passed in is not KeyringPair
**Parameters:**
| Name | Type |
| ------ | ------ |
| signer | [Signer](../interfaces/_types_.signer.md) |
**Returns:** `void`
___ ___
<a id="create"></a> <a id="create"></a>
@@ -462,7 +485,7 @@ ___
▸ **create**(options?: *[ApiOptions](../interfaces/_types_.apioptions.md) | `ProviderInterface`*): `Promise`<[ApiPromise](_promise_index_.apipromise.md)> ▸ **create**(options?: *[ApiOptions](../interfaces/_types_.apioptions.md) | `ProviderInterface`*): `Promise`<[ApiPromise](_promise_index_.apipromise.md)>
*Defined in [promise/index.ts:126](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/promise/index.ts#L126)* *Defined in [promise/index.ts:126](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/promise/index.ts#L126)*
*__description__*: Creates an ApiPromise instance using the supplied provider. Returns an Promise containing the actual Api instance. *__description__*: Creates an ApiPromise instance using the supplied provider. Returns an Promise containing the actual Api instance.
docs/api/classes/_rx_index_.apirx.html
+42 -18
View File
@@ -2225,7 +2225,7 @@
<h2 id="constructor">constructor</h2> <h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new ApiRx</strong>(provider?: <em><a href="../interfaces/_types_.apioptions.md">ApiOptions</a> | <code>ProviderInterface</code></em>): <a href="_rx_index_.apirx.html">ApiRx</a></p> <p>&#x2295; <strong>new ApiRx</strong>(provider?: <em><a href="../interfaces/_types_.apioptions.md">ApiOptions</a> | <code>ProviderInterface</code></em>): <a href="_rx_index_.apirx.html">ApiRx</a></p>
<p><em>Overrides <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#constructor">constructor</a></em></p> <p><em>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/b2f0618/packages/api/src/rx/index.ts#L142" target="_blank">rx/index.ts:142</a></em></p> <p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/rx/index.ts#L142" target="_blank">rx/index.ts:142</a></em></p>
<p><em><strong>description</strong></em>: Create an instance of the ApiRx class</p> <p><em><strong>description</strong></em>: Create an instance of the ApiRx class</p>
<p><em><strong>example</strong></em>: </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-punctuation">{</span>&#xA0;<span class="sunlight-ident">switchMap</span>&#xA0;<span class="sunlight-punctuation">}</span>&#xA0;<span class="sunlight-ident">from</span>&#xA0;<span class="sunlight-string">&apos;rxjs/operators&apos;</span><span class="sunlight-punctuation">;</span> <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-punctuation">{</span>&#xA0;<span class="sunlight-ident">switchMap</span>&#xA0;<span class="sunlight-punctuation">}</span>&#xA0;<span class="sunlight-ident">from</span>&#xA0;<span class="sunlight-string">&apos;rxjs/operators&apos;</span><span class="sunlight-punctuation">;</span>
@@ -2263,7 +2263,7 @@
<h2 id="derive">derive</h2> <h2 id="derive">derive</h2>
<p>getderive(): <a href="../interfaces/_types_.derive.md">Derive</a>&lt;<a href="../modules/_rx_types_.md#rxresult">RxResult</a>, <a href="../modules/_rx_types_.md#rxresult">RxResult</a>&gt;</p> <p>getderive(): <a href="../interfaces/_types_.derive.md">Derive</a>&lt;<a href="../modules/_rx_types_.md#rxresult">RxResult</a>, <a href="../modules/_rx_types_.md#rxresult">RxResult</a>&gt;</p>
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#derive">derive</a></em></p> <p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#derive">derive</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L172" target="_blank">Base.ts:172</a></em></p> <p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L180" target="_blank">Base.ts:180</a></em></p>
<p><em><strong>description</strong></em>: Derived results that are injected into the API, allowing for combinations of various query results.</p> <p><em><strong>description</strong></em>: Derived results that are injected into the API, allowing for combinations of various query results.</p>
<p><em><strong>example</strong></em>: </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">derive</span><span class="sunlight-operator">.</span><span class="sunlight-ident">chain</span><span class="sunlight-operator">.</span><span class="sunlight-ident">bestNumber</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">(</span><span class="sunlight-ident">number</span><span class="sunlight-punctuation">)</span>&#xA0;<span class="sunlight-operator">=</span><span class="sunlight-operator">&gt;</span>&#xA0;<span class="sunlight-punctuation">{</span> <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">derive</span><span class="sunlight-operator">.</span><span class="sunlight-ident">chain</span><span class="sunlight-operator">.</span><span class="sunlight-ident">bestNumber</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">(</span><span class="sunlight-ident">number</span><span class="sunlight-punctuation">)</span>&#xA0;<span class="sunlight-operator">=</span><span class="sunlight-operator">&gt;</span>&#xA0;<span class="sunlight-punctuation">{</span>
@@ -2276,7 +2276,7 @@
<h2 id="genesishash">genesisHash</h2> <h2 id="genesishash">genesisHash</h2>
<p>getgenesisHash(): <code>Hash</code></p> <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>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/b2f0618/packages/api/src/Base.ts#L122" target="_blank">Base.ts:122</a></em></p> <p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L123" target="_blank">Base.ts:123</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><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> <p><strong>Returns:</strong> <code>Hash</code></p>
<hr> <hr>
@@ -2284,21 +2284,21 @@
<h2 id="hassubscriptions">hasSubscriptions</h2> <h2 id="hassubscriptions">hasSubscriptions</h2>
<p>gethasSubscriptions(): <code>boolean</code></p> <p>gethasSubscriptions(): <code>boolean</code></p>
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#hassubscriptions">hasSubscriptions</a></em></p> <p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#hassubscriptions">hasSubscriptions</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L131" target="_blank">Base.ts:131</a></em></p> <p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L132" target="_blank">Base.ts:132</a></em></p>
<p><em><strong>description</strong></em>: <code>true</code> when subscriptions are supported</p> <p><em><strong>description</strong></em>: <code>true</code> when subscriptions are supported</p>
<p><strong>Returns:</strong> <code>boolean</code></p> <p><strong>Returns:</strong> <code>boolean</code></p>
<hr> <hr>
<p><a id="isconnected"></a></p> <p><a id="isconnected"></a></p>
<h2 id="isconnected">isConnected</h2> <h2 id="isconnected">isConnected</h2>
<p>getisConnected(): <code>Observable</code>&lt;<code>boolean</code>&gt;</p> <p>getisConnected(): <code>Observable</code>&lt;<code>boolean</code>&gt;</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/rx/index.ts#L182" target="_blank">rx/index.ts:182</a></em></p> <p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/rx/index.ts#L182" target="_blank">rx/index.ts:182</a></em></p>
<p><em><strong>description</strong></em>: Observable that carries the connected state for the provider. Results in a boolean flag that is true/false based on the connectivity.</p> <p><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> <p><strong>Returns:</strong> <code>Observable</code>&lt;<code>boolean</code>&gt;</p>
<hr> <hr>
<p><a id="isready"></a></p> <p><a id="isready"></a></p>
<h2 id="isready">isReady</h2> <h2 id="isready">isReady</h2>
<p>getisReady(): <code>Observable</code>&lt;<a href="_rx_index_.apirx.html">ApiRx</a>&gt;</p> <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/b2f0618/packages/api/src/rx/index.ts#L189" target="_blank">rx/index.ts:189</a></em></p> <p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/rx/index.ts#L189" target="_blank">rx/index.ts:189</a></em></p>
<p><em><strong>description</strong></em>: Observable that returns the first time we are connected and loaded</p> <p><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> <p><strong>Returns:</strong> <code>Observable</code>&lt;<a href="_rx_index_.apirx.html">ApiRx</a>&gt;</p>
<hr> <hr>
@@ -2306,7 +2306,7 @@
<h2 id="query">query</h2> <h2 id="query">query</h2>
<p>getquery(): <a href="../interfaces/_types_.queryablestorage.md">QueryableStorage</a>&lt;<a href="../modules/_rx_types_.md#rxresult">RxResult</a>, <a href="../modules/_rx_types_.md#rxresult">RxResult</a>&gt;</p> <p>getquery(): <a href="../interfaces/_types_.queryablestorage.md">QueryableStorage</a>&lt;<a href="../modules/_rx_types_.md#rxresult">RxResult</a>, <a href="../modules/_rx_types_.md#rxresult">RxResult</a>&gt;</p>
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#query">query</a></em></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/b2f0618/packages/api/src/Base.ts#L192" target="_blank">Base.ts:192</a></em></p> <p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L200" target="_blank">Base.ts:200</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><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>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> <p><em><strong>example</strong></em>: </p>
@@ -2320,7 +2320,7 @@
<h2 id="rpc">rpc</h2> <h2 id="rpc">rpc</h2>
<p>getrpc(): <a href="../interfaces/_types_.decoratedrpc.md">DecoratedRpc</a>&lt;<a href="../modules/_rx_types_.md#rxresult">RxResult</a>, <a href="../modules/_rx_types_.md#rxresult">RxResult</a>&gt;</p> <p>getrpc(): <a href="../interfaces/_types_.decoratedrpc.md">DecoratedRpc</a>&lt;<a href="../modules/_rx_types_.md#rxresult">RxResult</a>, <a href="../modules/_rx_types_.md#rxresult">RxResult</a>&gt;</p>
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#rpc">rpc</a></em></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/b2f0618/packages/api/src/Base.ts#L212" target="_blank">Base.ts:212</a></em></p> <p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L220" target="_blank">Base.ts:220</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><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>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> <p><em><strong>example</strong></em>: </p>
@@ -2334,7 +2334,7 @@
<h2 id="runtimemetadata">runtimeMetadata</h2> <h2 id="runtimemetadata">runtimeMetadata</h2>
<p>getruntimeMetadata(): <code>Metadata</code></p> <p>getruntimeMetadata(): <code>Metadata</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>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/b2f0618/packages/api/src/Base.ts#L138" target="_blank">Base.ts:138</a></em></p> <p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L139" target="_blank">Base.ts:139</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><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>Metadata</code></p> <p><strong>Returns:</strong> <code>Metadata</code></p>
<hr> <hr>
@@ -2342,7 +2342,7 @@
<h2 id="runtimeversion">runtimeVersion</h2> <h2 id="runtimeversion">runtimeVersion</h2>
<p>getruntimeVersion(): <code>RuntimeVersion</code></p> <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>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/b2f0618/packages/api/src/Base.ts#L147" target="_blank">Base.ts:147</a></em></p> <p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L148" target="_blank">Base.ts:148</a></em></p>
<p><em><strong>description</strong></em>: Contains the version information for the current runtime.</p> <p><em><strong>description</strong></em>: Contains the version information for the current runtime.</p>
<p><strong>Returns:</strong> <code>RuntimeVersion</code></p> <p><strong>Returns:</strong> <code>RuntimeVersion</code></p>
<hr> <hr>
@@ -2350,7 +2350,7 @@
<h2 id="tx">tx</h2> <h2 id="tx">tx</h2>
<p>gettx(): <a href="../interfaces/_types_.submittableextrinsics.md">SubmittableExtrinsics</a>&lt;<a href="../modules/_rx_types_.md#rxresult">RxResult</a>, <a href="../modules/_rx_types_.md#rxresult">RxResult</a>&gt;</p> <p>gettx(): <a href="../interfaces/_types_.submittableextrinsics.md">SubmittableExtrinsics</a>&lt;<a href="../modules/_rx_types_.md#rxresult">RxResult</a>, <a href="../modules/_rx_types_.md#rxresult">RxResult</a>&gt;</p>
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#tx">tx</a></em></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/b2f0618/packages/api/src/Base.ts#L230" target="_blank">Base.ts:230</a></em></p> <p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L238" target="_blank">Base.ts:238</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>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> <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> <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>
@@ -2365,7 +2365,7 @@
<h2 id="type">type</h2> <h2 id="type">type</h2>
<p>gettype(): <a href="../modules/_types_.md#apitype">ApiType</a></p> <p>gettype(): <a href="../modules/_types_.md#apitype">ApiType</a></p>
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#type">type</a></em></p> <p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#type">type</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L156" target="_blank">Base.ts:156</a></em></p> <p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L157" target="_blank">Base.ts:157</a></em></p>
<p><em><strong>description</strong></em>: The type of this API instance, either &apos;rxjs&apos; or &apos;promise&apos;</p> <p><em><strong>description</strong></em>: The type of this API instance, either &apos;rxjs&apos; or &apos;promise&apos;</p>
<p><strong>Returns:</strong> <a href="../modules/_types_.md#apitype">ApiType</a></p> <p><strong>Returns:</strong> <a href="../modules/_types_.md#apitype">ApiType</a></p>
<hr> <hr>
@@ -2373,7 +2373,7 @@
<p><a id="clone"></a></p> <p><a id="clone"></a></p>
<h2 id="clone">clone</h2> <h2 id="clone">clone</h2>
<p>&#x25B8; <strong>clone</strong>(): <a href="_rx_index_.apirx.html">ApiRx</a></p> <p>&#x25B8; <strong>clone</strong>(): <a href="_rx_index_.apirx.html">ApiRx</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/rx/index.ts#L196" target="_blank">rx/index.ts:196</a></em></p> <p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/rx/index.ts#L196" target="_blank">rx/index.ts:196</a></em></p>
<p><em><strong>description</strong></em>: Returns a clone of this ApiRx instance (new underlying provider connection)</p> <p><em><strong>description</strong></em>: Returns a clone of this ApiRx instance (new underlying provider connection)</p>
<p><strong>Returns:</strong> <a href="_rx_index_.apirx.html">ApiRx</a></p> <p><strong>Returns:</strong> <a href="_rx_index_.apirx.html">ApiRx</a></p>
<hr> <hr>
@@ -2382,7 +2382,7 @@
<p>&#x25B8; <strong>disconnect</strong>(): <code>void</code></p> <p>&#x25B8; <strong>disconnect</strong>(): <code>void</code></p>
<p><em>Implementation of <a href="../interfaces/_rx_types_.apirxinterface.md">ApiRxInterface</a>.<a href="../interfaces/_rx_types_.apirxinterface.md#disconnect">disconnect</a></em></p> <p><em>Implementation of <a href="../interfaces/_rx_types_.apirxinterface.md">ApiRxInterface</a>.<a href="../interfaces/_rx_types_.apirxinterface.md#disconnect">disconnect</a></em></p>
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#disconnect">disconnect</a></em></p> <p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#disconnect">disconnect</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L239" target="_blank">Base.ts:239</a></em></p> <p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L247" target="_blank">Base.ts:247</a></em></p>
<p><em><strong>description</strong></em>: Disconnect from the underlying provider, halting all comms</p> <p><em><strong>description</strong></em>: Disconnect from the underlying provider, halting all comms</p>
<p><strong>Returns:</strong> <code>void</code></p> <p><strong>Returns:</strong> <code>void</code></p>
<hr> <hr>
@@ -2390,7 +2390,7 @@
<h2 id="on">on</h2> <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>this</code></p> <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>this</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>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/b2f0618/packages/api/src/Base.ts#L262" target="_blank">Base.ts:262</a></em></p> <p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L270" target="_blank">Base.ts:270</a></em></p>
<p><em><strong>description</strong></em>: Attach an eventemitter handler to listen to a specific event</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> <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;connected&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> <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;connected&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>
@@ -2429,7 +2429,7 @@
<h2 id="once">once</h2> <h2 id="once">once</h2>
<p>&#x25B8; <strong>once</strong>(type: <em><a href="../modules/_types_.md#apiinterface_events">ApiInterface$Events</a></em>, handler: <em><code>function</code></em>): <code>this</code></p> <p>&#x25B8; <strong>once</strong>(type: <em><a href="../modules/_types_.md#apiinterface_events">ApiInterface$Events</a></em>, handler: <em><code>function</code></em>): <code>this</code></p>
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#once">once</a></em></p> <p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#once">once</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L287" target="_blank">Base.ts:287</a></em></p> <p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L295" target="_blank">Base.ts:295</a></em></p>
<p><em><strong>description</strong></em>: Attach an one-time eventemitter handler to listen to a specific event</p> <p><em><strong>description</strong></em>: Attach an one-time eventemitter handler to listen to a specific event</p>
<p><em><strong>example</strong></em>: </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">once</span><span class="sunlight-punctuation">(</span><span class="sunlight-string">&apos;connected&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> <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">once</span><span class="sunlight-punctuation">(</span><span class="sunlight-string">&apos;connected&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>
@@ -2464,10 +2464,34 @@
</table> </table>
<p><strong>Returns:</strong> <code>this</code></p> <p><strong>Returns:</strong> <code>this</code></p>
<hr> <hr>
<p><a id="setsigner"></a></p>
<h2 id="setsigner">setSigner</h2>
<p>&#x25B8; <strong>setSigner</strong>(signer: <em><a href="../interfaces/_types_.signer.md">Signer</a></em>): <code>void</code></p>
<p><em>Implementation of <a href="../interfaces/_rx_types_.apirxinterface.md">ApiRxInterface</a>.<a href="../interfaces/_rx_types_.apirxinterface.md#setsigner">setSigner</a></em></p>
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#setsigner">setSigner</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L164" target="_blank">Base.ts:164</a></em></p>
<p><em><strong>description</strong></em>: Set an external signer which will be used to sign extrinsic when account passed in is not KeyringPair</p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>signer</td>
<td><a href="../interfaces/_types_.signer.md">Signer</a></td>
</tr>
</tbody>
</table>
<p><strong>Returns:</strong> <code>void</code></p>
<hr>
<p><a id="create"></a></p> <p><a id="create"></a></p>
<h2 id="static-create"><code>&lt;Static&gt;</code> create</h2> <h2 id="static-create"><code>&lt;Static&gt;</code> create</h2>
<p>&#x25B8; <strong>create</strong>(options?: <em><a href="../interfaces/_types_.apioptions.md">ApiOptions</a> | <code>ProviderInterface</code></em>): <code>Observable</code>&lt;<a href="_rx_index_.apirx.html">ApiRx</a>&gt;</p> <p>&#x25B8; <strong>create</strong>(options?: <em><a href="../interfaces/_types_.apioptions.md">ApiOptions</a> | <code>ProviderInterface</code></em>): <code>Observable</code>&lt;<a href="_rx_index_.apirx.html">ApiRx</a>&gt;</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/rx/index.ts#L140" target="_blank">rx/index.ts:140</a></em></p> <p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/rx/index.ts#L140" target="_blank">rx/index.ts:140</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>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> <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-punctuation">{</span>&#xA0;<span class="sunlight-ident">switchMap</span>&#xA0;<span class="sunlight-punctuation">}</span>&#xA0;<span class="sunlight-ident">from</span>&#xA0;<span class="sunlight-string">&apos;rxjs/operators&apos;</span><span class="sunlight-punctuation">;</span> <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-punctuation">{</span>&#xA0;<span class="sunlight-ident">switchMap</span>&#xA0;<span class="sunlight-punctuation">}</span>&#xA0;<span class="sunlight-ident">from</span>&#xA0;<span class="sunlight-string">&apos;rxjs/operators&apos;</span><span class="sunlight-punctuation">;</span>
@@ -2545,7 +2569,7 @@
<script> <script>
var gitbook = gitbook || []; var gitbook = gitbook || [];
gitbook.push(function() { 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":"2019-02-08T14:48:02.282Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-08T14:49:34.586Z"},"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":"2019-02-09T05:19:34.058Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-09T05:21:07.515Z"},"basePath":"../..","book":{"language":""}});
}); });
</script> </script>
</div> </div>
docs/api/classes/_rx_index_.apirx.md
+40 -17
View File
@@ -120,7 +120,7 @@ api.query.system
*Overrides [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)* *Overrides [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
*Defined in [rx/index.ts:142](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/rx/index.ts#L142)* *Defined in [rx/index.ts:142](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/rx/index.ts#L142)*
*__description__*: Create an instance of the ApiRx class *__description__*: Create an instance of the ApiRx class
@@ -160,7 +160,7 @@ getderive(): [Derive](../interfaces/_types_.derive.md)<[RxResult](../modules/_rx
*Inherited from [ApiBase](_base_.apibase.md).[derive](_base_.apibase.md#derive)* *Inherited from [ApiBase](_base_.apibase.md).[derive](_base_.apibase.md#derive)*
*Defined in [Base.ts:172](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L172)* *Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L180)*
*__description__*: Derived results that are injected into the API, allowing for combinations of various query results. *__description__*: Derived results that are injected into the API, allowing for combinations of various query results.
@@ -183,7 +183,7 @@ getgenesisHash(): `Hash`
*Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)* *Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)*
*Defined in [Base.ts:122](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L122)* *Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L123)*
*__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. *__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.
@@ -198,7 +198,7 @@ gethasSubscriptions(): `boolean`
*Inherited from [ApiBase](_base_.apibase.md).[hasSubscriptions](_base_.apibase.md#hassubscriptions)* *Inherited from [ApiBase](_base_.apibase.md).[hasSubscriptions](_base_.apibase.md#hassubscriptions)*
*Defined in [Base.ts:131](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L131)* *Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L132)*
*__description__*: `true` when subscriptions are supported *__description__*: `true` when subscriptions are supported
@@ -211,7 +211,7 @@ ___
getisConnected(): `Observable`<`boolean`> getisConnected(): `Observable`<`boolean`>
*Defined in [rx/index.ts:182](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/rx/index.ts#L182)* *Defined in [rx/index.ts:182](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/rx/index.ts#L182)*
*__description__*: Observable that carries the connected state for the provider. Results in a boolean flag that is true/false based on the connectivity. *__description__*: Observable that carries the connected state for the provider. Results in a boolean flag that is true/false based on the connectivity.
@@ -224,7 +224,7 @@ ___
getisReady(): `Observable`<[ApiRx](_rx_index_.apirx.md)> getisReady(): `Observable`<[ApiRx](_rx_index_.apirx.md)>
*Defined in [rx/index.ts:189](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/rx/index.ts#L189)* *Defined in [rx/index.ts:189](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/rx/index.ts#L189)*
*__description__*: Observable that returns the first time we are connected and loaded *__description__*: Observable that returns the first time we are connected and loaded
@@ -239,7 +239,7 @@ getquery(): [QueryableStorage](../interfaces/_types_.queryablestorage.md)<[RxRes
*Inherited from [ApiBase](_base_.apibase.md).[query](_base_.apibase.md#query)* *Inherited from [ApiBase](_base_.apibase.md).[query](_base_.apibase.md#query)*
*Defined in [Base.ts:192](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L192)* *Defined in [Base.ts:200](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L200)*
*__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata. *__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.
@@ -264,7 +264,7 @@ getrpc(): [DecoratedRpc](../interfaces/_types_.decoratedrpc.md)<[RxResult](../mo
*Inherited from [ApiBase](_base_.apibase.md).[rpc](_base_.apibase.md#rpc)* *Inherited from [ApiBase](_base_.apibase.md).[rpc](_base_.apibase.md#rpc)*
*Defined in [Base.ts:212](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L212)* *Defined in [Base.ts:220](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L220)*
*__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. *__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.
@@ -289,7 +289,7 @@ getruntimeMetadata(): `Metadata`
*Inherited from [ApiBase](_base_.apibase.md).[runtimeMetadata](_base_.apibase.md#runtimemetadata)* *Inherited from [ApiBase](_base_.apibase.md).[runtimeMetadata](_base_.apibase.md#runtimemetadata)*
*Defined in [Base.ts:138](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L138)* *Defined in [Base.ts:139](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L139)*
*__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection. *__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.
@@ -304,7 +304,7 @@ getruntimeVersion(): `RuntimeVersion`
*Inherited from [ApiBase](_base_.apibase.md).[runtimeVersion](_base_.apibase.md#runtimeversion)* *Inherited from [ApiBase](_base_.apibase.md).[runtimeVersion](_base_.apibase.md#runtimeversion)*
*Defined in [Base.ts:147](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L147)* *Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L148)*
*__description__*: Contains the version information for the current runtime. *__description__*: Contains the version information for the current runtime.
@@ -319,7 +319,7 @@ gettx(): [SubmittableExtrinsics](../interfaces/_types_.submittableextrinsics.md)
*Inherited from [ApiBase](_base_.apibase.md).[tx](_base_.apibase.md#tx)* *Inherited from [ApiBase](_base_.apibase.md).[tx](_base_.apibase.md#tx)*
*Defined in [Base.ts:230](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L230)* *Defined in [Base.ts:238](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L238)*
*__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. *__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.
@@ -344,7 +344,7 @@ gettype(): [ApiType](../modules/_types_.md#apitype)
*Inherited from [ApiBase](_base_.apibase.md).[type](_base_.apibase.md#type)* *Inherited from [ApiBase](_base_.apibase.md).[type](_base_.apibase.md#type)*
*Defined in [Base.ts:156](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L156)* *Defined in [Base.ts:157](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L157)*
*__description__*: The type of this API instance, either 'rxjs' or 'promise' *__description__*: The type of this API instance, either 'rxjs' or 'promise'
@@ -360,7 +360,7 @@ ___
▸ **clone**(): [ApiRx](_rx_index_.apirx.md) ▸ **clone**(): [ApiRx](_rx_index_.apirx.md)
*Defined in [rx/index.ts:196](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/rx/index.ts#L196)* *Defined in [rx/index.ts:196](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/rx/index.ts#L196)*
*__description__*: Returns a clone of this ApiRx instance (new underlying provider connection) *__description__*: Returns a clone of this ApiRx instance (new underlying provider connection)
@@ -377,7 +377,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[disconnect](_base_.apibase.md#disconnect)* *Inherited from [ApiBase](_base_.apibase.md).[disconnect](_base_.apibase.md#disconnect)*
*Defined in [Base.ts:239](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L239)* *Defined in [Base.ts:247](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L247)*
*__description__*: Disconnect from the underlying provider, halting all comms *__description__*: Disconnect from the underlying provider, halting all comms
@@ -392,7 +392,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[on](_base_.apibase.md#on)* *Inherited from [ApiBase](_base_.apibase.md).[on](_base_.apibase.md#on)*
*Defined in [Base.ts:262](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L262)* *Defined in [Base.ts:270](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L270)*
*__description__*: Attach an eventemitter handler to listen to a specific event *__description__*: Attach an eventemitter handler to listen to a specific event
@@ -426,7 +426,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[once](_base_.apibase.md#once)* *Inherited from [ApiBase](_base_.apibase.md).[once](_base_.apibase.md#once)*
*Defined in [Base.ts:287](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L287)* *Defined in [Base.ts:295](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L295)*
*__description__*: Attach an one-time eventemitter handler to listen to a specific event *__description__*: Attach an one-time eventemitter handler to listen to a specific event
@@ -451,6 +451,29 @@ api.once('disconnected', () => {
**Returns:** `this` **Returns:** `this`
___
<a id="setsigner"></a>
## setSigner
▸ **setSigner**(signer: *[Signer](../interfaces/_types_.signer.md)*): `void`
*Implementation of [ApiRxInterface](../interfaces/_rx_types_.apirxinterface.md).[setSigner](../interfaces/_rx_types_.apirxinterface.md#setsigner)*
*Inherited from [ApiBase](_base_.apibase.md).[setSigner](_base_.apibase.md#setsigner)*
*Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L164)*
*__description__*: Set an external signer which will be used to sign extrinsic when account passed in is not KeyringPair
**Parameters:**
| Name | Type |
| ------ | ------ |
| signer | [Signer](../interfaces/_types_.signer.md) |
**Returns:** `void`
___ ___
<a id="create"></a> <a id="create"></a>
@@ -458,7 +481,7 @@ ___
▸ **create**(options?: *[ApiOptions](../interfaces/_types_.apioptions.md) | `ProviderInterface`*): `Observable`<[ApiRx](_rx_index_.apirx.md)> ▸ **create**(options?: *[ApiOptions](../interfaces/_types_.apioptions.md) | `ProviderInterface`*): `Observable`<[ApiRx](_rx_index_.apirx.md)>
*Defined in [rx/index.ts:140](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/rx/index.ts#L140)* *Defined in [rx/index.ts:140](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/rx/index.ts#L140)*
*__description__*: Creates an ApiRx instance using the supplied provider. Returns an Observable containing the actual Api instance. *__description__*: Creates an ApiRx instance using the supplied provider. Returns an Observable containing the actual Api instance.
docs/api/classes/_submittableextrinsic_.submittableextrinsic.md
+32 -32
View File
@@ -27,7 +27,7 @@
*Overrides Extrinsic.__constructor* *Overrides Extrinsic.__constructor*
*Defined in [SubmittableExtrinsic.ts:70](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/SubmittableExtrinsic.ts#L70)* *Defined in [SubmittableExtrinsic.ts:70](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/SubmittableExtrinsic.ts#L70)*
**Parameters:** **Parameters:**
@@ -77,7 +77,7 @@ getType(): `E`
*Inherited from Struct.Type* *Inherited from Struct.Type*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/b2f0618/packages/types/src/codec/Struct.ts#L142)* *Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/c1672e8/packages/types/src/codec/Struct.ts#L142)*
*__description__*: Returns the Type description to sthe structure *__description__*: Returns the Type description to sthe structure
@@ -92,7 +92,7 @@ getargs(): `Array`<`Codec`>
*Inherited from Extrinsic.args* *Inherited from Extrinsic.args*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:76](https://github.com/polkadot-js/api/blob/b2f0618/packages/types/src/Extrinsic.ts#L76)* *Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:76](https://github.com/polkadot-js/api/blob/c1672e8/packages/types/src/Extrinsic.ts#L76)*
*__description__*: The arguments passed to for the call, exposes args so it is compatible with \[\[Method\]\] *__description__*: The arguments passed to for the call, exposes args so it is compatible with \[\[Method\]\]
@@ -107,7 +107,7 @@ getcallIndex(): `Uint8Array`
*Inherited from Extrinsic.callIndex* *Inherited from Extrinsic.callIndex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:83](https://github.com/polkadot-js/api/blob/b2f0618/packages/types/src/Extrinsic.ts#L83)* *Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:83](https://github.com/polkadot-js/api/blob/c1672e8/packages/types/src/Extrinsic.ts#L83)*
*__description__*: The actual `[sectionIndex, methodIndex]` as used in the Method *__description__*: The actual `[sectionIndex, methodIndex]` as used in the Method
@@ -122,7 +122,7 @@ getdata(): `Uint8Array`
*Inherited from Extrinsic.data* *Inherited from Extrinsic.data*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:90](https://github.com/polkadot-js/api/blob/b2f0618/packages/types/src/Extrinsic.ts#L90)* *Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:90](https://github.com/polkadot-js/api/blob/c1672e8/packages/types/src/Extrinsic.ts#L90)*
*__description__*: The actual data for the Method *__description__*: The actual data for the Method
@@ -139,7 +139,7 @@ getencodedLength(): `number`
*Overrides Struct.encodedLength* *Overrides Struct.encodedLength*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:97](https://github.com/polkadot-js/api/blob/b2f0618/packages/types/src/Extrinsic.ts#L97)* *Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:97](https://github.com/polkadot-js/api/blob/c1672e8/packages/types/src/Extrinsic.ts#L97)*
*__description__*: The length of the value when encoded as a Uint8Array *__description__*: The length of the value when encoded as a Uint8Array
@@ -154,7 +154,7 @@ gethash(): `Hash`
*Inherited from Extrinsic.hash* *Inherited from Extrinsic.hash*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:106](https://github.com/polkadot-js/api/blob/b2f0618/packages/types/src/Extrinsic.ts#L106)* *Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:106](https://github.com/polkadot-js/api/blob/c1672e8/packages/types/src/Extrinsic.ts#L106)*
*__description__*: Convernience function, encodes the extrinsic and returns the actual hash *__description__*: Convernience function, encodes the extrinsic and returns the actual hash
@@ -169,7 +169,7 @@ getisSigned(): `boolean`
*Inherited from Extrinsic.isSigned* *Inherited from Extrinsic.isSigned*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:115](https://github.com/polkadot-js/api/blob/b2f0618/packages/types/src/Extrinsic.ts#L115)* *Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:115](https://github.com/polkadot-js/api/blob/c1672e8/packages/types/src/Extrinsic.ts#L115)*
*__description__*: `true` id the extrinsic is signed *__description__*: `true` id the extrinsic is signed
@@ -184,7 +184,7 @@ getlength(): `number`
*Inherited from Extrinsic.length* *Inherited from Extrinsic.length*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:122](https://github.com/polkadot-js/api/blob/b2f0618/packages/types/src/Extrinsic.ts#L122)* *Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:122](https://github.com/polkadot-js/api/blob/c1672e8/packages/types/src/Extrinsic.ts#L122)*
*__description__*: The length of the encoded value *__description__*: The length of the encoded value
@@ -199,7 +199,7 @@ getmeta(): `FunctionMetadata`
*Inherited from Extrinsic.meta* *Inherited from Extrinsic.meta*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:129](https://github.com/polkadot-js/api/blob/b2f0618/packages/types/src/Extrinsic.ts#L129)* *Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:129](https://github.com/polkadot-js/api/blob/c1672e8/packages/types/src/Extrinsic.ts#L129)*
*__description__*: The \[\[FunctionMetadata\]\] that describes the extrinsic *__description__*: The \[\[FunctionMetadata\]\] that describes the extrinsic
@@ -214,7 +214,7 @@ getmethod(): `Method`
*Inherited from Extrinsic.method* *Inherited from Extrinsic.method*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:136](https://github.com/polkadot-js/api/blob/b2f0618/packages/types/src/Extrinsic.ts#L136)* *Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:136](https://github.com/polkadot-js/api/blob/c1672e8/packages/types/src/Extrinsic.ts#L136)*
*__description__*: The \[\[Method\]\] this extrinsic wraps *__description__*: The \[\[Method\]\] this extrinsic wraps
@@ -229,7 +229,7 @@ getsignature(): `ExtrinsicSignature`
*Inherited from Extrinsic.signature* *Inherited from Extrinsic.signature*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:143](https://github.com/polkadot-js/api/blob/b2f0618/packages/types/src/Extrinsic.ts#L143)* *Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:143](https://github.com/polkadot-js/api/blob/c1672e8/packages/types/src/Extrinsic.ts#L143)*
*__description__*: The \[\[ExtrinsicSignature\]\] *__description__*: The \[\[ExtrinsicSignature\]\]
@@ -262,7 +262,7 @@ ___
*Inherited from Extrinsic.addSignature* *Inherited from Extrinsic.addSignature*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:150](https://github.com/polkadot-js/api/blob/b2f0618/packages/types/src/Extrinsic.ts#L150)* *Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:150](https://github.com/polkadot-js/api/blob/c1672e8/packages/types/src/Extrinsic.ts#L150)*
*__description__*: Add an \[\[ExtrinsicSignature\]\] to the extrinsic (already generated) *__description__*: Add an \[\[ExtrinsicSignature\]\] to the extrinsic (already generated)
@@ -333,7 +333,7 @@ ___
*Inherited from Struct.eq* *Inherited from Struct.eq*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/b2f0618/packages/types/src/codec/Struct.ts#L158)* *Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/c1672e8/packages/types/src/codec/Struct.ts#L158)*
*__description__*: Compares the value of the input to see if there is a match *__description__*: Compares the value of the input to see if there is a match
@@ -376,7 +376,7 @@ ___
*Overrides Map.get* *Overrides Map.get*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/b2f0618/packages/types/src/codec/Struct.ts#L166)* *Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/c1672e8/packages/types/src/codec/Struct.ts#L166)*
*__description__*: Returns a specific names entry in the structure *__description__*: Returns a specific names entry in the structure
@@ -397,7 +397,7 @@ ___
*Inherited from Struct.getAtIndex* *Inherited from Struct.getAtIndex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/b2f0618/packages/types/src/codec/Struct.ts#L173)* *Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/c1672e8/packages/types/src/codec/Struct.ts#L173)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
@@ -452,11 +452,11 @@ ___
▸ **send**(statusCb: *`function`*): `SumbitableResultSubscription`<`CodecResult`, `SubscriptionResult`> ▸ **send**(statusCb: *`function`*): `SumbitableResultSubscription`<`CodecResult`, `SubscriptionResult`>
*Defined in [SubmittableExtrinsic.ts:120](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/SubmittableExtrinsic.ts#L120)* *Defined in [SubmittableExtrinsic.ts:120](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/SubmittableExtrinsic.ts#L120)*
**Returns:** `SumbitableResultResult`<`CodecResult`, `SubscriptionResult`> **Returns:** `SumbitableResultResult`<`CodecResult`, `SubscriptionResult`>
*Defined in [SubmittableExtrinsic.ts:121](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/SubmittableExtrinsic.ts#L121)* *Defined in [SubmittableExtrinsic.ts:121](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/SubmittableExtrinsic.ts#L121)*
**Parameters:** **Parameters:**
@@ -495,7 +495,7 @@ ___
*Overrides Extrinsic.sign* *Overrides Extrinsic.sign*
*Defined in [SubmittableExtrinsic.ts:138](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/SubmittableExtrinsic.ts#L138)* *Defined in [SubmittableExtrinsic.ts:138](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/SubmittableExtrinsic.ts#L138)*
**Parameters:** **Parameters:**
@@ -511,28 +511,28 @@ ___
## signAndSend ## signAndSend
▸ **signAndSend**(account: *`KeyringPair`*, options?: *`Partial`<`SignatureOptionsPartial`>*): `SumbitableResultResult`<`CodecResult`, `SubscriptionResult`> ▸ **signAndSend**(account: *`KeyringPair` | `string` | `AccountId` | `Address`*, options?: *`Partial`<`SignatureOptionsPartial`>*): `SumbitableResultResult`<`CodecResult`, `SubscriptionResult`>
▸ **signAndSend**(account: *`KeyringPair`*, statusCb: *`StatusCb`*): `SumbitableResultSubscription`<`CodecResult`, `SubscriptionResult`> ▸ **signAndSend**(account: *`KeyringPair` | `string` | `AccountId` | `Address`*, statusCb: *`StatusCb`*): `SumbitableResultSubscription`<`CodecResult`, `SubscriptionResult`>
*Defined in [SubmittableExtrinsic.ts:154](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/SubmittableExtrinsic.ts#L154)* *Defined in [SubmittableExtrinsic.ts:154](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/SubmittableExtrinsic.ts#L154)*
**Parameters:** **Parameters:**
| Name | Type | | Name | Type |
| ------ | ------ | | ------ | ------ |
| account | `KeyringPair` | | account | `KeyringPair` | `string` | `AccountId` | `Address` |
| `Optional` options | `Partial`<`SignatureOptionsPartial`> | | `Optional` options | `Partial`<`SignatureOptionsPartial`> |
**Returns:** `SumbitableResultResult`<`CodecResult`, `SubscriptionResult`> **Returns:** `SumbitableResultResult`<`CodecResult`, `SubscriptionResult`>
*Defined in [SubmittableExtrinsic.ts:155](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/SubmittableExtrinsic.ts#L155)* *Defined in [SubmittableExtrinsic.ts:155](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/SubmittableExtrinsic.ts#L155)*
**Parameters:** **Parameters:**
| Name | Type | | Name | Type |
| ------ | ------ | | ------ | ------ |
| account | `KeyringPair` | | account | `KeyringPair` | `string` | `AccountId` | `Address` |
| statusCb | `StatusCb` | | statusCb | `StatusCb` |
**Returns:** `SumbitableResultSubscription`<`CodecResult`, `SubscriptionResult`> **Returns:** `SumbitableResultSubscription`<`CodecResult`, `SubscriptionResult`>
@@ -546,7 +546,7 @@ ___
*Inherited from Struct.toArray* *Inherited from Struct.toArray*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/b2f0618/packages/types/src/codec/Struct.ts#L180)* *Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/c1672e8/packages/types/src/codec/Struct.ts#L180)*
*__description__*: Converts the Object to an standard JavaScript Array *__description__*: Converts the Object to an standard JavaScript Array
@@ -563,7 +563,7 @@ ___
*Overrides Struct.toHex* *Overrides Struct.toHex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:168](https://github.com/polkadot-js/api/blob/b2f0618/packages/types/src/Extrinsic.ts#L168)* *Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:168](https://github.com/polkadot-js/api/blob/c1672e8/packages/types/src/Extrinsic.ts#L168)*
*__description__*: Returns a hex string representation of the value *__description__*: Returns a hex string representation of the value
@@ -580,7 +580,7 @@ ___
*Overrides Struct.toJSON* *Overrides Struct.toJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:175](https://github.com/polkadot-js/api/blob/b2f0618/packages/types/src/Extrinsic.ts#L175)* *Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:175](https://github.com/polkadot-js/api/blob/c1672e8/packages/types/src/Extrinsic.ts#L175)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers *__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -595,7 +595,7 @@ ___
*Inherited from Struct.toString* *Inherited from Struct.toString*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/b2f0618/packages/types/src/codec/Struct.ts#L208)* *Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/c1672e8/packages/types/src/codec/Struct.ts#L208)*
*__description__*: Returns the string representation of the value *__description__*: Returns the string representation of the value
@@ -612,7 +612,7 @@ ___
*Overrides Struct.toU8a* *Overrides Struct.toU8a*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:183](https://github.com/polkadot-js/api/blob/b2f0618/packages/types/src/Extrinsic.ts#L183)* *Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:183](https://github.com/polkadot-js/api/blob/c1672e8/packages/types/src/Extrinsic.ts#L183)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -648,7 +648,7 @@ ___
*Inherited from Extrinsic.decodeExtrinsic* *Inherited from Extrinsic.decodeExtrinsic*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:44](https://github.com/polkadot-js/api/blob/b2f0618/packages/types/src/Extrinsic.ts#L44)* *Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:44](https://github.com/polkadot-js/api/blob/c1672e8/packages/types/src/Extrinsic.ts#L44)*
**Parameters:** **Parameters:**
@@ -667,7 +667,7 @@ ___
*Inherited from Struct.with* *Inherited from Struct.with*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/b2f0618/packages/types/src/codec/Struct.ts#L122)* *Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/c1672e8/packages/types/src/codec/Struct.ts#L122)*
**Type parameters:** **Type parameters:**
docs/api/classes/_submittableextrinsic_.submittableresult.md
+15 -15
View File
@@ -25,7 +25,7 @@
*Overrides Struct.__constructor* *Overrides Struct.__constructor*
*Defined in [SubmittableExtrinsic.ts:36](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/SubmittableExtrinsic.ts#L36)* *Defined in [SubmittableExtrinsic.ts:36](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/SubmittableExtrinsic.ts#L36)*
**Parameters:** **Parameters:**
@@ -72,7 +72,7 @@ getType(): `E`
*Inherited from Struct.Type* *Inherited from Struct.Type*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/b2f0618/packages/types/src/codec/Struct.ts#L142)* *Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/c1672e8/packages/types/src/codec/Struct.ts#L142)*
*__description__*: Returns the Type description to sthe structure *__description__*: Returns the Type description to sthe structure
@@ -87,7 +87,7 @@ getencodedLength(): `number`
*Inherited from Struct.encodedLength* *Inherited from Struct.encodedLength*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/b2f0618/packages/types/src/codec/Struct.ts#L149)* *Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/c1672e8/packages/types/src/codec/Struct.ts#L149)*
*__description__*: The length of the value when encoded as a Uint8Array *__description__*: The length of the value when encoded as a Uint8Array
@@ -100,7 +100,7 @@ ___
getevents(): `Array`<`EventRecord`> getevents(): `Array`<`EventRecord`>
*Defined in [SubmittableExtrinsic.ts:48](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/SubmittableExtrinsic.ts#L48)* *Defined in [SubmittableExtrinsic.ts:48](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/SubmittableExtrinsic.ts#L48)*
*__description__*: the contained events *__description__*: the contained events
@@ -113,7 +113,7 @@ ___
getstatus(): `ExtrinsicStatus` getstatus(): `ExtrinsicStatus`
*Defined in [SubmittableExtrinsic.ts:55](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/SubmittableExtrinsic.ts#L55)* *Defined in [SubmittableExtrinsic.ts:55](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/SubmittableExtrinsic.ts#L55)*
*__description__*: the status *__description__*: the status
@@ -126,7 +126,7 @@ ___
gettype(): `string` gettype(): `string`
*Defined in [SubmittableExtrinsic.ts:62](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/SubmittableExtrinsic.ts#L62)* *Defined in [SubmittableExtrinsic.ts:62](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/SubmittableExtrinsic.ts#L62)*
*__description__*: the type *__description__*: the type
@@ -206,7 +206,7 @@ ___
*Inherited from Struct.eq* *Inherited from Struct.eq*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/b2f0618/packages/types/src/codec/Struct.ts#L158)* *Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/c1672e8/packages/types/src/codec/Struct.ts#L158)*
*__description__*: Compares the value of the input to see if there is a match *__description__*: Compares the value of the input to see if there is a match
@@ -249,7 +249,7 @@ ___
*Overrides Map.get* *Overrides Map.get*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/b2f0618/packages/types/src/codec/Struct.ts#L166)* *Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/c1672e8/packages/types/src/codec/Struct.ts#L166)*
*__description__*: Returns a specific names entry in the structure *__description__*: Returns a specific names entry in the structure
@@ -270,7 +270,7 @@ ___
*Inherited from Struct.getAtIndex* *Inherited from Struct.getAtIndex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/b2f0618/packages/types/src/codec/Struct.ts#L173)* *Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/c1672e8/packages/types/src/codec/Struct.ts#L173)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
@@ -345,7 +345,7 @@ ___
*Inherited from Struct.toArray* *Inherited from Struct.toArray*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/b2f0618/packages/types/src/codec/Struct.ts#L180)* *Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/c1672e8/packages/types/src/codec/Struct.ts#L180)*
*__description__*: Converts the Object to an standard JavaScript Array *__description__*: Converts the Object to an standard JavaScript Array
@@ -360,7 +360,7 @@ ___
*Inherited from Struct.toHex* *Inherited from Struct.toHex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/b2f0618/packages/types/src/codec/Struct.ts#L187)* *Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/c1672e8/packages/types/src/codec/Struct.ts#L187)*
*__description__*: Returns a hex string representation of the value *__description__*: Returns a hex string representation of the value
@@ -375,7 +375,7 @@ ___
*Inherited from Struct.toJSON* *Inherited from Struct.toJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/b2f0618/packages/types/src/codec/Struct.ts#L194)* *Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/c1672e8/packages/types/src/codec/Struct.ts#L194)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers *__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -390,7 +390,7 @@ ___
*Inherited from Struct.toString* *Inherited from Struct.toString*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/b2f0618/packages/types/src/codec/Struct.ts#L208)* *Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/c1672e8/packages/types/src/codec/Struct.ts#L208)*
*__description__*: Returns the string representation of the value *__description__*: Returns the string representation of the value
@@ -405,7 +405,7 @@ ___
*Inherited from Struct.toU8a* *Inherited from Struct.toU8a*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/b2f0618/packages/types/src/codec/Struct.ts#L216)* *Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/c1672e8/packages/types/src/codec/Struct.ts#L216)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -441,7 +441,7 @@ ___
*Inherited from Struct.with* *Inherited from Struct.with*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/b2f0618/packages/types/src/codec/Struct.ts#L122)* *Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/c1672e8/packages/types/src/codec/Struct.ts#L122)*
**Type parameters:** **Type parameters:**
docs/api/index.html
+1 -1
View File
@@ -2237,7 +2237,7 @@
<script> <script>
var gitbook = gitbook || []; var gitbook = gitbook || [];
gitbook.push(function() { 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":"2019-02-08T14:48:01.562Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-08T14:49:34.586Z"},"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":"2019-02-09T05:19:33.322Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-09T05:21:07.515Z"},"basePath":"..","book":{"language":""}});
}); });
</script> </script>
</div> </div>
docs/api/interfaces/_promise_types_.apipromiseinterface.md
+35 -14
View File
@@ -24,7 +24,7 @@
*Inherited from [ApiBase](../classes/_base_.apibase.md).[constructor](../classes/_base_.apibase.md#constructor)* *Inherited from [ApiBase](../classes/_base_.apibase.md).[constructor](../classes/_base_.apibase.md#constructor)*
*Defined in [Base.ts:72](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L72)* *Defined in [Base.ts:72](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L72)*
*__description__*: Create an instance of the class *__description__*: Create an instance of the class
@@ -59,7 +59,7 @@ ___
**● isReady**: *`Promise`<[ApiPromiseInterface](_promise_types_.apipromiseinterface.md)>* **● isReady**: *`Promise`<[ApiPromiseInterface](_promise_types_.apipromiseinterface.md)>*
*Defined in [promise/types.ts:16](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/promise/types.ts#L16)* *Defined in [promise/types.ts:16](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/promise/types.ts#L16)*
___ ___
@@ -73,7 +73,7 @@ getderive(): [Derive](_types_.derive.md)<[CodecResult](../modules/_promise_types
*Inherited from [ApiBase](../classes/_base_.apibase.md).[derive](../classes/_base_.apibase.md#derive)* *Inherited from [ApiBase](../classes/_base_.apibase.md).[derive](../classes/_base_.apibase.md#derive)*
*Defined in [Base.ts:172](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L172)* *Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L180)*
*__description__*: Derived results that are injected into the API, allowing for combinations of various query results. *__description__*: Derived results that are injected into the API, allowing for combinations of various query results.
@@ -96,7 +96,7 @@ getgenesisHash(): `Hash`
*Inherited from [ApiBase](../classes/_base_.apibase.md).[genesisHash](../classes/_base_.apibase.md#genesishash)* *Inherited from [ApiBase](../classes/_base_.apibase.md).[genesisHash](../classes/_base_.apibase.md#genesishash)*
*Defined in [Base.ts:122](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L122)* *Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L123)*
*__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. *__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.
@@ -111,7 +111,7 @@ gethasSubscriptions(): `boolean`
*Inherited from [ApiBase](../classes/_base_.apibase.md).[hasSubscriptions](../classes/_base_.apibase.md#hassubscriptions)* *Inherited from [ApiBase](../classes/_base_.apibase.md).[hasSubscriptions](../classes/_base_.apibase.md#hassubscriptions)*
*Defined in [Base.ts:131](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L131)* *Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L132)*
*__description__*: `true` when subscriptions are supported *__description__*: `true` when subscriptions are supported
@@ -126,7 +126,7 @@ getquery(): [QueryableStorage](_types_.queryablestorage.md)<[CodecResult](../mod
*Inherited from [ApiBase](../classes/_base_.apibase.md).[query](../classes/_base_.apibase.md#query)* *Inherited from [ApiBase](../classes/_base_.apibase.md).[query](../classes/_base_.apibase.md#query)*
*Defined in [Base.ts:192](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L192)* *Defined in [Base.ts:200](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L200)*
*__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata. *__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.
@@ -151,7 +151,7 @@ getrpc(): [DecoratedRpc](_types_.decoratedrpc.md)<[CodecResult](../modules/_prom
*Inherited from [ApiBase](../classes/_base_.apibase.md).[rpc](../classes/_base_.apibase.md#rpc)* *Inherited from [ApiBase](../classes/_base_.apibase.md).[rpc](../classes/_base_.apibase.md#rpc)*
*Defined in [Base.ts:212](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L212)* *Defined in [Base.ts:220](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L220)*
*__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. *__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.
@@ -176,7 +176,7 @@ getruntimeMetadata(): `Metadata`
*Inherited from [ApiBase](../classes/_base_.apibase.md).[runtimeMetadata](../classes/_base_.apibase.md#runtimemetadata)* *Inherited from [ApiBase](../classes/_base_.apibase.md).[runtimeMetadata](../classes/_base_.apibase.md#runtimemetadata)*
*Defined in [Base.ts:138](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L138)* *Defined in [Base.ts:139](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L139)*
*__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection. *__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.
@@ -191,7 +191,7 @@ getruntimeVersion(): `RuntimeVersion`
*Inherited from [ApiBase](../classes/_base_.apibase.md).[runtimeVersion](../classes/_base_.apibase.md#runtimeversion)* *Inherited from [ApiBase](../classes/_base_.apibase.md).[runtimeVersion](../classes/_base_.apibase.md#runtimeversion)*
*Defined in [Base.ts:147](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L147)* *Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L148)*
*__description__*: Contains the version information for the current runtime. *__description__*: Contains the version information for the current runtime.
@@ -206,7 +206,7 @@ gettx(): [SubmittableExtrinsics](_types_.submittableextrinsics.md)<[CodecResult]
*Inherited from [ApiBase](../classes/_base_.apibase.md).[tx](../classes/_base_.apibase.md#tx)* *Inherited from [ApiBase](../classes/_base_.apibase.md).[tx](../classes/_base_.apibase.md#tx)*
*Defined in [Base.ts:230](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L230)* *Defined in [Base.ts:238](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L238)*
*__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. *__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.
@@ -231,7 +231,7 @@ gettype(): [ApiType](../modules/_types_.md#apitype)
*Inherited from [ApiBase](../classes/_base_.apibase.md).[type](../classes/_base_.apibase.md#type)* *Inherited from [ApiBase](../classes/_base_.apibase.md).[type](../classes/_base_.apibase.md#type)*
*Defined in [Base.ts:156](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L156)* *Defined in [Base.ts:157](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L157)*
*__description__*: The type of this API instance, either 'rxjs' or 'promise' *__description__*: The type of this API instance, either 'rxjs' or 'promise'
@@ -249,7 +249,7 @@ ___
*Inherited from [ApiBase](../classes/_base_.apibase.md).[disconnect](../classes/_base_.apibase.md#disconnect)* *Inherited from [ApiBase](../classes/_base_.apibase.md).[disconnect](../classes/_base_.apibase.md#disconnect)*
*Defined in [Base.ts:239](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L239)* *Defined in [Base.ts:247](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L247)*
*__description__*: Disconnect from the underlying provider, halting all comms *__description__*: Disconnect from the underlying provider, halting all comms
@@ -264,7 +264,7 @@ ___
*Inherited from [ApiBase](../classes/_base_.apibase.md).[on](../classes/_base_.apibase.md#on)* *Inherited from [ApiBase](../classes/_base_.apibase.md).[on](../classes/_base_.apibase.md#on)*
*Defined in [Base.ts:262](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L262)* *Defined in [Base.ts:270](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L270)*
*__description__*: Attach an eventemitter handler to listen to a specific event *__description__*: Attach an eventemitter handler to listen to a specific event
@@ -298,7 +298,7 @@ ___
*Inherited from [ApiBase](../classes/_base_.apibase.md).[once](../classes/_base_.apibase.md#once)* *Inherited from [ApiBase](../classes/_base_.apibase.md).[once](../classes/_base_.apibase.md#once)*
*Defined in [Base.ts:287](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L287)* *Defined in [Base.ts:295](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L295)*
*__description__*: Attach an one-time eventemitter handler to listen to a specific event *__description__*: Attach an one-time eventemitter handler to listen to a specific event
@@ -324,4 +324,25 @@ api.once('disconnected', () => {
**Returns:** `this` **Returns:** `this`
___ ___
<a id="setsigner"></a>
## setSigner
▸ **setSigner**(signer: *[Signer](_types_.signer.md)*): `void`
*Inherited from [ApiBase](../classes/_base_.apibase.md).[setSigner](../classes/_base_.apibase.md#setsigner)*
*Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L164)*
*__description__*: Set an external signer which will be used to sign extrinsic when account passed in is not KeyringPair
**Parameters:**
| Name | Type |
| ------ | ------ |
| signer | [Signer](_types_.signer.md) |
**Returns:** `void`
___
docs/api/interfaces/_rx_types_.apirxinterface.md
+36 -15
View File
@@ -24,7 +24,7 @@
*Inherited from [ApiBase](../classes/_base_.apibase.md).[constructor](../classes/_base_.apibase.md#constructor)* *Inherited from [ApiBase](../classes/_base_.apibase.md).[constructor](../classes/_base_.apibase.md#constructor)*
*Defined in [Base.ts:72](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L72)* *Defined in [Base.ts:72](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L72)*
*__description__*: Create an instance of the class *__description__*: Create an instance of the class
@@ -59,7 +59,7 @@ ___
**● isConnected**: *`Observable`<`boolean`>* **● isConnected**: *`Observable`<`boolean`>*
*Defined in [rx/types.ts:13](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/rx/types.ts#L13)* *Defined in [rx/types.ts:13](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/rx/types.ts#L13)*
___ ___
<a id="isready"></a> <a id="isready"></a>
@@ -68,7 +68,7 @@ ___
**● isReady**: *`Observable`<[ApiRxInterface](_rx_types_.apirxinterface.md)>* **● isReady**: *`Observable`<[ApiRxInterface](_rx_types_.apirxinterface.md)>*
*Defined in [rx/types.ts:14](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/rx/types.ts#L14)* *Defined in [rx/types.ts:14](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/rx/types.ts#L14)*
___ ___
@@ -82,7 +82,7 @@ getderive(): [Derive](_types_.derive.md)<[RxResult](../modules/_rx_types_.md#rxr
*Inherited from [ApiBase](../classes/_base_.apibase.md).[derive](../classes/_base_.apibase.md#derive)* *Inherited from [ApiBase](../classes/_base_.apibase.md).[derive](../classes/_base_.apibase.md#derive)*
*Defined in [Base.ts:172](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L172)* *Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L180)*
*__description__*: Derived results that are injected into the API, allowing for combinations of various query results. *__description__*: Derived results that are injected into the API, allowing for combinations of various query results.
@@ -105,7 +105,7 @@ getgenesisHash(): `Hash`
*Inherited from [ApiBase](../classes/_base_.apibase.md).[genesisHash](../classes/_base_.apibase.md#genesishash)* *Inherited from [ApiBase](../classes/_base_.apibase.md).[genesisHash](../classes/_base_.apibase.md#genesishash)*
*Defined in [Base.ts:122](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L122)* *Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L123)*
*__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. *__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.
@@ -120,7 +120,7 @@ gethasSubscriptions(): `boolean`
*Inherited from [ApiBase](../classes/_base_.apibase.md).[hasSubscriptions](../classes/_base_.apibase.md#hassubscriptions)* *Inherited from [ApiBase](../classes/_base_.apibase.md).[hasSubscriptions](../classes/_base_.apibase.md#hassubscriptions)*
*Defined in [Base.ts:131](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L131)* *Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L132)*
*__description__*: `true` when subscriptions are supported *__description__*: `true` when subscriptions are supported
@@ -135,7 +135,7 @@ getquery(): [QueryableStorage](_types_.queryablestorage.md)<[RxResult](../module
*Inherited from [ApiBase](../classes/_base_.apibase.md).[query](../classes/_base_.apibase.md#query)* *Inherited from [ApiBase](../classes/_base_.apibase.md).[query](../classes/_base_.apibase.md#query)*
*Defined in [Base.ts:192](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L192)* *Defined in [Base.ts:200](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L200)*
*__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata. *__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.
@@ -160,7 +160,7 @@ getrpc(): [DecoratedRpc](_types_.decoratedrpc.md)<[RxResult](../modules/_rx_type
*Inherited from [ApiBase](../classes/_base_.apibase.md).[rpc](../classes/_base_.apibase.md#rpc)* *Inherited from [ApiBase](../classes/_base_.apibase.md).[rpc](../classes/_base_.apibase.md#rpc)*
*Defined in [Base.ts:212](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L212)* *Defined in [Base.ts:220](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L220)*
*__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. *__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.
@@ -185,7 +185,7 @@ getruntimeMetadata(): `Metadata`
*Inherited from [ApiBase](../classes/_base_.apibase.md).[runtimeMetadata](../classes/_base_.apibase.md#runtimemetadata)* *Inherited from [ApiBase](../classes/_base_.apibase.md).[runtimeMetadata](../classes/_base_.apibase.md#runtimemetadata)*
*Defined in [Base.ts:138](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L138)* *Defined in [Base.ts:139](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L139)*
*__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection. *__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.
@@ -200,7 +200,7 @@ getruntimeVersion(): `RuntimeVersion`
*Inherited from [ApiBase](../classes/_base_.apibase.md).[runtimeVersion](../classes/_base_.apibase.md#runtimeversion)* *Inherited from [ApiBase](../classes/_base_.apibase.md).[runtimeVersion](../classes/_base_.apibase.md#runtimeversion)*
*Defined in [Base.ts:147](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L147)* *Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L148)*
*__description__*: Contains the version information for the current runtime. *__description__*: Contains the version information for the current runtime.
@@ -215,7 +215,7 @@ gettx(): [SubmittableExtrinsics](_types_.submittableextrinsics.md)<[RxResult](..
*Inherited from [ApiBase](../classes/_base_.apibase.md).[tx](../classes/_base_.apibase.md#tx)* *Inherited from [ApiBase](../classes/_base_.apibase.md).[tx](../classes/_base_.apibase.md#tx)*
*Defined in [Base.ts:230](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L230)* *Defined in [Base.ts:238](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L238)*
*__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. *__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.
@@ -240,7 +240,7 @@ gettype(): [ApiType](../modules/_types_.md#apitype)
*Inherited from [ApiBase](../classes/_base_.apibase.md).[type](../classes/_base_.apibase.md#type)* *Inherited from [ApiBase](../classes/_base_.apibase.md).[type](../classes/_base_.apibase.md#type)*
*Defined in [Base.ts:156](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L156)* *Defined in [Base.ts:157](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L157)*
*__description__*: The type of this API instance, either 'rxjs' or 'promise' *__description__*: The type of this API instance, either 'rxjs' or 'promise'
@@ -258,7 +258,7 @@ ___
*Inherited from [ApiBase](../classes/_base_.apibase.md).[disconnect](../classes/_base_.apibase.md#disconnect)* *Inherited from [ApiBase](../classes/_base_.apibase.md).[disconnect](../classes/_base_.apibase.md#disconnect)*
*Defined in [Base.ts:239](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L239)* *Defined in [Base.ts:247](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L247)*
*__description__*: Disconnect from the underlying provider, halting all comms *__description__*: Disconnect from the underlying provider, halting all comms
@@ -273,7 +273,7 @@ ___
*Inherited from [ApiBase](../classes/_base_.apibase.md).[on](../classes/_base_.apibase.md#on)* *Inherited from [ApiBase](../classes/_base_.apibase.md).[on](../classes/_base_.apibase.md#on)*
*Defined in [Base.ts:262](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L262)* *Defined in [Base.ts:270](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L270)*
*__description__*: Attach an eventemitter handler to listen to a specific event *__description__*: Attach an eventemitter handler to listen to a specific event
@@ -307,7 +307,7 @@ ___
*Inherited from [ApiBase](../classes/_base_.apibase.md).[once](../classes/_base_.apibase.md#once)* *Inherited from [ApiBase](../classes/_base_.apibase.md).[once](../classes/_base_.apibase.md#once)*
*Defined in [Base.ts:287](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/Base.ts#L287)* *Defined in [Base.ts:295](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L295)*
*__description__*: Attach an one-time eventemitter handler to listen to a specific event *__description__*: Attach an one-time eventemitter handler to listen to a specific event
@@ -333,4 +333,25 @@ api.once('disconnected', () => {
**Returns:** `this` **Returns:** `this`
___ ___
<a id="setsigner"></a>
## setSigner
▸ **setSigner**(signer: *[Signer](_types_.signer.md)*): `void`
*Inherited from [ApiBase](../classes/_base_.apibase.md).[setSigner](../classes/_base_.apibase.md#setsigner)*
*Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/Base.ts#L164)*
*__description__*: Set an external signer which will be used to sign extrinsic when account passed in is not KeyringPair
**Parameters:**
| Name | Type |
| ------ | ------ |
| signer | [Signer](_types_.signer.md) |
**Returns:** `void`
___
docs/api/interfaces/_types_.apibaseinterface.md
+3 -3
View File
@@ -25,7 +25,7 @@
**● on**: *`function`* **● on**: *`function`*
*Defined in [types.ts:134](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/types.ts#L134)* *Defined in [types.ts:140](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/types.ts#L140)*
#### Type declaration #### Type declaration
▸(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this` ▸(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this`
@@ -46,7 +46,7 @@ ___
**● once**: *`function`* **● once**: *`function`*
*Defined in [types.ts:135](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/types.ts#L135)* *Defined in [types.ts:141](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/types.ts#L141)*
#### Type declaration #### Type declaration
▸(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this` ▸(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this`
@@ -67,7 +67,7 @@ ___
**● type**: *[ApiType](../modules/_types_.md#apitype)* **● type**: *[ApiType](../modules/_types_.md#apitype)*
*Defined in [types.ts:132](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/types.ts#L132)* *Defined in [types.ts:138](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/types.ts#L138)*
___ ___
docs/api/interfaces/_types_.apiinterface_decorated.md
+17 -8
View File
@@ -15,7 +15,7 @@
**● derive**: *[Derive](_types_.derive.md)<`CodecResult`, `SubscriptionResult`>* **● derive**: *[Derive](_types_.derive.md)<`CodecResult`, `SubscriptionResult`>*
*Defined in [types.ts:119](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/types.ts#L119)* *Defined in [types.ts:124](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/types.ts#L124)*
___ ___
<a id="genesishash"></a> <a id="genesishash"></a>
@@ -24,7 +24,7 @@ ___
**● genesisHash**: *`Hash`* **● genesisHash**: *`Hash`*
*Defined in [types.ts:115](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/types.ts#L115)* *Defined in [types.ts:120](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/types.ts#L120)*
___ ___
<a id="hassubscriptions"></a> <a id="hassubscriptions"></a>
@@ -33,7 +33,7 @@ ___
**● hasSubscriptions**: *`boolean`* **● hasSubscriptions**: *`boolean`*
*Defined in [types.ts:116](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/types.ts#L116)* *Defined in [types.ts:121](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/types.ts#L121)*
___ ___
<a id="query"></a> <a id="query"></a>
@@ -42,7 +42,7 @@ ___
**● query**: *[QueryableStorage](_types_.queryablestorage.md)<`CodecResult`, `SubscriptionResult`>* **● query**: *[QueryableStorage](_types_.queryablestorage.md)<`CodecResult`, `SubscriptionResult`>*
*Defined in [types.ts:120](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/types.ts#L120)* *Defined in [types.ts:125](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/types.ts#L125)*
___ ___
<a id="rpc"></a> <a id="rpc"></a>
@@ -51,7 +51,7 @@ ___
**● rpc**: *[DecoratedRpc](_types_.decoratedrpc.md)<`CodecResult`, `SubscriptionResult`>* **● rpc**: *[DecoratedRpc](_types_.decoratedrpc.md)<`CodecResult`, `SubscriptionResult`>*
*Defined in [types.ts:121](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/types.ts#L121)* *Defined in [types.ts:126](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/types.ts#L126)*
___ ___
<a id="runtimemetadata"></a> <a id="runtimemetadata"></a>
@@ -60,7 +60,7 @@ ___
**● runtimeMetadata**: *`Metadata`* **● runtimeMetadata**: *`Metadata`*
*Defined in [types.ts:117](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/types.ts#L117)* *Defined in [types.ts:122](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/types.ts#L122)*
___ ___
<a id="runtimeversion"></a> <a id="runtimeversion"></a>
@@ -69,7 +69,16 @@ ___
**● runtimeVersion**: *`RuntimeVersion`* **● runtimeVersion**: *`RuntimeVersion`*
*Defined in [types.ts:118](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/types.ts#L118)* *Defined in [types.ts:123](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/types.ts#L123)*
___
<a id="signer"></a>
## `<Optional>` signer
**● signer**: *[Signer](_types_.signer.md)*
*Defined in [types.ts:128](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/types.ts#L128)*
___ ___
<a id="tx"></a> <a id="tx"></a>
@@ -78,7 +87,7 @@ ___
**● tx**: *[SubmittableExtrinsics](_types_.submittableextrinsics.md)<`CodecResult`, `SubscriptionResult`>* **● tx**: *[SubmittableExtrinsics](_types_.submittableextrinsics.md)<`CodecResult`, `SubscriptionResult`>*
*Defined in [types.ts:122](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/types.ts#L122)* *Defined in [types.ts:127](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/types.ts#L127)*
___ ___
docs/api/interfaces/_types_.apioptions.md
+14 -3
View File
@@ -12,10 +12,21 @@
**● provider**: *`ProviderInterface`* **● provider**: *`ProviderInterface`*
*Defined in [types.ts:102](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/types.ts#L102)* *Defined in [types.ts:103](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/types.ts#L103)*
*__description__*: Transport Provider from rpc-provider. If not specified, it will default to connecting to a WsProvider connecting localhost with the default port, i.e. `ws://127.0.0.1:9944` *__description__*: Transport Provider from rpc-provider. If not specified, it will default to connecting to a WsProvider connecting localhost with the default port, i.e. `ws://127.0.0.1:9944`
___
<a id="signer"></a>
## `<Optional>` signer
**● signer**: *[Signer](_types_.signer.md)*
*Defined in [types.ts:116](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/types.ts#L116)*
*__description__*: An external signer which will be used to sign extrinsic when account passed in is not KeyringPair
___ ___
<a id="source"></a> <a id="source"></a>
@@ -23,7 +34,7 @@ ___
**● source**: *[ApiBase](../classes/_base_.apibase.md)<`any`, `any`>* **● source**: *[ApiBase](../classes/_base_.apibase.md)<`any`, `any`>*
*Defined in [types.ts:106](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/types.ts#L106)* *Defined in [types.ts:107](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/types.ts#L107)*
*__description__*: The source object to use for runtime information (only used when cloning) *__description__*: The source object to use for runtime information (only used when cloning)
@@ -34,7 +45,7 @@ ___
**● types**: *`undefined` | `object`* **● types**: *`undefined` | `object`*
*Defined in [types.ts:111](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/types.ts#L111)* *Defined in [types.ts:112](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/types.ts#L112)*
*__description__*: Additional types used by runtime modules. This is nessusary if the runtime modules uses types not available in the base Substrate runtime. *__description__*: Additional types used by runtime modules. This is nessusary if the runtime modules uses types not available in the base Substrate runtime.
docs/api/interfaces/_types_.decoratedrpc.md
+4 -4
View File
@@ -15,7 +15,7 @@
**● author**: *[DecoratedRpc$Section](_types_.decoratedrpc_section.md)<`CodecResult`, `SubscriptionResult`>* **● author**: *[DecoratedRpc$Section](_types_.decoratedrpc_section.md)<`CodecResult`, `SubscriptionResult`>*
*Defined in [types.ts:33](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/types.ts#L33)* *Defined in [types.ts:34](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/types.ts#L34)*
___ ___
<a id="chain"></a> <a id="chain"></a>
@@ -24,7 +24,7 @@ ___
**● chain**: *[DecoratedRpc$Section](_types_.decoratedrpc_section.md)<`CodecResult`, `SubscriptionResult`>* **● chain**: *[DecoratedRpc$Section](_types_.decoratedrpc_section.md)<`CodecResult`, `SubscriptionResult`>*
*Defined in [types.ts:34](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/types.ts#L34)* *Defined in [types.ts:35](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/types.ts#L35)*
___ ___
<a id="state"></a> <a id="state"></a>
@@ -33,7 +33,7 @@ ___
**● state**: *[DecoratedRpc$Section](_types_.decoratedrpc_section.md)<`CodecResult`, `SubscriptionResult`>* **● state**: *[DecoratedRpc$Section](_types_.decoratedrpc_section.md)<`CodecResult`, `SubscriptionResult`>*
*Defined in [types.ts:35](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/types.ts#L35)* *Defined in [types.ts:36](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/types.ts#L36)*
___ ___
<a id="system"></a> <a id="system"></a>
@@ -42,7 +42,7 @@ ___
**● system**: *[DecoratedRpc$Section](_types_.decoratedrpc_section.md)<`CodecResult`, `SubscriptionResult`>* **● system**: *[DecoratedRpc$Section](_types_.decoratedrpc_section.md)<`CodecResult`, `SubscriptionResult`>*
*Defined in [types.ts:36](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/types.ts#L36)* *Defined in [types.ts:37](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/types.ts#L37)*
___ ___
docs/api/interfaces/_types_.decoratedrpc_method.md
+3 -3
View File
@@ -14,7 +14,7 @@
▸ **__call**(arg1?: *`CodecArg`*, arg2?: *`CodecArg`*, arg3?: *`CodecArg`*): `CodecResult` ▸ **__call**(arg1?: *`CodecArg`*, arg2?: *`CodecArg`*, arg3?: *`CodecArg`*): `CodecResult`
*Defined in [types.ts:22](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/types.ts#L22)* *Defined in [types.ts:23](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/types.ts#L23)*
**Parameters:** **Parameters:**
@@ -24,7 +24,7 @@
**Returns:** `SubscriptionResult` **Returns:** `SubscriptionResult`
*Defined in [types.ts:23](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/types.ts#L23)* *Defined in [types.ts:24](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/types.ts#L24)*
**Parameters:** **Parameters:**
@@ -35,7 +35,7 @@
**Returns:** `SubscriptionResult` **Returns:** `SubscriptionResult`
*Defined in [types.ts:24](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/types.ts#L24)* *Defined in [types.ts:25](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/types.ts#L25)*
**Parameters:** **Parameters:**
docs/api/interfaces/_types_.queryablestoragefunctionbase.md
+10 -10
View File
@@ -14,7 +14,7 @@
▸ **__call**(arg?: *`any`*): `Uint8Array` ▸ **__call**(arg?: *`any`*): `Uint8Array`
*Defined in [types.ts:49](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/types.ts#L49)* *Defined in [types.ts:50](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/types.ts#L50)*
**Parameters:** **Parameters:**
@@ -24,7 +24,7 @@
**Returns:** `CodecResult` **Returns:** `CodecResult`
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:12](https://github.com/polkadot-js/api/blob/b2f0618/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/c1672e8/packages/types/src/StorageKey.ts#L12)*
**Parameters:** **Parameters:**
@@ -42,7 +42,7 @@
**● at**: *`function`* **● at**: *`function`*
*Defined in [types.ts:51](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/types.ts#L51)* *Defined in [types.ts:52](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/types.ts#L52)*
#### Type declaration #### Type declaration
▸(hash: *`Hash` | `Uint8Array` | `string`*, arg?: *`CodecArg`*): `CodecResult` ▸(hash: *`Hash` | `Uint8Array` | `string`*, arg?: *`CodecArg`*): `CodecResult`
@@ -63,7 +63,7 @@ ___
**● hash**: *`function`* **● hash**: *`function`*
*Defined in [types.ts:52](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/types.ts#L52)* *Defined in [types.ts:53](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/types.ts#L53)*
#### Type declaration #### Type declaration
▸(arg?: *`CodecArg`*): [HashResult](../modules/_types_.md#hashresult)<`CodecResult`, `SubscriptionResult`> ▸(arg?: *`CodecArg`*): [HashResult](../modules/_types_.md#hashresult)<`CodecResult`, `SubscriptionResult`>
@@ -83,7 +83,7 @@ ___
**● key**: *`function`* **● key**: *`function`*
*Defined in [types.ts:53](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/types.ts#L53)* *Defined in [types.ts:54](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/types.ts#L54)*
#### Type declaration #### Type declaration
▸(arg?: *`CodecArg`*): `string` ▸(arg?: *`CodecArg`*): `string`
@@ -105,7 +105,7 @@ ___
*Inherited from StorageFunction.meta* *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/b2f0618/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/c1672e8/packages/types/src/StorageKey.ts#L14)*
___ ___
<a id="method"></a> <a id="method"></a>
@@ -116,7 +116,7 @@ ___
*Inherited from StorageFunction.method* *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/b2f0618/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/c1672e8/packages/types/src/StorageKey.ts#L15)*
___ ___
<a id="section"></a> <a id="section"></a>
@@ -127,7 +127,7 @@ ___
*Inherited from StorageFunction.section* *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/b2f0618/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/c1672e8/packages/types/src/StorageKey.ts#L16)*
___ ___
<a id="size"></a> <a id="size"></a>
@@ -136,7 +136,7 @@ ___
**● size**: *`function`* **● size**: *`function`*
*Defined in [types.ts:54](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/types.ts#L54)* *Defined in [types.ts:55](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/types.ts#L55)*
#### Type declaration #### Type declaration
▸(arg?: *`CodecArg`*): [U64Result](../modules/_types_.md#u64result)<`CodecResult`, `SubscriptionResult`> ▸(arg?: *`CodecArg`*): [U64Result](../modules/_types_.md#u64result)<`CodecResult`, `SubscriptionResult`>
@@ -158,7 +158,7 @@ ___
*Inherited from StorageFunction.toJSON* *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/b2f0618/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/c1672e8/packages/types/src/StorageKey.ts#L17)*
#### Type declaration #### Type declaration
▸(): `any` ▸(): `any`
docs/api/interfaces/_types_.signer.md
+28
View File
@@ -0,0 +1,28 @@
# Hierarchy
**Signer**
# Methods
<a id="sign"></a>
## sign
▸ **sign**(extrinsic: *`Extrinsic`*, address: *`string`*, opt: *`SignatureOptions`*): `Promise`<`void`>
*Defined in [types.ts:145](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/types.ts#L145)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| extrinsic | `Extrinsic` |
| address | `string` |
| opt | `SignatureOptions` |
**Returns:** `Promise`<`void`>
___
docs/api/interfaces/_types_.submittableextrinsicfunction.md
+7 -7
View File
@@ -14,7 +14,7 @@
▸ **__call**(...args: *`any`[]*): `Method` ▸ **__call**(...args: *`any`[]*): `Method`
*Defined in [types.ts:75](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/types.ts#L75)* *Defined in [types.ts:76](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/types.ts#L76)*
**Parameters:** **Parameters:**
@@ -24,7 +24,7 @@
**Returns:** [SubmittableExtrinsic](../classes/_submittableextrinsic_.submittableextrinsic.md)<`CodecResult`, `SubscriptionResult`> **Returns:** [SubmittableExtrinsic](../classes/_submittableextrinsic_.submittableextrinsic.md)<`CodecResult`, `SubscriptionResult`>
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:28](https://github.com/polkadot-js/api/blob/b2f0618/packages/types/src/Method.ts#L28)* *Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:28](https://github.com/polkadot-js/api/blob/c1672e8/packages/types/src/Method.ts#L28)*
**Parameters:** **Parameters:**
@@ -44,7 +44,7 @@
*Inherited from MethodFunction.callIndex* *Inherited from MethodFunction.callIndex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:30](https://github.com/polkadot-js/api/blob/b2f0618/packages/types/src/Method.ts#L30)* *Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:30](https://github.com/polkadot-js/api/blob/c1672e8/packages/types/src/Method.ts#L30)*
___ ___
<a id="meta"></a> <a id="meta"></a>
@@ -55,7 +55,7 @@ ___
*Inherited from MethodFunction.meta* *Inherited from MethodFunction.meta*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:31](https://github.com/polkadot-js/api/blob/b2f0618/packages/types/src/Method.ts#L31)* *Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:31](https://github.com/polkadot-js/api/blob/c1672e8/packages/types/src/Method.ts#L31)*
___ ___
<a id="method"></a> <a id="method"></a>
@@ -66,7 +66,7 @@ ___
*Inherited from MethodFunction.method* *Inherited from MethodFunction.method*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:32](https://github.com/polkadot-js/api/blob/b2f0618/packages/types/src/Method.ts#L32)* *Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:32](https://github.com/polkadot-js/api/blob/c1672e8/packages/types/src/Method.ts#L32)*
___ ___
<a id="section"></a> <a id="section"></a>
@@ -77,7 +77,7 @@ ___
*Inherited from MethodFunction.section* *Inherited from MethodFunction.section*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:33](https://github.com/polkadot-js/api/blob/b2f0618/packages/types/src/Method.ts#L33)* *Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:33](https://github.com/polkadot-js/api/blob/c1672e8/packages/types/src/Method.ts#L33)*
___ ___
<a id="tojson"></a> <a id="tojson"></a>
@@ -88,7 +88,7 @@ ___
*Inherited from MethodFunction.toJSON* *Inherited from MethodFunction.toJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:34](https://github.com/polkadot-js/api/blob/b2f0618/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/c1672e8/packages/types/src/Method.ts#L34)*
#### Type declaration #### Type declaration
▸(): `any` ▸(): `any`
docs/api/modules/_promise_combinator_.md
+2 -2
View File
@@ -21,7 +21,7 @@
**Ƭ CombinatorCallback**: *`function`* **Ƭ CombinatorCallback**: *`function`*
*Defined in [promise/Combinator.ts:9](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/promise/Combinator.ts#L9)* *Defined in [promise/Combinator.ts:9](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/promise/Combinator.ts#L9)*
#### Type declaration #### Type declaration
▸(value: *`Array`<`any`>*): `any` ▸(value: *`Array`<`any`>*): `any`
@@ -41,7 +41,7 @@ ___
**Ƭ CombinatorFunction**: *`function`* **Ƭ CombinatorFunction**: *`function`*
*Defined in [promise/Combinator.ts:10](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/promise/Combinator.ts#L10)* *Defined in [promise/Combinator.ts:10](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/promise/Combinator.ts#L10)*
#### Type declaration #### Type declaration
▸(cb: *`function`*): [SubscriptionResult]() ▸(cb: *`function`*): [SubscriptionResult]()
docs/api/modules/_promise_types_.md
+5 -5
View File
@@ -24,7 +24,7 @@
**Ƭ CodecResult**: *`Promise`<`Codec`>* **Ƭ CodecResult**: *`Promise`<`Codec`>*
*Defined in [promise/types.ts:13](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/promise/types.ts#L13)* *Defined in [promise/types.ts:13](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/promise/types.ts#L13)*
___ ___
<a id="queryablestoragefunction"></a> <a id="queryablestoragefunction"></a>
@@ -33,7 +33,7 @@ ___
**Ƭ QueryableStorageFunction**: *[QueryableStorageFunctionBase](../interfaces/_types_.queryablestoragefunctionbase.md)<[CodecResult](_promise_types_.md#codecresult), [SubscriptionResult](_promise_types_.md#subscriptionresult)>* **Ƭ QueryableStorageFunction**: *[QueryableStorageFunctionBase](../interfaces/_types_.queryablestoragefunctionbase.md)<[CodecResult](_promise_types_.md#codecresult), [SubscriptionResult](_promise_types_.md#subscriptionresult)>*
*Defined in [promise/types.ts:19](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/promise/types.ts#L19)* *Defined in [promise/types.ts:19](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/promise/types.ts#L19)*
___ ___
<a id="submittableextrinsic"></a> <a id="submittableextrinsic"></a>
@@ -42,7 +42,7 @@ ___
**Ƭ SubmittableExtrinsic**: *`SubmittableExtrinsicBase`<[CodecResult](_promise_types_.md#codecresult), [SubscriptionResult](_promise_types_.md#subscriptionresult)>* **Ƭ SubmittableExtrinsic**: *`SubmittableExtrinsicBase`<[CodecResult](_promise_types_.md#codecresult), [SubscriptionResult](_promise_types_.md#subscriptionresult)>*
*Defined in [promise/types.ts:20](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/promise/types.ts#L20)* *Defined in [promise/types.ts:20](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/promise/types.ts#L20)*
___ ___
<a id="submittableextrinsicfunction"></a> <a id="submittableextrinsicfunction"></a>
@@ -51,7 +51,7 @@ ___
**Ƭ SubmittableExtrinsicFunction**: *`SubmittableExtrinsicFunctionBase`<[CodecResult](_promise_types_.md#codecresult), [SubscriptionResult](_promise_types_.md#subscriptionresult)>* **Ƭ SubmittableExtrinsicFunction**: *`SubmittableExtrinsicFunctionBase`<[CodecResult](_promise_types_.md#codecresult), [SubscriptionResult](_promise_types_.md#subscriptionresult)>*
*Defined in [promise/types.ts:21](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/promise/types.ts#L21)* *Defined in [promise/types.ts:21](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/promise/types.ts#L21)*
___ ___
<a id="subscriptionresult"></a> <a id="subscriptionresult"></a>
@@ -60,7 +60,7 @@ ___
**Ƭ SubscriptionResult**: *`Promise`<`function`>* **Ƭ SubscriptionResult**: *`Promise`<`function`>*
*Defined in [promise/types.ts:11](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/promise/types.ts#L11)* *Defined in [promise/types.ts:11](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/promise/types.ts#L11)*
___ ___
docs/api/modules/_rx_types_.md
+1 -1
View File
@@ -20,7 +20,7 @@
**Ƭ RxResult**: *`Observable`<`Codec`>* **Ƭ RxResult**: *`Observable`<`Codec`>*
*Defined in [rx/types.ts:10](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/rx/types.ts#L10)* *Defined in [rx/types.ts:10](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/rx/types.ts#L10)*
___ ___
docs/api/modules/_types_.md
+10 -9
View File
@@ -15,6 +15,7 @@
* [QueryableModuleStorage](../interfaces/_types_.queryablemodulestorage.md) * [QueryableModuleStorage](../interfaces/_types_.queryablemodulestorage.md)
* [QueryableStorage](../interfaces/_types_.queryablestorage.md) * [QueryableStorage](../interfaces/_types_.queryablestorage.md)
* [QueryableStorageFunctionBase](../interfaces/_types_.queryablestoragefunctionbase.md) * [QueryableStorageFunctionBase](../interfaces/_types_.queryablestoragefunctionbase.md)
* [Signer](../interfaces/_types_.signer.md)
* [SubmittableExtrinsicFunction](../interfaces/_types_.submittableextrinsicfunction.md) * [SubmittableExtrinsicFunction](../interfaces/_types_.submittableextrinsicfunction.md)
* [SubmittableExtrinsics](../interfaces/_types_.submittableextrinsics.md) * [SubmittableExtrinsics](../interfaces/_types_.submittableextrinsics.md)
* [SubmittableModuleExtrinsics](../interfaces/_types_.submittablemoduleextrinsics.md) * [SubmittableModuleExtrinsics](../interfaces/_types_.submittablemoduleextrinsics.md)
@@ -41,7 +42,7 @@
**Ƭ ApiInterface$Events**: *`RpcRxInterface$Events` | "ready"* **Ƭ ApiInterface$Events**: *`RpcRxInterface$Events` | "ready"*
*Defined in [types.ts:127](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/types.ts#L127)* *Defined in [types.ts:133](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/types.ts#L133)*
___ ___
<a id="apiinterface_rx"></a> <a id="apiinterface_rx"></a>
@@ -50,7 +51,7 @@ ___
**Ƭ ApiInterface$Rx**: *[ApiInterface$Decorated](../interfaces/_types_.apiinterface_decorated.md)<[RxResult](_rx_types_.md#rxresult), [RxResult](_rx_types_.md#rxresult)>* **Ƭ ApiInterface$Rx**: *[ApiInterface$Decorated](../interfaces/_types_.apiinterface_decorated.md)<[RxResult](_rx_types_.md#rxresult), [RxResult](_rx_types_.md#rxresult)>*
*Defined in [types.ts:125](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/types.ts#L125)* *Defined in [types.ts:131](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/types.ts#L131)*
___ ___
<a id="apitype"></a> <a id="apitype"></a>
@@ -59,7 +60,7 @@ ___
**Ƭ ApiType**: *"promise" | "rxjs"* **Ƭ ApiType**: *"promise" | "rxjs"*
*Defined in [types.ts:129](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/types.ts#L129)* *Defined in [types.ts:135](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/types.ts#L135)*
___ ___
<a id="derivemethod"></a> <a id="derivemethod"></a>
@@ -68,7 +69,7 @@ ___
**Ƭ DeriveMethod**: *`function`* **Ƭ DeriveMethod**: *`function`*
*Defined in [types.ts:87](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/types.ts#L87)* *Defined in [types.ts:88](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/types.ts#L88)*
#### Type declaration #### Type declaration
▸(...params: *`Array`<`CodecArg`>*): `CodecResult` | `SubscriptionResult` ▸(...params: *`Array`<`CodecArg`>*): `CodecResult` | `SubscriptionResult`
@@ -88,7 +89,7 @@ ___
**Ƭ HashResult**: *`HashResult&lt;CodecResult, SubscriptionResult&gt;`* **Ƭ HashResult**: *`HashResult&lt;CodecResult, SubscriptionResult&gt;`*
*Defined in [types.ts:39](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/types.ts#L39)* *Defined in [types.ts:40](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/types.ts#L40)*
___ ___
<a id="oncalldefinition"></a> <a id="oncalldefinition"></a>
@@ -97,7 +98,7 @@ ___
**Ƭ OnCallDefinition**: *`function`* **Ƭ OnCallDefinition**: *`function`*
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/types.ts#L17)* *Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/types.ts#L18)*
#### Type declaration #### Type declaration
▸(method: *[OnCallFunction](_types_.md#oncallfunction)<[RxResult](_rx_types_.md#rxresult), [RxResult](_rx_types_.md#rxresult)>*, params?: *`Array`<`CodecArg`>*, callback?: *`CodecCallback`*, needsCallback?: *`undefined` | `false` | `true`*): `CodecResult` | `SubscriptionResult` ▸(method: *[OnCallFunction](_types_.md#oncallfunction)<[RxResult](_rx_types_.md#rxresult), [RxResult](_rx_types_.md#rxresult)>*, params?: *`Array`<`CodecArg`>*, callback?: *`CodecCallback`*, needsCallback?: *`undefined` | `false` | `true`*): `CodecResult` | `SubscriptionResult`
@@ -120,7 +121,7 @@ ___
**Ƭ OnCallFunction**: *`function`* **Ƭ OnCallFunction**: *`function`*
*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/types.ts#L19)* *Defined in [types.ts:20](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/types.ts#L20)*
#### Type declaration #### Type declaration
▸(...params: *`Array`<`CodecArg`>*): `CodecResult` | `SubscriptionResult` ▸(...params: *`Array`<`CodecArg`>*): `CodecResult` | `SubscriptionResult`
@@ -140,7 +141,7 @@ ___
**Ƭ QueryableStorageFunction**: *`QueryableStorageFunction&lt;CodecResult, SubscriptionResult&gt;`* **Ƭ QueryableStorageFunction**: *`QueryableStorageFunction&lt;CodecResult, SubscriptionResult&gt;`*
*Defined in [types.ts:62](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/types.ts#L62)* *Defined in [types.ts:63](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/types.ts#L63)*
___ ___
<a id="u64result"></a> <a id="u64result"></a>
@@ -149,7 +150,7 @@ ___
**Ƭ U64Result**: *`U64Result&lt;CodecResult, SubscriptionResult&gt;`* **Ƭ U64Result**: *`U64Result&lt;CodecResult, SubscriptionResult&gt;`*
*Defined in [types.ts:44](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/types.ts#L44)* *Defined in [types.ts:45](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/types.ts#L45)*
___ ___
docs/api/modules/_util_filterevents_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **filterEvents**(extHash: *`Hash`*, __namedParameters: *`object`*, allEvents: *`Array`<`EventRecord`>*): `Array`<`EventRecord`> | `undefined` ▸ **filterEvents**(extHash: *`Hash`*, __namedParameters: *`object`*, allEvents: *`Array`<`EventRecord`>*): `Array`<`EventRecord`> | `undefined`
*Defined in [util/filterEvents.ts:9](https://github.com/polkadot-js/api/blob/b2f0618/packages/api/src/util/filterEvents.ts#L9)* *Defined in [util/filterEvents.ts:9](https://github.com/polkadot-js/api/blob/c1672e8/packages/api/src/util/filterEvents.ts#L9)*
**Parameters:** **Parameters:**
docs/examples/promise/01_simple_connect/index.html
+1 -1
View File
@@ -2203,7 +2203,7 @@
<script> <script>
var gitbook = gitbook || []; var gitbook = gitbook || [];
gitbook.push(function() { 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":"Unsubscribe from listening","level":"3.1.4","depth":2,"path":"examples/promise/04_unsubscribe/README.md","ref":"examples/promise/04_unsubscribe/README.md","articles":[]},{"title":"Read chain state","level":"3.1.5","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.6","depth":2,"path":"examples/promise/06_make_transfer/README.md","ref":"examples/promise/06_make_transfer/README.md","articles":[]},{"title":"Display system events","level":"3.1.7","depth":2,"path":"examples/promise/08_system_events/README.md","ref":"examples/promise/08_system_events/README.md","articles":[]},{"title":"Transaction with events","level":"3.1.8","depth":2,"path":"examples/promise/09_transfer_events/README.md","ref":"examples/promise/09_transfer_events/README.md","articles":[]},{"title":"Upgrade via sudo","level":"3.1.9","depth":2,"path":"examples/promise/10_upgrade_chain/README.md","ref":"examples/promise/10_upgrade_chain/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":"2019-02-08T14:45:12.588Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-08T14:49:34.586Z"},"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":"Unsubscribe from listening","level":"3.1.4","depth":2,"path":"examples/promise/04_unsubscribe/README.md","ref":"examples/promise/04_unsubscribe/README.md","articles":[]},{"title":"Read chain state","level":"3.1.5","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.6","depth":2,"path":"examples/promise/06_make_transfer/README.md","ref":"examples/promise/06_make_transfer/README.md","articles":[]},{"title":"Display system events","level":"3.1.7","depth":2,"path":"examples/promise/08_system_events/README.md","ref":"examples/promise/08_system_events/README.md","articles":[]},{"title":"Transaction with events","level":"3.1.8","depth":2,"path":"examples/promise/09_transfer_events/README.md","ref":"examples/promise/09_transfer_events/README.md","articles":[]},{"title":"Upgrade via sudo","level":"3.1.9","depth":2,"path":"examples/promise/10_upgrade_chain/README.md","ref":"examples/promise/10_upgrade_chain/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":"2019-02-09T05:16:44.135Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-09T05:21:07.515Z"},"basePath":"../../..","book":{"language":""}});
}); });
</script> </script>
</div> </div>
docs/examples/promise/02_listen_to_blocks/index.html
+1 -1
View File
@@ -2201,7 +2201,7 @@
<script> <script>
var gitbook = gitbook || []; var gitbook = gitbook || [];
gitbook.push(function() { 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":"2019-02-08T14:45:12.588Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-08T14:49:34.586Z"},"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":"2019-02-09T05:16:44.139Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-09T05:21:07.515Z"},"basePath":"../../..","book":{"language":""}});
}); });
</script> </script>
</div> </div>
docs/examples/promise/03_listen_to_balance_change/index.html
+1 -1
View File
@@ -2213,7 +2213,7 @@
<script> <script>
var gitbook = gitbook || []; var gitbook = gitbook || [];
gitbook.push(function() { gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Listen to balance change","level":"3.1.3","depth":2,"next":{"title":"Unsubscribe from listening","level":"3.1.4","depth":2,"path":"examples/promise/04_unsubscribe/README.md","ref":"examples/promise/04_unsubscribe/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":"2019-02-08T14:45:12.588Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-08T14:49:34.586Z"},"basePath":"../../..","book":{"language":""}}); gitbook.page.hasChanged({"page":{"title":"Listen to balance change","level":"3.1.3","depth":2,"next":{"title":"Unsubscribe from listening","level":"3.1.4","depth":2,"path":"examples/promise/04_unsubscribe/README.md","ref":"examples/promise/04_unsubscribe/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":"2019-02-09T05:16:44.139Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-09T05:21:07.515Z"},"basePath":"../../..","book":{"language":""}});
}); });
</script> </script>
</div> </div>
docs/examples/promise/04_unsubscribe/index.html
+1 -1
View File
@@ -2204,7 +2204,7 @@
<script> <script>
var gitbook = gitbook || []; var gitbook = gitbook || [];
gitbook.push(function() { gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Unsubscribe from listening","level":"3.1.4","depth":2,"next":{"title":"Read chain state","level":"3.1.5","depth":2,"path":"examples/promise/05_read_storage/README.md","ref":"examples/promise/05_read_storage/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/04_unsubscribe/README.md","mtime":"2019-02-08T14:45:12.588Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-08T14:49:34.586Z"},"basePath":"../../..","book":{"language":""}}); gitbook.page.hasChanged({"page":{"title":"Unsubscribe from listening","level":"3.1.4","depth":2,"next":{"title":"Read chain state","level":"3.1.5","depth":2,"path":"examples/promise/05_read_storage/README.md","ref":"examples/promise/05_read_storage/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/04_unsubscribe/README.md","mtime":"2019-02-09T05:16:44.139Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-09T05:21:07.515Z"},"basePath":"../../..","book":{"language":""}});
}); });
</script> </script>
</div> </div>
docs/examples/promise/05_read_storage/index.html
+1 -1
View File
@@ -2218,7 +2218,7 @@
<script> <script>
var gitbook = gitbook || []; var gitbook = gitbook || [];
gitbook.push(function() { gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Read chain state","level":"3.1.5","depth":2,"next":{"title":"Make a transfer","level":"3.1.6","depth":2,"path":"examples/promise/06_make_transfer/README.md","ref":"examples/promise/06_make_transfer/README.md","articles":[]},"previous":{"title":"Unsubscribe from listening","level":"3.1.4","depth":2,"path":"examples/promise/04_unsubscribe/README.md","ref":"examples/promise/04_unsubscribe/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":"2019-02-08T14:45:12.588Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-08T14:49:34.586Z"},"basePath":"../../..","book":{"language":""}}); gitbook.page.hasChanged({"page":{"title":"Read chain state","level":"3.1.5","depth":2,"next":{"title":"Make a transfer","level":"3.1.6","depth":2,"path":"examples/promise/06_make_transfer/README.md","ref":"examples/promise/06_make_transfer/README.md","articles":[]},"previous":{"title":"Unsubscribe from listening","level":"3.1.4","depth":2,"path":"examples/promise/04_unsubscribe/README.md","ref":"examples/promise/04_unsubscribe/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":"2019-02-09T05:16:44.139Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-09T05:21:07.515Z"},"basePath":"../../..","book":{"language":""}});
}); });
</script> </script>
</div> </div>
docs/examples/promise/06_make_transfer/index.html
+1 -1
View File
@@ -2216,7 +2216,7 @@
<script> <script>
var gitbook = gitbook || []; var gitbook = gitbook || [];
gitbook.push(function() { gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Make a transfer","level":"3.1.6","depth":2,"next":{"title":"Display system events","level":"3.1.7","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.5","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/06_make_transfer/README.md","mtime":"2019-02-08T14:45:12.588Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-08T14:49:34.586Z"},"basePath":"../../..","book":{"language":""}}); gitbook.page.hasChanged({"page":{"title":"Make a transfer","level":"3.1.6","depth":2,"next":{"title":"Display system events","level":"3.1.7","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.5","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/06_make_transfer/README.md","mtime":"2019-02-09T05:16:44.139Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-09T05:21:07.515Z"},"basePath":"../../..","book":{"language":""}});
}); });
</script> </script>
</div> </div>
docs/examples/promise/08_system_events/index.html
+1 -1
View File
@@ -2214,7 +2214,7 @@
<script> <script>
var gitbook = gitbook || []; var gitbook = gitbook || [];
gitbook.push(function() { gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Display system events","level":"3.1.7","depth":2,"next":{"title":"Transaction with events","level":"3.1.8","depth":2,"path":"examples/promise/09_transfer_events/README.md","ref":"examples/promise/09_transfer_events/README.md","articles":[]},"previous":{"title":"Make a transfer","level":"3.1.6","depth":2,"path":"examples/promise/06_make_transfer/README.md","ref":"examples/promise/06_make_transfer/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":"2019-02-08T14:45:12.588Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-08T14:49:34.586Z"},"basePath":"../../..","book":{"language":""}}); gitbook.page.hasChanged({"page":{"title":"Display system events","level":"3.1.7","depth":2,"next":{"title":"Transaction with events","level":"3.1.8","depth":2,"path":"examples/promise/09_transfer_events/README.md","ref":"examples/promise/09_transfer_events/README.md","articles":[]},"previous":{"title":"Make a transfer","level":"3.1.6","depth":2,"path":"examples/promise/06_make_transfer/README.md","ref":"examples/promise/06_make_transfer/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":"2019-02-09T05:16:44.139Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-09T05:21:07.515Z"},"basePath":"../../..","book":{"language":""}});
}); });
</script> </script>
</div> </div>
docs/examples/promise/09_transfer_events/index.html
+1 -1
View File
@@ -2235,7 +2235,7 @@
<script> <script>
var gitbook = gitbook || []; var gitbook = gitbook || [];
gitbook.push(function() { gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Transaction with events","level":"3.1.8","depth":2,"next":{"title":"Upgrade via sudo","level":"3.1.9","depth":2,"path":"examples/promise/10_upgrade_chain/README.md","ref":"examples/promise/10_upgrade_chain/README.md","articles":[]},"previous":{"title":"Display system events","level":"3.1.7","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/09_transfer_events/README.md","mtime":"2019-02-08T14:45:12.588Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-08T14:49:34.586Z"},"basePath":"../../..","book":{"language":""}}); gitbook.page.hasChanged({"page":{"title":"Transaction with events","level":"3.1.8","depth":2,"next":{"title":"Upgrade via sudo","level":"3.1.9","depth":2,"path":"examples/promise/10_upgrade_chain/README.md","ref":"examples/promise/10_upgrade_chain/README.md","articles":[]},"previous":{"title":"Display system events","level":"3.1.7","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/09_transfer_events/README.md","mtime":"2019-02-09T05:16:44.139Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-09T05:21:07.515Z"},"basePath":"../../..","book":{"language":""}});
}); });
</script> </script>
</div> </div>
docs/examples/promise/10_upgrade_chain/index.html
+1 -1
View File
@@ -2237,7 +2237,7 @@
<script> <script>
var gitbook = gitbook || []; var gitbook = gitbook || [];
gitbook.push(function() { gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Upgrade via sudo","level":"3.1.9","depth":2,"next":{"title":"ApiRx","level":"3.2","depth":1,"path":"examples/rx/README.md","ref":"examples/rx/README.md","articles":[{"title":"Simple connect","level":"3.2.1","depth":2,"path":"examples/rx/01_simple_connect/README.md","ref":"examples/rx/01_simple_connect/README.md","articles":[]},{"title":"Listen to blocks","level":"3.2.2","depth":2,"path":"examples/rx/02_listen_to_blocks/README.md","ref":"examples/rx/02_listen_to_blocks/README.md","articles":[]},{"title":"Listen to balance change","level":"3.2.3","depth":2,"path":"examples/rx/03_listen_to_balance_change/README.md","ref":"examples/rx/03_listen_to_balance_change/README.md","articles":[]},{"title":"Unsubscribe from listening","level":"3.2.4","depth":2,"path":"examples/rx/04_unsubscribe/README.md","ref":"examples/rx/04_unsubscribe/README.md","articles":[]},{"title":"Read chain state","level":"3.2.5","depth":2,"path":"examples/rx/05_read_storage/README.md","ref":"examples/rx/05_read_storage/README.md","articles":[]},{"title":"Make a transfer","level":"3.2.6","depth":2,"path":"examples/rx/06_make_transfer/README.md","ref":"examples/rx/06_make_transfer/README.md","articles":[]},{"title":"Display system events","level":"3.2.7","depth":2,"path":"examples/rx/08_system_events/README.md","ref":"examples/rx/08_system_events/README.md","articles":[]},{"title":"Transaction with events","level":"3.2.8","depth":2,"path":"examples/rx/09_transfer_events/README.md","ref":"examples/rx/09_transfer_events/README.md","articles":[]},{"title":"Upgrade via sudo","level":"3.2.9","depth":2,"path":"examples/rx/10_upgrade_chain/README.md","ref":"examples/rx/10_upgrade_chain/README.md","articles":[]}]},"previous":{"title":"Transaction with events","level":"3.1.8","depth":2,"path":"examples/promise/09_transfer_events/README.md","ref":"examples/promise/09_transfer_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/10_upgrade_chain/README.md","mtime":"2019-02-08T14:45:12.592Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-08T14:49:34.586Z"},"basePath":"../../..","book":{"language":""}}); gitbook.page.hasChanged({"page":{"title":"Upgrade via sudo","level":"3.1.9","depth":2,"next":{"title":"ApiRx","level":"3.2","depth":1,"path":"examples/rx/README.md","ref":"examples/rx/README.md","articles":[{"title":"Simple connect","level":"3.2.1","depth":2,"path":"examples/rx/01_simple_connect/README.md","ref":"examples/rx/01_simple_connect/README.md","articles":[]},{"title":"Listen to blocks","level":"3.2.2","depth":2,"path":"examples/rx/02_listen_to_blocks/README.md","ref":"examples/rx/02_listen_to_blocks/README.md","articles":[]},{"title":"Listen to balance change","level":"3.2.3","depth":2,"path":"examples/rx/03_listen_to_balance_change/README.md","ref":"examples/rx/03_listen_to_balance_change/README.md","articles":[]},{"title":"Unsubscribe from listening","level":"3.2.4","depth":2,"path":"examples/rx/04_unsubscribe/README.md","ref":"examples/rx/04_unsubscribe/README.md","articles":[]},{"title":"Read chain state","level":"3.2.5","depth":2,"path":"examples/rx/05_read_storage/README.md","ref":"examples/rx/05_read_storage/README.md","articles":[]},{"title":"Make a transfer","level":"3.2.6","depth":2,"path":"examples/rx/06_make_transfer/README.md","ref":"examples/rx/06_make_transfer/README.md","articles":[]},{"title":"Display system events","level":"3.2.7","depth":2,"path":"examples/rx/08_system_events/README.md","ref":"examples/rx/08_system_events/README.md","articles":[]},{"title":"Transaction with events","level":"3.2.8","depth":2,"path":"examples/rx/09_transfer_events/README.md","ref":"examples/rx/09_transfer_events/README.md","articles":[]},{"title":"Upgrade via sudo","level":"3.2.9","depth":2,"path":"examples/rx/10_upgrade_chain/README.md","ref":"examples/rx/10_upgrade_chain/README.md","articles":[]}]},"previous":{"title":"Transaction with events","level":"3.1.8","depth":2,"path":"examples/promise/09_transfer_events/README.md","ref":"examples/promise/09_transfer_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/10_upgrade_chain/README.md","mtime":"2019-02-09T05:16:44.139Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-09T05:21:07.515Z"},"basePath":"../../..","book":{"language":""}});
}); });
</script> </script>
</div> </div>
docs/examples/promise/index.html
+1 -1
View File
@@ -2193,7 +2193,7 @@
<script> <script>
var gitbook = gitbook || []; var gitbook = gitbook || [];
gitbook.push(function() { 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":"2019-02-08T14:45:12.596Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-08T14:49:34.586Z"},"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":"2019-02-09T05:16:44.147Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-09T05:21:07.515Z"},"basePath":"../..","book":{"language":""}});
}); });
</script> </script>
</div> </div>
docs/examples/rx/01_simple_connect/index.html
+1 -1
View File
@@ -2207,7 +2207,7 @@
<script> <script>
var gitbook = gitbook || []; var gitbook = gitbook || [];
gitbook.push(function() { gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Simple connect","level":"3.2.1","depth":2,"next":{"title":"Listen to blocks","level":"3.2.2","depth":2,"path":"examples/rx/02_listen_to_blocks/README.md","ref":"examples/rx/02_listen_to_blocks/README.md","articles":[]},"previous":{"title":"ApiRx","level":"3.2","depth":1,"path":"examples/rx/README.md","ref":"examples/rx/README.md","articles":[{"title":"Simple connect","level":"3.2.1","depth":2,"path":"examples/rx/01_simple_connect/README.md","ref":"examples/rx/01_simple_connect/README.md","articles":[]},{"title":"Listen to blocks","level":"3.2.2","depth":2,"path":"examples/rx/02_listen_to_blocks/README.md","ref":"examples/rx/02_listen_to_blocks/README.md","articles":[]},{"title":"Listen to balance change","level":"3.2.3","depth":2,"path":"examples/rx/03_listen_to_balance_change/README.md","ref":"examples/rx/03_listen_to_balance_change/README.md","articles":[]},{"title":"Unsubscribe from listening","level":"3.2.4","depth":2,"path":"examples/rx/04_unsubscribe/README.md","ref":"examples/rx/04_unsubscribe/README.md","articles":[]},{"title":"Read chain state","level":"3.2.5","depth":2,"path":"examples/rx/05_read_storage/README.md","ref":"examples/rx/05_read_storage/README.md","articles":[]},{"title":"Make a transfer","level":"3.2.6","depth":2,"path":"examples/rx/06_make_transfer/README.md","ref":"examples/rx/06_make_transfer/README.md","articles":[]},{"title":"Display system events","level":"3.2.7","depth":2,"path":"examples/rx/08_system_events/README.md","ref":"examples/rx/08_system_events/README.md","articles":[]},{"title":"Transaction with events","level":"3.2.8","depth":2,"path":"examples/rx/09_transfer_events/README.md","ref":"examples/rx/09_transfer_events/README.md","articles":[]},{"title":"Upgrade via sudo","level":"3.2.9","depth":2,"path":"examples/rx/10_upgrade_chain/README.md","ref":"examples/rx/10_upgrade_chain/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/rx/01_simple_connect/README.md","mtime":"2019-02-08T14:45:12.596Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-08T14:49:34.586Z"},"basePath":"../../..","book":{"language":""}}); gitbook.page.hasChanged({"page":{"title":"Simple connect","level":"3.2.1","depth":2,"next":{"title":"Listen to blocks","level":"3.2.2","depth":2,"path":"examples/rx/02_listen_to_blocks/README.md","ref":"examples/rx/02_listen_to_blocks/README.md","articles":[]},"previous":{"title":"ApiRx","level":"3.2","depth":1,"path":"examples/rx/README.md","ref":"examples/rx/README.md","articles":[{"title":"Simple connect","level":"3.2.1","depth":2,"path":"examples/rx/01_simple_connect/README.md","ref":"examples/rx/01_simple_connect/README.md","articles":[]},{"title":"Listen to blocks","level":"3.2.2","depth":2,"path":"examples/rx/02_listen_to_blocks/README.md","ref":"examples/rx/02_listen_to_blocks/README.md","articles":[]},{"title":"Listen to balance change","level":"3.2.3","depth":2,"path":"examples/rx/03_listen_to_balance_change/README.md","ref":"examples/rx/03_listen_to_balance_change/README.md","articles":[]},{"title":"Unsubscribe from listening","level":"3.2.4","depth":2,"path":"examples/rx/04_unsubscribe/README.md","ref":"examples/rx/04_unsubscribe/README.md","articles":[]},{"title":"Read chain state","level":"3.2.5","depth":2,"path":"examples/rx/05_read_storage/README.md","ref":"examples/rx/05_read_storage/README.md","articles":[]},{"title":"Make a transfer","level":"3.2.6","depth":2,"path":"examples/rx/06_make_transfer/README.md","ref":"examples/rx/06_make_transfer/README.md","articles":[]},{"title":"Display system events","level":"3.2.7","depth":2,"path":"examples/rx/08_system_events/README.md","ref":"examples/rx/08_system_events/README.md","articles":[]},{"title":"Transaction with events","level":"3.2.8","depth":2,"path":"examples/rx/09_transfer_events/README.md","ref":"examples/rx/09_transfer_events/README.md","articles":[]},{"title":"Upgrade via sudo","level":"3.2.9","depth":2,"path":"examples/rx/10_upgrade_chain/README.md","ref":"examples/rx/10_upgrade_chain/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/rx/01_simple_connect/README.md","mtime":"2019-02-09T05:16:44.147Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-09T05:21:07.515Z"},"basePath":"../../..","book":{"language":""}});
}); });
</script> </script>
</div> </div>
docs/examples/rx/02_listen_to_blocks/index.html
+1 -1
View File
@@ -2202,7 +2202,7 @@
<script> <script>
var gitbook = gitbook || []; var gitbook = gitbook || [];
gitbook.push(function() { gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Listen to blocks","level":"3.2.2","depth":2,"next":{"title":"Listen to balance change","level":"3.2.3","depth":2,"path":"examples/rx/03_listen_to_balance_change/README.md","ref":"examples/rx/03_listen_to_balance_change/README.md","articles":[]},"previous":{"title":"Simple connect","level":"3.2.1","depth":2,"path":"examples/rx/01_simple_connect/README.md","ref":"examples/rx/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/rx/02_listen_to_blocks/README.md","mtime":"2019-02-08T14:45:12.596Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-08T14:49:34.586Z"},"basePath":"../../..","book":{"language":""}}); gitbook.page.hasChanged({"page":{"title":"Listen to blocks","level":"3.2.2","depth":2,"next":{"title":"Listen to balance change","level":"3.2.3","depth":2,"path":"examples/rx/03_listen_to_balance_change/README.md","ref":"examples/rx/03_listen_to_balance_change/README.md","articles":[]},"previous":{"title":"Simple connect","level":"3.2.1","depth":2,"path":"examples/rx/01_simple_connect/README.md","ref":"examples/rx/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/rx/02_listen_to_blocks/README.md","mtime":"2019-02-09T05:16:44.147Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-09T05:21:07.515Z"},"basePath":"../../..","book":{"language":""}});
}); });
</script> </script>
</div> </div>
docs/examples/rx/03_listen_to_balance_change/index.html
+1 -1
View File
@@ -2219,7 +2219,7 @@
<script> <script>
var gitbook = gitbook || []; var gitbook = gitbook || [];
gitbook.push(function() { gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Listen to balance change","level":"3.2.3","depth":2,"next":{"title":"Unsubscribe from listening","level":"3.2.4","depth":2,"path":"examples/rx/04_unsubscribe/README.md","ref":"examples/rx/04_unsubscribe/README.md","articles":[]},"previous":{"title":"Listen to blocks","level":"3.2.2","depth":2,"path":"examples/rx/02_listen_to_blocks/README.md","ref":"examples/rx/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/rx/03_listen_to_balance_change/README.md","mtime":"2019-02-08T14:45:12.596Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-08T14:49:34.586Z"},"basePath":"../../..","book":{"language":""}}); gitbook.page.hasChanged({"page":{"title":"Listen to balance change","level":"3.2.3","depth":2,"next":{"title":"Unsubscribe from listening","level":"3.2.4","depth":2,"path":"examples/rx/04_unsubscribe/README.md","ref":"examples/rx/04_unsubscribe/README.md","articles":[]},"previous":{"title":"Listen to blocks","level":"3.2.2","depth":2,"path":"examples/rx/02_listen_to_blocks/README.md","ref":"examples/rx/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/rx/03_listen_to_balance_change/README.md","mtime":"2019-02-09T05:16:44.147Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-09T05:21:07.515Z"},"basePath":"../../..","book":{"language":""}});
}); });
</script> </script>
</div> </div>
docs/examples/rx/04_unsubscribe/index.html
+1 -1
View File
@@ -2207,7 +2207,7 @@
<script> <script>
var gitbook = gitbook || []; var gitbook = gitbook || [];
gitbook.push(function() { gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Unsubscribe from listening","level":"3.2.4","depth":2,"next":{"title":"Read chain state","level":"3.2.5","depth":2,"path":"examples/rx/05_read_storage/README.md","ref":"examples/rx/05_read_storage/README.md","articles":[]},"previous":{"title":"Listen to balance change","level":"3.2.3","depth":2,"path":"examples/rx/03_listen_to_balance_change/README.md","ref":"examples/rx/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/rx/04_unsubscribe/README.md","mtime":"2019-02-08T14:45:12.596Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-08T14:49:34.586Z"},"basePath":"../../..","book":{"language":""}}); gitbook.page.hasChanged({"page":{"title":"Unsubscribe from listening","level":"3.2.4","depth":2,"next":{"title":"Read chain state","level":"3.2.5","depth":2,"path":"examples/rx/05_read_storage/README.md","ref":"examples/rx/05_read_storage/README.md","articles":[]},"previous":{"title":"Listen to balance change","level":"3.2.3","depth":2,"path":"examples/rx/03_listen_to_balance_change/README.md","ref":"examples/rx/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/rx/04_unsubscribe/README.md","mtime":"2019-02-09T05:16:44.147Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-09T05:21:07.515Z"},"basePath":"../../..","book":{"language":""}});
}); });
</script> </script>
</div> </div>
docs/examples/rx/05_read_storage/index.html
+1 -1
View File
@@ -2232,7 +2232,7 @@
<script> <script>
var gitbook = gitbook || []; var gitbook = gitbook || [];
gitbook.push(function() { gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Read chain state","level":"3.2.5","depth":2,"next":{"title":"Make a transfer","level":"3.2.6","depth":2,"path":"examples/rx/06_make_transfer/README.md","ref":"examples/rx/06_make_transfer/README.md","articles":[]},"previous":{"title":"Unsubscribe from listening","level":"3.2.4","depth":2,"path":"examples/rx/04_unsubscribe/README.md","ref":"examples/rx/04_unsubscribe/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/rx/05_read_storage/README.md","mtime":"2019-02-08T14:45:12.596Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-08T14:49:34.586Z"},"basePath":"../../..","book":{"language":""}}); gitbook.page.hasChanged({"page":{"title":"Read chain state","level":"3.2.5","depth":2,"next":{"title":"Make a transfer","level":"3.2.6","depth":2,"path":"examples/rx/06_make_transfer/README.md","ref":"examples/rx/06_make_transfer/README.md","articles":[]},"previous":{"title":"Unsubscribe from listening","level":"3.2.4","depth":2,"path":"examples/rx/04_unsubscribe/README.md","ref":"examples/rx/04_unsubscribe/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/rx/05_read_storage/README.md","mtime":"2019-02-09T05:16:44.147Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-09T05:21:07.515Z"},"basePath":"../../..","book":{"language":""}});
}); });
</script> </script>
</div> </div>
docs/examples/rx/06_make_transfer/index.html
+1 -1
View File
@@ -2216,7 +2216,7 @@
<script> <script>
var gitbook = gitbook || []; var gitbook = gitbook || [];
gitbook.push(function() { gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Make a transfer","level":"3.2.6","depth":2,"next":{"title":"Display system events","level":"3.2.7","depth":2,"path":"examples/rx/08_system_events/README.md","ref":"examples/rx/08_system_events/README.md","articles":[]},"previous":{"title":"Read chain state","level":"3.2.5","depth":2,"path":"examples/rx/05_read_storage/README.md","ref":"examples/rx/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/rx/06_make_transfer/README.md","mtime":"2019-02-08T14:45:12.596Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-08T14:49:34.586Z"},"basePath":"../../..","book":{"language":""}}); gitbook.page.hasChanged({"page":{"title":"Make a transfer","level":"3.2.6","depth":2,"next":{"title":"Display system events","level":"3.2.7","depth":2,"path":"examples/rx/08_system_events/README.md","ref":"examples/rx/08_system_events/README.md","articles":[]},"previous":{"title":"Read chain state","level":"3.2.5","depth":2,"path":"examples/rx/05_read_storage/README.md","ref":"examples/rx/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/rx/06_make_transfer/README.md","mtime":"2019-02-09T05:16:44.147Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-09T05:21:07.515Z"},"basePath":"../../..","book":{"language":""}});
}); });
</script> </script>
</div> </div>
docs/examples/rx/08_system_events/index.html
+1 -1
View File
@@ -2218,7 +2218,7 @@
<script> <script>
var gitbook = gitbook || []; var gitbook = gitbook || [];
gitbook.push(function() { gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Display system events","level":"3.2.7","depth":2,"next":{"title":"Transaction with events","level":"3.2.8","depth":2,"path":"examples/rx/09_transfer_events/README.md","ref":"examples/rx/09_transfer_events/README.md","articles":[]},"previous":{"title":"Make a transfer","level":"3.2.6","depth":2,"path":"examples/rx/06_make_transfer/README.md","ref":"examples/rx/06_make_transfer/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/rx/08_system_events/README.md","mtime":"2019-02-08T14:45:12.596Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-08T14:49:34.586Z"},"basePath":"../../..","book":{"language":""}}); gitbook.page.hasChanged({"page":{"title":"Display system events","level":"3.2.7","depth":2,"next":{"title":"Transaction with events","level":"3.2.8","depth":2,"path":"examples/rx/09_transfer_events/README.md","ref":"examples/rx/09_transfer_events/README.md","articles":[]},"previous":{"title":"Make a transfer","level":"3.2.6","depth":2,"path":"examples/rx/06_make_transfer/README.md","ref":"examples/rx/06_make_transfer/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/rx/08_system_events/README.md","mtime":"2019-02-09T05:16:44.147Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-09T05:21:07.515Z"},"basePath":"../../..","book":{"language":""}});
}); });
</script> </script>
</div> </div>
docs/examples/rx/09_transfer_events/index.html
+1 -1
View File
@@ -2235,7 +2235,7 @@
<script> <script>
var gitbook = gitbook || []; var gitbook = gitbook || [];
gitbook.push(function() { gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Transaction with events","level":"3.2.8","depth":2,"next":{"title":"Upgrade via sudo","level":"3.2.9","depth":2,"path":"examples/rx/10_upgrade_chain/README.md","ref":"examples/rx/10_upgrade_chain/README.md","articles":[]},"previous":{"title":"Display system events","level":"3.2.7","depth":2,"path":"examples/rx/08_system_events/README.md","ref":"examples/rx/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/rx/09_transfer_events/README.md","mtime":"2019-02-08T14:45:12.600Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-08T14:49:34.586Z"},"basePath":"../../..","book":{"language":""}}); gitbook.page.hasChanged({"page":{"title":"Transaction with events","level":"3.2.8","depth":2,"next":{"title":"Upgrade via sudo","level":"3.2.9","depth":2,"path":"examples/rx/10_upgrade_chain/README.md","ref":"examples/rx/10_upgrade_chain/README.md","articles":[]},"previous":{"title":"Display system events","level":"3.2.7","depth":2,"path":"examples/rx/08_system_events/README.md","ref":"examples/rx/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/rx/09_transfer_events/README.md","mtime":"2019-02-09T05:16:44.147Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-09T05:21:07.515Z"},"basePath":"../../..","book":{"language":""}});
}); });
</script> </script>
</div> </div>
docs/examples/rx/10_upgrade_chain/index.html
+1 -1
View File
@@ -2240,7 +2240,7 @@
<script> <script>
var gitbook = gitbook || []; var gitbook = gitbook || [];
gitbook.push(function() { gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Upgrade via sudo","level":"3.2.9","depth":2,"next":{"title":"hidden","level":"4.1","depth":1,"path":"types/classes/_accountid_.accountid.md","ref":"types/classes/_accountid_.accountid.md","articles":[]},"previous":{"title":"Transaction with events","level":"3.2.8","depth":2,"path":"examples/rx/09_transfer_events/README.md","ref":"examples/rx/09_transfer_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/rx/10_upgrade_chain/README.md","mtime":"2019-02-08T14:45:12.600Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-08T14:49:34.586Z"},"basePath":"../../..","book":{"language":""}}); gitbook.page.hasChanged({"page":{"title":"Upgrade via sudo","level":"3.2.9","depth":2,"next":{"title":"hidden","level":"4.1","depth":1,"path":"types/classes/_accountid_.accountid.md","ref":"types/classes/_accountid_.accountid.md","articles":[]},"previous":{"title":"Transaction with events","level":"3.2.8","depth":2,"path":"examples/rx/09_transfer_events/README.md","ref":"examples/rx/09_transfer_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/rx/10_upgrade_chain/README.md","mtime":"2019-02-09T05:16:44.147Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-09T05:21:07.515Z"},"basePath":"../../..","book":{"language":""}});
}); });
</script> </script>
</div> </div>
docs/examples/rx/index.html
+1 -1
View File
@@ -2193,7 +2193,7 @@
<script> <script>
var gitbook = gitbook || []; var gitbook = gitbook || [];
gitbook.push(function() { gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"ApiRx","level":"3.2","depth":1,"next":{"title":"Simple connect","level":"3.2.1","depth":2,"path":"examples/rx/01_simple_connect/README.md","ref":"examples/rx/01_simple_connect/README.md","articles":[]},"previous":{"title":"Upgrade via sudo","level":"3.1.9","depth":2,"path":"examples/promise/10_upgrade_chain/README.md","ref":"examples/promise/10_upgrade_chain/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/rx/README.md","mtime":"2019-02-08T14:45:12.604Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-08T14:49:34.586Z"},"basePath":"../..","book":{"language":""}}); gitbook.page.hasChanged({"page":{"title":"ApiRx","level":"3.2","depth":1,"next":{"title":"Simple connect","level":"3.2.1","depth":2,"path":"examples/rx/01_simple_connect/README.md","ref":"examples/rx/01_simple_connect/README.md","articles":[]},"previous":{"title":"Upgrade via sudo","level":"3.1.9","depth":2,"path":"examples/promise/10_upgrade_chain/README.md","ref":"examples/promise/10_upgrade_chain/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/rx/README.md","mtime":"2019-02-09T05:16:44.155Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-09T05:21:07.515Z"},"basePath":"../..","book":{"language":""}});
}); });
</script> </script>
</div> </div>
docs/index.html
+1 -1
View File
@@ -2186,7 +2186,7 @@
<script> <script>
var gitbook = gitbook || []; var gitbook = gitbook || [];
gitbook.push(function() { 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":"2019-02-08T14:45:12.580Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-08T14:49:34.586Z"},"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":"2019-02-09T05:16:44.127Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-09T05:21:07.515Z"},"basePath":".","book":{"language":""}});
}); });
</script> </script>
</div> </div>
docs/rpc-core/classes/_index_.rpc.md
+8 -8
View File
@@ -38,7 +38,7 @@ const api = new Api(provider);
⊕ **new Rpc**(provider?: *`ProviderInterface`*): [Rpc](_index_.rpc.md) ⊕ **new Rpc**(provider?: *`ProviderInterface`*): [Rpc](_index_.rpc.md)
*Defined in [index.ts:46](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-core/src/index.ts#L46)* *Defined in [index.ts:46](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-core/src/index.ts#L46)*
*__constructor__*: Default constructor for the Api Object *__constructor__*: Default constructor for the Api Object
@@ -60,7 +60,7 @@ ___
**● _provider**: *`ProviderInterface`* **● _provider**: *`ProviderInterface`*
*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-core/src/index.ts#L42)* *Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-core/src/index.ts#L42)*
___ ___
<a id="author"></a> <a id="author"></a>
@@ -71,7 +71,7 @@ ___
*Implementation of [RpcInterface](../interfaces/_types_.rpcinterface.md).[author](../interfaces/_types_.rpcinterface.md#author)* *Implementation of [RpcInterface](../interfaces/_types_.rpcinterface.md).[author](../interfaces/_types_.rpcinterface.md#author)*
*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-core/src/index.ts#L43)* *Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-core/src/index.ts#L43)*
___ ___
<a id="chain"></a> <a id="chain"></a>
@@ -82,7 +82,7 @@ ___
*Implementation of [RpcInterface](../interfaces/_types_.rpcinterface.md).[chain](../interfaces/_types_.rpcinterface.md#chain)* *Implementation of [RpcInterface](../interfaces/_types_.rpcinterface.md).[chain](../interfaces/_types_.rpcinterface.md#chain)*
*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-core/src/index.ts#L44)* *Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-core/src/index.ts#L44)*
___ ___
<a id="state"></a> <a id="state"></a>
@@ -93,7 +93,7 @@ ___
*Implementation of [RpcInterface](../interfaces/_types_.rpcinterface.md).[state](../interfaces/_types_.rpcinterface.md#state)* *Implementation of [RpcInterface](../interfaces/_types_.rpcinterface.md).[state](../interfaces/_types_.rpcinterface.md#state)*
*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-core/src/index.ts#L45)* *Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-core/src/index.ts#L45)*
___ ___
<a id="system"></a> <a id="system"></a>
@@ -104,7 +104,7 @@ ___
*Implementation of [RpcInterface](../interfaces/_types_.rpcinterface.md).[system](../interfaces/_types_.rpcinterface.md#system)* *Implementation of [RpcInterface](../interfaces/_types_.rpcinterface.md).[system](../interfaces/_types_.rpcinterface.md#system)*
*Defined in [index.ts:46](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-core/src/index.ts#L46)* *Defined in [index.ts:46](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-core/src/index.ts#L46)*
___ ___
@@ -116,7 +116,7 @@ ___
▸ **disconnect**(): `void` ▸ **disconnect**(): `void`
*Defined in [index.ts:90](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-core/src/index.ts#L90)* *Defined in [index.ts:90](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-core/src/index.ts#L90)*
*__description__*: Manually disconnect from the attached provider *__description__*: Manually disconnect from the attached provider
@@ -129,7 +129,7 @@ ___
▸ **signature**(__namedParameters: *`object`*): `string` ▸ **signature**(__namedParameters: *`object`*): `string`
*Defined in [index.ts:79](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-core/src/index.ts#L79)* *Defined in [index.ts:79](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-core/src/index.ts#L79)*
*__name__*: signature *__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)* **● author**: *[RpcInterface$Section](../modules/_types_.md#rpcinterface_section)*
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-core/src/types.ts#L17)* *Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-core/src/types.ts#L17)*
___ ___
<a id="chain"></a> <a id="chain"></a>
@@ -25,7 +25,7 @@ ___
**● chain**: *[RpcInterface$Section](../modules/_types_.md#rpcinterface_section)* **● chain**: *[RpcInterface$Section](../modules/_types_.md#rpcinterface_section)*
*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-core/src/types.ts#L18)* *Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-core/src/types.ts#L18)*
___ ___
<a id="state"></a> <a id="state"></a>
@@ -34,7 +34,7 @@ ___
**● state**: *[RpcInterface$Section](../modules/_types_.md#rpcinterface_section)* **● state**: *[RpcInterface$Section](../modules/_types_.md#rpcinterface_section)*
*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-core/src/types.ts#L19)* *Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-core/src/types.ts#L19)*
___ ___
<a id="system"></a> <a id="system"></a>
@@ -43,7 +43,7 @@ ___
**● system**: *[RpcInterface$Section](../modules/_types_.md#rpcinterface_section)* **● system**: *[RpcInterface$Section](../modules/_types_.md#rpcinterface_section)*
*Defined in [types.ts:20](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-core/src/types.ts#L20)* *Defined in [types.ts:20](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-core/src/types.ts#L20)*
___ ___
docs/rpc-core/interfaces/_types_.rpcinterface_method.md
+3 -3
View File
@@ -7,7 +7,7 @@
# Callable # Callable
▸ **__call**(...params: *`Array`<`any`>*): `Promise`<`any`> ▸ **__call**(...params: *`Array`<`any`>*): `Promise`<`any`>
*Defined in [types.ts:5](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-core/src/types.ts#L5)* *Defined in [types.ts:5](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-core/src/types.ts#L5)*
**Parameters:** **Parameters:**
@@ -25,7 +25,7 @@
**● subscription**: *`string`* **● subscription**: *`string`*
*Defined in [types.ts:8](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-core/src/types.ts#L8)* *Defined in [types.ts:8](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-core/src/types.ts#L8)*
___ ___
<a id="unsubscribe"></a> <a id="unsubscribe"></a>
@@ -34,7 +34,7 @@ ___
**● unsubscribe**: *`function`* **● unsubscribe**: *`function`*
*Defined in [types.ts:9](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-core/src/types.ts#L9)* *Defined in [types.ts:9](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-core/src/types.ts#L9)*
#### Type declaration #### Type declaration
▸(id: *`number`*): `Promise`<`any`> ▸(id: *`number`*): `Promise`<`any`>
docs/rpc-core/modules/_types_.md
+1 -1
View File
@@ -21,7 +21,7 @@
**Ƭ RpcInterface$Section**: *`object`* **Ƭ RpcInterface$Section**: *`object`*
*Defined in [types.ts:12](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-core/src/types.ts#L12)* *Defined in [types.ts:12](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-core/src/types.ts#L12)*
#### Type declaration #### 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` ▸ **decodeResponse**(response: *[JsonRpcResponse](../modules/_types_.md#jsonrpcresponse)*): `any`
*Defined in [coder/index.ts:12](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/coder/index.ts#L12)* *Defined in [coder/index.ts:12](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/coder/index.ts#L12)*
**Parameters:** **Parameters:**
@@ -29,7 +29,7 @@ ___
▸ **encodeJson**(method: *`string`*, params: *`any` | `Array`<`any`>*): `string` ▸ **encodeJson**(method: *`string`*, params: *`any` | `Array`<`any`>*): `string`
*Defined in [coder/index.ts:33](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/coder/index.ts#L33)* *Defined in [coder/index.ts:33](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/coder/index.ts#L33)*
**Parameters:** **Parameters:**
@@ -47,7 +47,7 @@ ___
▸ **encodeObject**(method: *`string`*, params: *`any` | `Array`<`any`>*): [JsonRpcRequest](../modules/_types_.md#jsonrpcrequest) ▸ **encodeObject**(method: *`string`*, params: *`any` | `Array`<`any`>*): [JsonRpcRequest](../modules/_types_.md#jsonrpcrequest)
*Defined in [coder/index.ts:39](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/coder/index.ts#L39)* *Defined in [coder/index.ts:39](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/coder/index.ts#L39)*
**Parameters:** **Parameters:**
@@ -65,7 +65,7 @@ ___
▸ **getId**(): `number` ▸ **getId**(): `number`
*Defined in [coder/index.ts:48](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/coder/index.ts#L48)* *Defined in [coder/index.ts:48](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/coder/index.ts#L48)*
**Returns:** `number` **Returns:** `number`
docs/rpc-provider/classes/_http_index_.httpprovider.html
+10 -10
View File
@@ -2156,7 +2156,7 @@
<p><a id="constructor"></a></p> <p><a id="constructor"></a></p>
<h2 id="constructor">constructor</h2> <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>&#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/b2f0618/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/c1672e8/packages/rpc-provider/src/http/index.ts#L40" target="_blank">http/index.ts:40</a></em></p>
<p><strong>Parameters:</strong></p> <p><strong>Parameters:</strong></p>
<table> <table>
<thead> <thead>
@@ -2182,7 +2182,7 @@
<p><a id="hassubscriptions"></a></p> <p><a id="hassubscriptions"></a></p>
<h2 id="hassubscriptions">hasSubscriptions</h2> <h2 id="hassubscriptions">hasSubscriptions</h2>
<p>gethasSubscriptions(): <code>boolean</code></p> <p>gethasSubscriptions(): <code>boolean</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/http/index.ts#L55" target="_blank">http/index.ts:55</a></em></p> <p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/http/index.ts#L55" target="_blank">http/index.ts:55</a></em></p>
<p><em><strong>summary</strong></em>: <code>true</code> when this provider supports subscriptions</p> <p><em><strong>summary</strong></em>: <code>true</code> when this provider supports subscriptions</p>
<p><strong>Returns:</strong> <code>boolean</code></p> <p><strong>Returns:</strong> <code>boolean</code></p>
<hr> <hr>
@@ -2191,7 +2191,7 @@
<h2 id="clone">clone</h2> <h2 id="clone">clone</h2>
<p>&#x25B8; <strong>clone</strong>(): <a href="_http_index_.httpprovider.html">HttpProvider</a></p> <p>&#x25B8; <strong>clone</strong>(): <a href="_http_index_.httpprovider.html">HttpProvider</a></p>
<p><em>Implementation of <a href="../interfaces/_types_.providerinterface.md">ProviderInterface</a>.<a href="../interfaces/_types_.providerinterface.md#clone">clone</a></em></p> <p><em>Implementation of <a href="../interfaces/_types_.providerinterface.md">ProviderInterface</a>.<a href="../interfaces/_types_.providerinterface.md#clone">clone</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/http/index.ts#L62" target="_blank">http/index.ts:62</a></em></p> <p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/http/index.ts#L62" target="_blank">http/index.ts:62</a></em></p>
<p><em><strong>description</strong></em>: Returns a clone of the object</p> <p><em><strong>description</strong></em>: Returns a clone of the object</p>
<p><strong>Returns:</strong> <a href="_http_index_.httpprovider.html">HttpProvider</a></p> <p><strong>Returns:</strong> <a href="_http_index_.httpprovider.html">HttpProvider</a></p>
<hr> <hr>
@@ -2199,7 +2199,7 @@
<h2 id="disconnect">disconnect</h2> <h2 id="disconnect">disconnect</h2>
<p>&#x25B8; <strong>disconnect</strong>(): <code>void</code></p> <p>&#x25B8; <strong>disconnect</strong>(): <code>void</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.providerinterface.md">ProviderInterface</a>.<a href="../interfaces/_types_.providerinterface.md#disconnect">disconnect</a></em></p> <p><em>Implementation of <a href="../interfaces/_types_.providerinterface.md">ProviderInterface</a>.<a href="../interfaces/_types_.providerinterface.md#disconnect">disconnect</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/http/index.ts#L69" target="_blank">http/index.ts:69</a></em></p> <p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/http/index.ts#L69" target="_blank">http/index.ts:69</a></em></p>
<p><em><strong>description</strong></em>: Manually disconnect from the connection</p> <p><em><strong>description</strong></em>: Manually disconnect from the connection</p>
<p><strong>Returns:</strong> <code>void</code></p> <p><strong>Returns:</strong> <code>void</code></p>
<hr> <hr>
@@ -2207,7 +2207,7 @@
<h2 id="isconnected">isConnected</h2> <h2 id="isconnected">isConnected</h2>
<p>&#x25B8; <strong>isConnected</strong>(): <code>boolean</code></p> <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>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/b2f0618/packages/rpc-provider/src/http/index.ts#L77" target="_blank">http/index.ts:77</a></em></p> <p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/http/index.ts#L77" target="_blank">http/index.ts:77</a></em></p>
<p><em><strong>summary</strong></em>: Whether the node is connected or not.</p> <p><em><strong>summary</strong></em>: Whether the node is connected or not.</p>
<p><strong>Returns:</strong> <code>boolean</code> <p><strong>Returns:</strong> <code>boolean</code>
true if connected</p> true if connected</p>
@@ -2216,7 +2216,7 @@ true if connected</p>
<h2 id="on">on</h2> <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>&#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>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/b2f0618/packages/rpc-provider/src/http/index.ts#L85" target="_blank">http/index.ts:85</a></em></p> <p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/http/index.ts#L85" target="_blank">http/index.ts:85</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>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><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> <p><strong>Parameters:</strong></p>
@@ -2244,7 +2244,7 @@ true if connected</p>
<h2 id="send">send</h2> <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>&#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>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/b2f0618/packages/rpc-provider/src/http/index.ts#L92" target="_blank">http/index.ts:92</a></em></p> <p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/http/index.ts#L92" target="_blank">http/index.ts:92</a></em></p>
<p><em><strong>summary</strong></em>: Send HTTP POST Request with Body to configured HTTP Endpoint.</p> <p><em><strong>summary</strong></em>: Send HTTP POST Request with Body to configured HTTP Endpoint.</p>
<p><strong>Parameters:</strong></p> <p><strong>Parameters:</strong></p>
<table> <table>
@@ -2271,7 +2271,7 @@ true if connected</p>
<h2 id="subscribe">subscribe</h2> <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>&#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>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/b2f0618/packages/rpc-provider/src/http/index.ts#L114" target="_blank">http/index.ts:114</a></em></p> <p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/http/index.ts#L114" target="_blank">http/index.ts:114</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><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> <p><strong>Parameters:</strong></p>
<table> <table>
@@ -2306,7 +2306,7 @@ true if connected</p>
<h2 id="unsubscribe">unsubscribe</h2> <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>&#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>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/b2f0618/packages/rpc-provider/src/http/index.ts#L123" target="_blank">http/index.ts:123</a></em></p> <p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/http/index.ts#L123" target="_blank">http/index.ts:123</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><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> <p><strong>Parameters:</strong></p>
<table> <table>
@@ -2376,7 +2376,7 @@ true if connected</p>
<script> <script>
var gitbook = gitbook || []; var gitbook = gitbook || [];
gitbook.push(function() { 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":"2019-02-08T14:48:21.517Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-08T14:49:34.586Z"},"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":"2019-02-09T05:19:53.542Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-09T05:21:07.515Z"},"basePath":"../..","book":{"language":""}});
}); });
</script> </script>
</div> </div>
docs/rpc-provider/classes/_http_index_.httpprovider.md
+9 -9
View File
@@ -34,7 +34,7 @@ const api = new Api(provider);
⊕ **new HttpProvider**(endpoint?: *`string`*): [HttpProvider](_http_index_.httpprovider.md) ⊕ **new HttpProvider**(endpoint?: *`string`*): [HttpProvider](_http_index_.httpprovider.md)
*Defined in [http/index.ts:40](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/http/index.ts#L40)* *Defined in [http/index.ts:40](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/http/index.ts#L40)*
**Parameters:** **Parameters:**
@@ -54,7 +54,7 @@ ___
gethasSubscriptions(): `boolean` gethasSubscriptions(): `boolean`
*Defined in [http/index.ts:55](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/http/index.ts#L55)* *Defined in [http/index.ts:55](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/http/index.ts#L55)*
*__summary__*: `true` when this provider supports subscriptions *__summary__*: `true` when this provider supports subscriptions
@@ -72,7 +72,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[clone](../interfaces/_types_.providerinterface.md#clone)* *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[clone](../interfaces/_types_.providerinterface.md#clone)*
*Defined in [http/index.ts:62](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/http/index.ts#L62)* *Defined in [http/index.ts:62](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/http/index.ts#L62)*
*__description__*: Returns a clone of the object *__description__*: Returns a clone of the object
@@ -87,7 +87,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[disconnect](../interfaces/_types_.providerinterface.md#disconnect)* *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[disconnect](../interfaces/_types_.providerinterface.md#disconnect)*
*Defined in [http/index.ts:69](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/http/index.ts#L69)* *Defined in [http/index.ts:69](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/http/index.ts#L69)*
*__description__*: Manually disconnect from the connection *__description__*: Manually disconnect from the connection
@@ -102,7 +102,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[isConnected](../interfaces/_types_.providerinterface.md#isconnected)* *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[isConnected](../interfaces/_types_.providerinterface.md#isconnected)*
*Defined in [http/index.ts:77](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/http/index.ts#L77)* *Defined in [http/index.ts:77](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/http/index.ts#L77)*
*__summary__*: Whether the node is connected or not. *__summary__*: Whether the node is connected or not.
@@ -118,7 +118,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[on](../interfaces/_types_.providerinterface.md#on)* *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[on](../interfaces/_types_.providerinterface.md#on)*
*Defined in [http/index.ts:85](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/http/index.ts#L85)* *Defined in [http/index.ts:85](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/http/index.ts#L85)*
*__summary__*: Events are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md). *__summary__*: Events are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md).
@@ -142,7 +142,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[send](../interfaces/_types_.providerinterface.md#send)* *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[send](../interfaces/_types_.providerinterface.md#send)*
*Defined in [http/index.ts:92](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/http/index.ts#L92)* *Defined in [http/index.ts:92](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/http/index.ts#L92)*
*__summary__*: Send HTTP POST Request with Body to configured HTTP Endpoint. *__summary__*: Send HTTP POST Request with Body to configured HTTP Endpoint.
@@ -164,7 +164,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[subscribe](../interfaces/_types_.providerinterface.md#subscribe)* *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[subscribe](../interfaces/_types_.providerinterface.md#subscribe)*
*Defined in [http/index.ts:114](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/http/index.ts#L114)* *Defined in [http/index.ts:114](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/http/index.ts#L114)*
*__summary__*: Subscriptions are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md). *__summary__*: Subscriptions are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md).
@@ -188,7 +188,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[unsubscribe](../interfaces/_types_.providerinterface.md#unsubscribe)* *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[unsubscribe](../interfaces/_types_.providerinterface.md#unsubscribe)*
*Defined in [http/index.ts:123](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/http/index.ts#L123)* *Defined in [http/index.ts:123](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/http/index.ts#L123)*
*__summary__*: Subscriptions are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md). *__summary__*: Subscriptions are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md).
docs/rpc-provider/classes/_mock_index_.mock.md
+11 -11
View File
@@ -19,7 +19,7 @@ A mock provider mainly used for testing.
⊕ **new Mock**(): [Mock](_mock_index_.mock.md) ⊕ **new Mock**(): [Mock](_mock_index_.mock.md)
*Defined in [mock/index.ts:68](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/mock/index.ts#L68)* *Defined in [mock/index.ts:68](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/mock/index.ts#L68)*
**Returns:** [Mock](_mock_index_.mock.md) **Returns:** [Mock](_mock_index_.mock.md)
@@ -33,7 +33,7 @@ ___
**● isUpdating**: *`boolean`* = true **● isUpdating**: *`boolean`* = true
*Defined in [mock/index.ts:43](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/mock/index.ts#L43)* *Defined in [mock/index.ts:43](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/mock/index.ts#L43)*
___ ___
<a id="subscriptions"></a> <a id="subscriptions"></a>
@@ -49,7 +49,7 @@ ___
return subs; return subs;
}, ({} as MockState$Subscriptions)) }, ({} as MockState$Subscriptions))
*Defined in [mock/index.ts:57](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/mock/index.ts#L57)* *Defined in [mock/index.ts:57](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/mock/index.ts#L57)*
___ ___
@@ -61,7 +61,7 @@ ___
gethasSubscriptions(): `boolean` gethasSubscriptions(): `boolean`
*Defined in [mock/index.ts:74](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/mock/index.ts#L74)* *Defined in [mock/index.ts:74](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/mock/index.ts#L74)*
**Returns:** `boolean` **Returns:** `boolean`
@@ -77,7 +77,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[clone](../interfaces/_types_.providerinterface.md#clone)* *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[clone](../interfaces/_types_.providerinterface.md#clone)*
*Defined in [mock/index.ts:78](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/mock/index.ts#L78)* *Defined in [mock/index.ts:78](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/mock/index.ts#L78)*
**Returns:** [Mock](_mock_index_.mock.md) **Returns:** [Mock](_mock_index_.mock.md)
@@ -90,7 +90,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[disconnect](../interfaces/_types_.providerinterface.md#disconnect)* *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[disconnect](../interfaces/_types_.providerinterface.md#disconnect)*
*Defined in [mock/index.ts:82](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/mock/index.ts#L82)* *Defined in [mock/index.ts:82](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/mock/index.ts#L82)*
**Returns:** `void` **Returns:** `void`
@@ -103,7 +103,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[isConnected](../interfaces/_types_.providerinterface.md#isconnected)* *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[isConnected](../interfaces/_types_.providerinterface.md#isconnected)*
*Defined in [mock/index.ts:86](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/mock/index.ts#L86)* *Defined in [mock/index.ts:86](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/mock/index.ts#L86)*
**Returns:** `boolean` **Returns:** `boolean`
@@ -116,7 +116,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[on](../interfaces/_types_.providerinterface.md#on)* *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[on](../interfaces/_types_.providerinterface.md#on)*
*Defined in [mock/index.ts:90](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/mock/index.ts#L90)* *Defined in [mock/index.ts:90](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/mock/index.ts#L90)*
**Parameters:** **Parameters:**
@@ -136,7 +136,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[send](../interfaces/_types_.providerinterface.md#send)* *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[send](../interfaces/_types_.providerinterface.md#send)*
*Defined in [mock/index.ts:94](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/mock/index.ts#L94)* *Defined in [mock/index.ts:94](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/mock/index.ts#L94)*
**Parameters:** **Parameters:**
@@ -154,7 +154,7 @@ ___
▸ **subscribe**(type: *`string`*, method: *`string`*, ...params: *`Array`<`any`>*): `Promise`<`number`> ▸ **subscribe**(type: *`string`*, method: *`string`*, ...params: *`Array`<`any`>*): `Promise`<`number`>
*Defined in [mock/index.ts:102](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/mock/index.ts#L102)* *Defined in [mock/index.ts:102](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/mock/index.ts#L102)*
**Parameters:** **Parameters:**
@@ -175,7 +175,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[unsubscribe](../interfaces/_types_.providerinterface.md#unsubscribe)* *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[unsubscribe](../interfaces/_types_.providerinterface.md#unsubscribe)*
*Defined in [mock/index.ts:122](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/mock/index.ts#L122)* *Defined in [mock/index.ts:122](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/mock/index.ts#L122)*
**Parameters:** **Parameters:**
docs/rpc-provider/classes/_ws_index_.wsprovider.html
+11 -11
View File
@@ -2156,7 +2156,7 @@
<p><a id="constructor"></a></p> <p><a id="constructor"></a></p>
<h2 id="constructor">constructor</h2> <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>&#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/b2f0618/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/c1672e8/packages/rpc-provider/src/ws/index.ts#L75" target="_blank">ws/index.ts:75</a></em></p>
<p><strong>Parameters:</strong></p> <p><strong>Parameters:</strong></p>
<table> <table>
<thead> <thead>
@@ -2188,7 +2188,7 @@
<p><a id="hassubscriptions"></a></p> <p><a id="hassubscriptions"></a></p>
<h2 id="hassubscriptions">hasSubscriptions</h2> <h2 id="hassubscriptions">hasSubscriptions</h2>
<p>gethasSubscriptions(): <code>boolean</code></p> <p>gethasSubscriptions(): <code>boolean</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/ws/index.ts#L101" target="_blank">ws/index.ts:101</a></em></p> <p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/ws/index.ts#L101" target="_blank">ws/index.ts:101</a></em></p>
<p><em><strong>summary</strong></em>: <code>true</code> when this provider supports subscriptions</p> <p><em><strong>summary</strong></em>: <code>true</code> when this provider supports subscriptions</p>
<p><strong>Returns:</strong> <code>boolean</code></p> <p><strong>Returns:</strong> <code>boolean</code></p>
<hr> <hr>
@@ -2196,14 +2196,14 @@
<p><a id="clone"></a></p> <p><a id="clone"></a></p>
<h2 id="clone">clone</h2> <h2 id="clone">clone</h2>
<p>&#x25B8; <strong>clone</strong>(): <a href="_ws_index_.wsprovider.html">WsProvider</a></p> <p>&#x25B8; <strong>clone</strong>(): <a href="_ws_index_.wsprovider.html">WsProvider</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/ws/index.ts#L108" target="_blank">ws/index.ts:108</a></em></p> <p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/ws/index.ts#L108" target="_blank">ws/index.ts:108</a></em></p>
<p><em><strong>description</strong></em>: Returns a clone of the object</p> <p><em><strong>description</strong></em>: Returns a clone of the object</p>
<p><strong>Returns:</strong> <a href="_ws_index_.wsprovider.html">WsProvider</a></p> <p><strong>Returns:</strong> <a href="_ws_index_.wsprovider.html">WsProvider</a></p>
<hr> <hr>
<p><a id="connect"></a></p> <p><a id="connect"></a></p>
<h2 id="connect">connect</h2> <h2 id="connect">connect</h2>
<p>&#x25B8; <strong>connect</strong>(): <code>void</code></p> <p>&#x25B8; <strong>connect</strong>(): <code>void</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/ws/index.ts#L117" target="_blank">ws/index.ts:117</a></em></p> <p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/ws/index.ts#L117" target="_blank">ws/index.ts:117</a></em></p>
<p><em><strong>summary</strong></em>: Manually connect</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><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> <p><strong>Returns:</strong> <code>void</code></p>
@@ -2211,14 +2211,14 @@
<p><a id="disconnect"></a></p> <p><a id="disconnect"></a></p>
<h2 id="disconnect">disconnect</h2> <h2 id="disconnect">disconnect</h2>
<p>&#x25B8; <strong>disconnect</strong>(): <code>void</code></p> <p>&#x25B8; <strong>disconnect</strong>(): <code>void</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/ws/index.ts#L133" target="_blank">ws/index.ts:133</a></em></p> <p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/ws/index.ts#L133" target="_blank">ws/index.ts:133</a></em></p>
<p><em><strong>description</strong></em>: Manually disconnect from the connection, clearing autoconnect logic</p> <p><em><strong>description</strong></em>: Manually disconnect from the connection, clearing autoconnect logic</p>
<p><strong>Returns:</strong> <code>void</code></p> <p><strong>Returns:</strong> <code>void</code></p>
<hr> <hr>
<p><a id="isconnected"></a></p> <p><a id="isconnected"></a></p>
<h2 id="isconnected">isConnected</h2> <h2 id="isconnected">isConnected</h2>
<p>&#x25B8; <strong>isConnected</strong>(): <code>boolean</code></p> <p>&#x25B8; <strong>isConnected</strong>(): <code>boolean</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/ws/index.ts#L150" target="_blank">ws/index.ts:150</a></em></p> <p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/ws/index.ts#L150" target="_blank">ws/index.ts:150</a></em></p>
<p><em><strong>summary</strong></em>: Whether the node is connected or not.</p> <p><em><strong>summary</strong></em>: Whether the node is connected or not.</p>
<p><strong>Returns:</strong> <code>boolean</code> <p><strong>Returns:</strong> <code>boolean</code>
true if connected</p> true if connected</p>
@@ -2226,7 +2226,7 @@ true if connected</p>
<p><a id="on"></a></p> <p><a id="on"></a></p>
<h2 id="on">on</h2> <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>&#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/b2f0618/packages/rpc-provider/src/ws/index.ts#L159" target="_blank">ws/index.ts:159</a></em></p> <p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/ws/index.ts#L159" target="_blank">ws/index.ts:159</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><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> <p><strong>Parameters:</strong></p>
<table> <table>
@@ -2255,7 +2255,7 @@ true if connected</p>
<p><a id="send"></a></p> <p><a id="send"></a></p>
<h2 id="send">send</h2> <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>&#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/b2f0618/packages/rpc-provider/src/ws/index.ts#L169" target="_blank">ws/index.ts:169</a></em></p> <p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/ws/index.ts#L169" target="_blank">ws/index.ts:169</a></em></p>
<p><em><strong>summary</strong></em>: Send JSON data using WebSockets to configured HTTP Endpoint or queue.</p> <p><em><strong>summary</strong></em>: Send JSON data using WebSockets to configured HTTP Endpoint or queue.</p>
<p><strong>Parameters:</strong></p> <p><strong>Parameters:</strong></p>
<table> <table>
@@ -2289,7 +2289,7 @@ true if connected</p>
<p><a id="subscribe"></a></p> <p><a id="subscribe"></a></p>
<h2 id="subscribe">subscribe</h2> <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>&#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/b2f0618/packages/rpc-provider/src/ws/index.ts#L223" target="_blank">ws/index.ts:223</a></em></p> <p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/ws/index.ts#L223" target="_blank">ws/index.ts:223</a></em></p>
<p><em><strong>name</strong></em>: subscribe</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>summary</strong></em>: Allows subscribing to a specific event.</p>
<p><em><strong>example</strong></em>: </p> <p><em><strong>example</strong></em>: </p>
@@ -2340,7 +2340,7 @@ Promise resolving to the dd of the subscription you can use with [[unsubscribe]]
<p><a id="unsubscribe"></a></p> <p><a id="unsubscribe"></a></p>
<h2 id="unsubscribe">unsubscribe</h2> <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>&#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/b2f0618/packages/rpc-provider/src/ws/index.ts#L232" target="_blank">ws/index.ts:232</a></em></p> <p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/ws/index.ts#L232" target="_blank">ws/index.ts:232</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><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> <p><strong>Parameters:</strong></p>
<table> <table>
@@ -2410,7 +2410,7 @@ Promise resolving to the dd of the subscription you can use with [[unsubscribe]]
<script> <script>
var gitbook = gitbook || []; var gitbook = gitbook || [];
gitbook.push(function() { gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"WsProvider","level":"1.3.2","depth":2,"next":{"title":"types (codec implementation)","level":"1.4","depth":1,"path":"types/README.md","ref":"types/README.md","articles":[]},"previous":{"title":"HttpProvider","level":"1.3.1","depth":2,"path":"rpc-provider/classes/_http_index_.httpprovider.md","ref":"rpc-provider/classes/_http_index_.httpprovider.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"rpc-provider/classes/_ws_index_.wsprovider.md","mtime":"2019-02-08T14:48:21.621Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-08T14:49:34.586Z"},"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":"2019-02-09T05:19:53.654Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-09T05:21:07.515Z"},"basePath":"../..","book":{"language":""}});
}); });
</script> </script>
</div> </div>
docs/rpc-provider/classes/_ws_index_.wsprovider.md
+10 -10
View File
@@ -34,7 +34,7 @@ const api = new Api(provider);
⊕ **new WsProvider**(endpoint?: *`string`*, autoConnect?: *`boolean`*): [WsProvider](_ws_index_.wsprovider.md) ⊕ **new WsProvider**(endpoint?: *`string`*, autoConnect?: *`boolean`*): [WsProvider](_ws_index_.wsprovider.md)
*Defined in [ws/index.ts:75](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/ws/index.ts#L75)* *Defined in [ws/index.ts:75](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/ws/index.ts#L75)*
**Parameters:** **Parameters:**
@@ -55,7 +55,7 @@ ___
gethasSubscriptions(): `boolean` gethasSubscriptions(): `boolean`
*Defined in [ws/index.ts:101](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/ws/index.ts#L101)* *Defined in [ws/index.ts:101](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/ws/index.ts#L101)*
*__summary__*: `true` when this provider supports subscriptions *__summary__*: `true` when this provider supports subscriptions
@@ -71,7 +71,7 @@ ___
▸ **clone**(): [WsProvider](_ws_index_.wsprovider.md) ▸ **clone**(): [WsProvider](_ws_index_.wsprovider.md)
*Defined in [ws/index.ts:108](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/ws/index.ts#L108)* *Defined in [ws/index.ts:108](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/ws/index.ts#L108)*
*__description__*: Returns a clone of the object *__description__*: Returns a clone of the object
@@ -84,7 +84,7 @@ ___
▸ **connect**(): `void` ▸ **connect**(): `void`
*Defined in [ws/index.ts:117](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/ws/index.ts#L117)* *Defined in [ws/index.ts:117](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/ws/index.ts#L117)*
*__summary__*: Manually connect *__summary__*: Manually connect
@@ -99,7 +99,7 @@ ___
▸ **disconnect**(): `void` ▸ **disconnect**(): `void`
*Defined in [ws/index.ts:133](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/ws/index.ts#L133)* *Defined in [ws/index.ts:133](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/ws/index.ts#L133)*
*__description__*: Manually disconnect from the connection, clearing autoconnect logic *__description__*: Manually disconnect from the connection, clearing autoconnect logic
@@ -112,7 +112,7 @@ ___
▸ **isConnected**(): `boolean` ▸ **isConnected**(): `boolean`
*Defined in [ws/index.ts:150](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/ws/index.ts#L150)* *Defined in [ws/index.ts:150](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/ws/index.ts#L150)*
*__summary__*: Whether the node is connected or not. *__summary__*: Whether the node is connected or not.
@@ -126,7 +126,7 @@ ___
▸ **on**(type: *[ProviderInterface$Emitted](../modules/_types_.md#providerinterface_emitted)*, sub: *[ProviderInterface$EmitCb](../modules/_types_.md#providerinterface_emitcb)*): `void` ▸ **on**(type: *[ProviderInterface$Emitted](../modules/_types_.md#providerinterface_emitted)*, sub: *[ProviderInterface$EmitCb](../modules/_types_.md#providerinterface_emitcb)*): `void`
*Defined in [ws/index.ts:159](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/ws/index.ts#L159)* *Defined in [ws/index.ts:159](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/ws/index.ts#L159)*
*__summary__*: Listens on events after having subscribed using the [subscribe](_ws_index_.wsprovider.md#subscribe) function. *__summary__*: Listens on events after having subscribed using the [subscribe](_ws_index_.wsprovider.md#subscribe) function.
@@ -146,7 +146,7 @@ ___
▸ **send**(method: *`string`*, params: *`Array`<`any`>*, subscription?: *`SubscriptionHandler`*): `Promise`<`any`> ▸ **send**(method: *`string`*, params: *`Array`<`any`>*, subscription?: *`SubscriptionHandler`*): `Promise`<`any`>
*Defined in [ws/index.ts:169](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/ws/index.ts#L169)* *Defined in [ws/index.ts:169](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/ws/index.ts#L169)*
*__summary__*: Send JSON data using WebSockets to configured HTTP Endpoint or queue. *__summary__*: Send JSON data using WebSockets to configured HTTP Endpoint or queue.
@@ -167,7 +167,7 @@ ___
▸ **subscribe**(type: *`string`*, method: *`string`*, params: *`Array`<`any`>*, callback: *[ProviderInterface$Callback](../modules/_types_.md#providerinterface_callback)*): `Promise`<`number`> ▸ **subscribe**(type: *`string`*, method: *`string`*, params: *`Array`<`any`>*, callback: *[ProviderInterface$Callback](../modules/_types_.md#providerinterface_callback)*): `Promise`<`number`>
*Defined in [ws/index.ts:223](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/ws/index.ts#L223)* *Defined in [ws/index.ts:223](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/ws/index.ts#L223)*
*__name__*: subscribe *__name__*: subscribe
@@ -205,7 +205,7 @@ ___
▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`> ▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`>
*Defined in [ws/index.ts:232](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/ws/index.ts#L232)* *Defined in [ws/index.ts:232](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/ws/index.ts#L232)*
*__summary__*: Allows unsubscribing to subscriptions made with [subscribe](_ws_index_.wsprovider.md#subscribe). *__summary__*: Allows unsubscribing to subscriptions made with [subscribe](_ws_index_.wsprovider.md#subscribe).
docs/rpc-provider/index.html
+1 -1
View File
@@ -2204,7 +2204,7 @@
<script> <script>
var gitbook = gitbook || []; var gitbook = gitbook || [];
gitbook.push(function() { 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":"2019-02-08T14:48:21.337Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-08T14:49:34.586Z"},"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":"2019-02-09T05:19:53.342Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-09T05:21:07.515Z"},"basePath":"..","book":{"language":""}});
}); });
</script> </script>
</div> </div>
docs/rpc-provider/interfaces/_types_.providerinterface.md
+8 -8
View File
@@ -17,7 +17,7 @@
**● hasSubscriptions**: *`boolean`* **● hasSubscriptions**: *`boolean`*
*Defined in [types.ts:45](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/types.ts#L45)* *Defined in [types.ts:45](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/types.ts#L45)*
___ ___
@@ -29,7 +29,7 @@ ___
▸ **clone**(): [ProviderInterface](_types_.providerinterface.md) ▸ **clone**(): [ProviderInterface](_types_.providerinterface.md)
*Defined in [types.ts:46](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/types.ts#L46)* *Defined in [types.ts:46](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/types.ts#L46)*
**Returns:** [ProviderInterface](_types_.providerinterface.md) **Returns:** [ProviderInterface](_types_.providerinterface.md)
@@ -40,7 +40,7 @@ ___
▸ **disconnect**(): `void` ▸ **disconnect**(): `void`
*Defined in [types.ts:47](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/types.ts#L47)* *Defined in [types.ts:47](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/types.ts#L47)*
**Returns:** `void` **Returns:** `void`
@@ -51,7 +51,7 @@ ___
▸ **isConnected**(): `boolean` ▸ **isConnected**(): `boolean`
*Defined in [types.ts:48](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/types.ts#L48)* *Defined in [types.ts:48](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/types.ts#L48)*
**Returns:** `boolean` **Returns:** `boolean`
@@ -62,7 +62,7 @@ ___
▸ **on**(type: *[ProviderInterface$Emitted](../modules/_types_.md#providerinterface_emitted)*, sub: *[ProviderInterface$EmitCb](../modules/_types_.md#providerinterface_emitcb)*): `void` ▸ **on**(type: *[ProviderInterface$Emitted](../modules/_types_.md#providerinterface_emitted)*, sub: *[ProviderInterface$EmitCb](../modules/_types_.md#providerinterface_emitcb)*): `void`
*Defined in [types.ts:49](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/types.ts#L49)* *Defined in [types.ts:49](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/types.ts#L49)*
**Parameters:** **Parameters:**
@@ -80,7 +80,7 @@ ___
▸ **send**(method: *`string`*, params: *`Array`<`any`>*): `Promise`<`any`> ▸ **send**(method: *`string`*, params: *`Array`<`any`>*): `Promise`<`any`>
*Defined in [types.ts:50](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/types.ts#L50)* *Defined in [types.ts:50](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/types.ts#L50)*
**Parameters:** **Parameters:**
@@ -98,7 +98,7 @@ ___
▸ **subscribe**(type: *`string`*, method: *`string`*, params: *`Array`<`any`>*, cb: *[ProviderInterface$Callback](../modules/_types_.md#providerinterface_callback)*): `Promise`<`number`> ▸ **subscribe**(type: *`string`*, method: *`string`*, params: *`Array`<`any`>*, cb: *[ProviderInterface$Callback](../modules/_types_.md#providerinterface_callback)*): `Promise`<`number`>
*Defined in [types.ts:51](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/types.ts#L51)* *Defined in [types.ts:51](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/types.ts#L51)*
**Parameters:** **Parameters:**
@@ -118,7 +118,7 @@ ___
▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`> ▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`>
*Defined in [types.ts:52](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/types.ts#L52)* *Defined in [types.ts:52](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/types.ts#L52)*
**Parameters:** **Parameters:**
docs/rpc-provider/modules/_http_types_.md
+1 -1
View File
@@ -8,7 +8,7 @@
**Ƭ HttpState**: *`object`* **Ƭ HttpState**: *`object`*
*Defined in [http/types.ts:9](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/http/types.ts#L9)* *Defined in [http/types.ts:9](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/http/types.ts#L9)*
#### Type declaration #### Type declaration
docs/rpc-provider/modules/_mock_types_.md
+4 -4
View File
@@ -8,7 +8,7 @@
**Ƭ MockState$Db**: *`object`* **Ƭ MockState$Db**: *`object`*
*Defined in [mock/types.ts:16](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/mock/types.ts#L16)* *Defined in [mock/types.ts:16](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/mock/types.ts#L16)*
#### Type declaration #### Type declaration
@@ -21,7 +21,7 @@ ___
**Ƭ MockState$Requests**: *`object`* **Ƭ MockState$Requests**: *`object`*
*Defined in [mock/types.ts:20](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/mock/types.ts#L20)* *Defined in [mock/types.ts:20](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/mock/types.ts#L20)*
#### Type declaration #### Type declaration
@@ -45,7 +45,7 @@ ___
**Ƭ MockState$Subscription$Callback**: *`function`* **Ƭ MockState$Subscription$Callback**: *`function`*
*Defined in [mock/types.ts:5](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/mock/types.ts#L5)* *Defined in [mock/types.ts:5](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/mock/types.ts#L5)*
#### Type declaration #### Type declaration
▸(error: *`Error` | `null`*, value: *`any`*): `void` ▸(error: *`Error` | `null`*, value: *`any`*): `void`
@@ -66,7 +66,7 @@ ___
**Ƭ MockState$Subscriptions**: *`object`* **Ƭ MockState$Subscriptions**: *`object`*
*Defined in [mock/types.ts:7](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/mock/types.ts#L7)* *Defined in [mock/types.ts:7](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/mock/types.ts#L7)*
#### Type declaration #### Type declaration
docs/rpc-provider/modules/_types_.md
+8 -8
View File
@@ -27,7 +27,7 @@
**Ƭ JsonRpcObject**: *`object`* **Ƭ JsonRpcObject**: *`object`*
*Defined in [types.ts:5](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/types.ts#L5)* *Defined in [types.ts:5](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/types.ts#L5)*
#### Type declaration #### Type declaration
@@ -38,7 +38,7 @@ ___
**Ƭ JsonRpcRequest**: *[JsonRpcObject](_types_.md#jsonrpcobject) & `object`* **Ƭ JsonRpcRequest**: *[JsonRpcObject](_types_.md#jsonrpcobject) & `object`*
*Defined in [types.ts:10](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/types.ts#L10)* *Defined in [types.ts:10](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/types.ts#L10)*
___ ___
<a id="jsonrpcresponse"></a> <a id="jsonrpcresponse"></a>
@@ -47,7 +47,7 @@ ___
**Ƭ JsonRpcResponse**: *[JsonRpcObject](_types_.md#jsonrpcobject) & [JsonRpcResponseBase](_types_.md#jsonrpcresponsebase)* **Ƭ JsonRpcResponse**: *[JsonRpcObject](_types_.md#jsonrpcobject) & [JsonRpcResponseBase](_types_.md#jsonrpcresponsebase)*
*Defined in [types.ts:36](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/types.ts#L36)* *Defined in [types.ts:36](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/types.ts#L36)*
___ ___
<a id="jsonrpcresponsebase"></a> <a id="jsonrpcresponsebase"></a>
@@ -56,7 +56,7 @@ ___
**Ƭ JsonRpcResponseBase**: *`JsonRpcResponse$Single` & `JsonRpcResponse$Subscription`* **Ƭ JsonRpcResponseBase**: *`JsonRpcResponse$Single` & `JsonRpcResponse$Subscription`*
*Defined in [types.ts:34](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/types.ts#L34)* *Defined in [types.ts:34](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/types.ts#L34)*
___ ___
<a id="jsonrpcresponsebase_error"></a> <a id="jsonrpcresponsebase_error"></a>
@@ -65,7 +65,7 @@ ___
**Ƭ JsonRpcResponseBase$Error**: *`object`* **Ƭ JsonRpcResponseBase$Error**: *`object`*
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/types.ts#L15)* *Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/types.ts#L15)*
#### Type declaration #### Type declaration
@@ -76,7 +76,7 @@ ___
**Ƭ ProviderInterface$Callback**: *`function`* **Ƭ ProviderInterface$Callback**: *`function`*
*Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/types.ts#L38)* *Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/types.ts#L38)*
#### Type declaration #### Type declaration
▸(result: *`any`*): `void` ▸(result: *`any`*): `void`
@@ -96,7 +96,7 @@ ___
**Ƭ ProviderInterface$EmitCb**: *`function`* **Ƭ ProviderInterface$EmitCb**: *`function`*
*Defined in [types.ts:42](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/types.ts#L42)* *Defined in [types.ts:42](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-provider/src/types.ts#L42)*
#### Type declaration #### Type declaration
▸(value?: *`any`*): `any` ▸(value?: *`any`*): `any`
@@ -116,7 +116,7 @@ ___
**Ƭ ProviderInterface$Emitted**: *"connected" | "disconnected" | "error"* **Ƭ ProviderInterface$Emitted**: *"connected" | "disconnected" | "error"*
*Defined in [types.ts:40](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-provider/src/types.ts#L40)* *Defined in [types.ts:40](https://github.com/polkadot-js/api/blob/c1672e8/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` | `ProviderInterface`*): [RpcRx](_index_.rpcrx.md) ⊕ **new RpcRx**(providerOrRpc?: *`Rpc` | `ProviderInterface`*): [RpcRx](_index_.rpcrx.md)
*Defined in [index.ts:39](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-rx/src/index.ts#L39)* *Defined in [index.ts:39](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-rx/src/index.ts#L39)*
**Parameters:** **Parameters:**
@@ -52,7 +52,7 @@ ___
**● author**: *[RpcRxInterface$Section](../modules/_types_.md#rpcrxinterface_section)* **● author**: *[RpcRxInterface$Section](../modules/_types_.md#rpcrxinterface_section)*
*Defined in [index.ts:36](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-rx/src/index.ts#L36)* *Defined in [index.ts:36](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-rx/src/index.ts#L36)*
___ ___
<a id="chain"></a> <a id="chain"></a>
@@ -61,7 +61,7 @@ ___
**● chain**: *[RpcRxInterface$Section](../modules/_types_.md#rpcrxinterface_section)* **● chain**: *[RpcRxInterface$Section](../modules/_types_.md#rpcrxinterface_section)*
*Defined in [index.ts:37](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-rx/src/index.ts#L37)* *Defined in [index.ts:37](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-rx/src/index.ts#L37)*
___ ___
<a id="state"></a> <a id="state"></a>
@@ -70,7 +70,7 @@ ___
**● state**: *[RpcRxInterface$Section](../modules/_types_.md#rpcrxinterface_section)* **● state**: *[RpcRxInterface$Section](../modules/_types_.md#rpcrxinterface_section)*
*Defined in [index.ts:38](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-rx/src/index.ts#L38)* *Defined in [index.ts:38](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-rx/src/index.ts#L38)*
___ ___
<a id="system"></a> <a id="system"></a>
@@ -79,7 +79,7 @@ ___
**● system**: *[RpcRxInterface$Section](../modules/_types_.md#rpcrxinterface_section)* **● system**: *[RpcRxInterface$Section](../modules/_types_.md#rpcrxinterface_section)*
*Defined in [index.ts:39](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-rx/src/index.ts#L39)* *Defined in [index.ts:39](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-rx/src/index.ts#L39)*
___ ___
@@ -91,7 +91,7 @@ ___
▸ **isConnected**(): `BehaviorSubject`<`boolean`> ▸ **isConnected**(): `BehaviorSubject`<`boolean`>
*Defined in [index.ts:59](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-rx/src/index.ts#L59)* *Defined in [index.ts:59](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-rx/src/index.ts#L59)*
**Returns:** `BehaviorSubject`<`boolean`> **Returns:** `BehaviorSubject`<`boolean`>
@@ -102,7 +102,7 @@ ___
▸ **on**(type: *[RpcRxInterface$Events](../modules/_types_.md#rpcrxinterface_events)*, handler: *`function`*): `void` ▸ **on**(type: *[RpcRxInterface$Events](../modules/_types_.md#rpcrxinterface_events)*, handler: *`function`*): `void`
*Defined in [index.ts:63](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-rx/src/index.ts#L63)* *Defined in [index.ts:63](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-rx/src/index.ts#L63)*
**Parameters:** **Parameters:**
docs/rpc-rx/modules/_types_.md
+4 -4
View File
@@ -8,7 +8,7 @@
**Ƭ RpcRxInterface**: *`object`* **Ƭ RpcRxInterface**: *`object`*
*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-rx/src/types.ts#L16)* *Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-rx/src/types.ts#L16)*
#### Type declaration #### Type declaration
@@ -19,7 +19,7 @@ ___
**Ƭ RpcRxInterface$Events**: *`ProviderInterface$Emitted`* **Ƭ RpcRxInterface$Events**: *`ProviderInterface$Emitted`*
*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-rx/src/types.ts#L14)* *Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-rx/src/types.ts#L14)*
___ ___
<a id="rpcrxinterface_method"></a> <a id="rpcrxinterface_method"></a>
@@ -28,7 +28,7 @@ ___
**Ƭ RpcRxInterface$Method**: *`function`* **Ƭ RpcRxInterface$Method**: *`function`*
*Defined in [types.ts:8](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-rx/src/types.ts#L8)* *Defined in [types.ts:8](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-rx/src/types.ts#L8)*
#### Type declaration #### Type declaration
▸(...params: *`Array`<`any`>*): `Observable`<`any`> ▸(...params: *`Array`<`any`>*): `Observable`<`any`>
@@ -48,7 +48,7 @@ ___
**Ƭ RpcRxInterface$Section**: *`object`* **Ƭ RpcRxInterface$Section**: *`object`*
*Defined in [types.ts:10](https://github.com/polkadot-js/api/blob/b2f0618/packages/rpc-rx/src/types.ts#L10)* *Defined in [types.ts:10](https://github.com/polkadot-js/api/blob/c1672e8/packages/rpc-rx/src/types.ts#L10)*
#### Type declaration #### 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: *`MetadataV0`*): `ModulesWithMethods` ▸ **fromMetadata**(metadata: *`MetadataV0`*): `ModulesWithMethods`
*Defined in [fromMetadata.ts:21](https://github.com/polkadot-js/api/blob/b2f0618/packages/type-extrinsics/src/fromMetadata.ts#L21)* *Defined in [fromMetadata.ts:21](https://github.com/polkadot-js/api/blob/c1672e8/packages/type-extrinsics/src/fromMetadata.ts#L21)*
Extend a storage object with the storage modules & module functions present in the metadata. 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`*): `MethodFunction` ▸ **createDescriptor**(section: *`string`*, method: *`string`*, index: *`number`*, meta: *`FunctionMetadata`*): `MethodFunction`
*Defined in [utils/createUnchecked.ts:16](https://github.com/polkadot-js/api/blob/b2f0618/packages/type-extrinsics/src/utils/createUnchecked.ts#L16)* *Defined in [utils/createUnchecked.ts:16](https://github.com/polkadot-js/api/blob/c1672e8/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. 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) ▸ **createMethod**(section: *`string`*, method: *`string`*, __namedParameters: *`object`*): [RpcMethod](_types_.md#rpcmethod)
*Defined in [create/method.ts:9](https://github.com/polkadot-js/api/blob/b2f0618/packages/type-jsonrpc/src/create/method.ts#L9)* *Defined in [create/method.ts:9](https://github.com/polkadot-js/api/blob/c1672e8/packages/type-jsonrpc/src/create/method.ts#L9)*
**Parameters:** **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) ▸ **createParam**(name: *`string`*, type: *`CodecTypes`*, __namedParameters?: *`object`*): [RpcParam](_types_.md#rpcparam)
*Defined in [create/param.ts:12](https://github.com/polkadot-js/api/blob/b2f0618/packages/type-jsonrpc/src/create/param.ts#L12)* *Defined in [create/param.ts:12](https://github.com/polkadot-js/api/blob/c1672e8/packages/type-jsonrpc/src/create/param.ts#L12)*
**Parameters:** **Parameters:**

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