[CI Skip] 0.38.10
This commit is contained in:
Travis CI
+1
-1
@@ -2019,7 +2019,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"GLOSSARY.md","mtime":"2019-01-10T10:38:44.694Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-10T10:42:38.095Z"},"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-01-10T16:40:14.026Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-10T16:44:09.217Z"},"basePath":".","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -2232,7 +2232,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"Events (runtime)","level":"2.4","depth":1,"next":{"title":"ApiPromise","level":"3.1","depth":1,"path":"examples/promise/README.md","ref":"examples/promise/README.md","articles":[{"title":"Simple connect","level":"3.1.1","depth":2,"path":"examples/promise/01_simple_connect/README.md","ref":"examples/promise/01_simple_connect/README.md","articles":[]},{"title":"Listen to blocks","level":"3.1.2","depth":2,"path":"examples/promise/02_listen_to_blocks/README.md","ref":"examples/promise/02_listen_to_blocks/README.md","articles":[]},{"title":"Listen to balance change","level":"3.1.3","depth":2,"path":"examples/promise/03_listen_to_balance_change/README.md","ref":"examples/promise/03_listen_to_balance_change/README.md","articles":[]},{"title":"Read chain state","level":"3.1.4","depth":2,"path":"examples/promise/05_read_storage/README.md","ref":"examples/promise/05_read_storage/README.md","articles":[]},{"title":"Make a transfer","level":"3.1.5","depth":2,"path":"examples/promise/07_transfer_dots/README.md","ref":"examples/promise/07_transfer_dots/README.md","articles":[]},{"title":"Display system events","level":"3.1.6","depth":2,"path":"examples/promise/08_system_events/README.md","ref":"examples/promise/08_system_events/README.md","articles":[]},{"title":"Transaction with events","level":"3.1.7","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.8","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-01-10T10:41:02.379Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-10T10:42:38.095Z"},"basePath":".","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"Events (runtime)","level":"2.4","depth":1,"next":{"title":"ApiPromise","level":"3.1","depth":1,"path":"examples/promise/README.md","ref":"examples/promise/README.md","articles":[{"title":"Simple connect","level":"3.1.1","depth":2,"path":"examples/promise/01_simple_connect/README.md","ref":"examples/promise/01_simple_connect/README.md","articles":[]},{"title":"Listen to blocks","level":"3.1.2","depth":2,"path":"examples/promise/02_listen_to_blocks/README.md","ref":"examples/promise/02_listen_to_blocks/README.md","articles":[]},{"title":"Listen to balance change","level":"3.1.3","depth":2,"path":"examples/promise/03_listen_to_balance_change/README.md","ref":"examples/promise/03_listen_to_balance_change/README.md","articles":[]},{"title":"Read chain state","level":"3.1.4","depth":2,"path":"examples/promise/05_read_storage/README.md","ref":"examples/promise/05_read_storage/README.md","articles":[]},{"title":"Make a transfer","level":"3.1.5","depth":2,"path":"examples/promise/07_transfer_dots/README.md","ref":"examples/promise/07_transfer_dots/README.md","articles":[]},{"title":"Display system events","level":"3.1.6","depth":2,"path":"examples/promise/08_system_events/README.md","ref":"examples/promise/08_system_events/README.md","articles":[]},{"title":"Transaction with events","level":"3.1.7","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.8","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-01-10T16:42:34.067Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-10T16:44:09.217Z"},"basePath":".","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -2299,7 +2299,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"Extrinsics (runtime)","level":"2.3","depth":1,"next":{"title":"Events (runtime)","level":"2.4","depth":1,"path":"METHODS_EVENTS.md","ref":"METHODS_EVENTS.md","articles":[]},"previous":{"title":"Chain state (runtime)","level":"2.2","depth":1,"path":"METHODS_STORAGE.md","ref":"METHODS_STORAGE.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"METHODS_EXTRINSICS.md","mtime":"2019-01-10T10:41:02.379Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-10T10:42:38.095Z"},"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-01-10T16:42:34.067Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-10T16:44:09.217Z"},"basePath":".","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -2149,7 +2149,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"RPC","level":"2.1","depth":1,"next":{"title":"Chain state (runtime)","level":"2.2","depth":1,"path":"METHODS_STORAGE.md","ref":"METHODS_STORAGE.md","articles":[]},"previous":{"title":"types (codec implementation)","level":"1.4","depth":1,"path":"types/README.md","ref":"types/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"METHODS_RPC.md","mtime":"2019-01-10T10:41:02.379Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-10T10:42:38.095Z"},"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-01-10T16:42:34.067Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-10T16:44:09.217Z"},"basePath":".","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -2526,7 +2526,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"Chain state (runtime)","level":"2.2","depth":1,"next":{"title":"Extrinsics (runtime)","level":"2.3","depth":1,"path":"METHODS_EXTRINSICS.md","ref":"METHODS_EXTRINSICS.md","articles":[]},"previous":{"title":"RPC","level":"2.1","depth":1,"path":"METHODS_RPC.md","ref":"METHODS_RPC.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"METHODS_STORAGE.md","mtime":"2019-01-10T10:41:02.403Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-10T10:42:38.095Z"},"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-01-10T16:42:34.071Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-10T16:44:09.217Z"},"basePath":".","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -1,10 +1,30 @@
|
||||
* ["balances/accountIdAndIndex"](modules/_balances_accountidandindex_.md)
|
||||
* ["balances/accountIdToIndex"](modules/_balances_accountidtoindex_.md)
|
||||
* ["balances/accountIndexToId"](modules/_balances_accountindextoid_.md)
|
||||
* ["balances/accountIndexes"](modules/_balances_accountindexes_.md)
|
||||
* ["balances/fees"](modules/_balances_fees_.md)
|
||||
* ["balances/index"](modules/_balances_index_.md)
|
||||
* ["balances/validatingBalance"](modules/_balances_validatingbalance_.md)
|
||||
* ["balances/validatingBalances"](modules/_balances_validatingbalances_.md)
|
||||
* ["balances/votingBalance"](modules/_balances_votingbalance_.md)
|
||||
* ["balances/votingBalances"](modules/_balances_votingbalances_.md)
|
||||
* ["balances/votingBalancesNominatorsFor"](modules/_balances_votingbalancesnominatorsfor_.md)
|
||||
* ["chain/bestNumber"](modules/_chain_bestnumber_.md)
|
||||
* ["chain/bestNumberFinalised"](modules/_chain_bestnumberfinalised_.md)
|
||||
* ["chain/index"](modules/_chain_index_.md)
|
||||
* ["democracy/index"](modules/_democracy_index_.md)
|
||||
* ["democracy/referendumInfos"](modules/_democracy_referenduminfos_.md)
|
||||
* ["democracy/referendumVotesFor"](modules/_democracy_referendumvotesfor_.md)
|
||||
* ["democracy/referendums"](modules/_democracy_referendums_.md)
|
||||
* ["democracy/votes"](modules/_democracy_votes_.md)
|
||||
* ["index"](modules/_index_.md)
|
||||
* [Derive](interfaces/_index_.derive.md)
|
||||
* ["index.spec"](modules/_index_spec_.md)
|
||||
* ["session/eraLength"](modules/_session_eralength_.md)
|
||||
* ["session/eraProgress"](modules/_session_eraprogress_.md)
|
||||
* ["session/index"](modules/_session_index_.md)
|
||||
* ["session/sessionProgress"](modules/_session_sessionprogress_.md)
|
||||
* ["types"](modules/_types_.md)
|
||||
* ["util/cache"](modules/_util_cache_.md)
|
||||
* ["util/cache.spec"](modules/_util_cache_spec_.md)
|
||||
* ["util/drr"](modules/_util_drr_.md)
|
||||
|
||||
@@ -6,13 +6,31 @@
|
||||
|
||||
# Properties
|
||||
|
||||
<a id="balances"></a>
|
||||
|
||||
## balances
|
||||
|
||||
**● balances**: *`ReturnTypes`<["balances/index"](../modules/_balances_index_.md)>*
|
||||
|
||||
*Defined in [index.ts:25](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api-derive/src/index.ts#L25)*
|
||||
|
||||
___
|
||||
<a id="chain"></a>
|
||||
|
||||
## chain
|
||||
|
||||
**● chain**: *`ReturnTypes`<["chain/index"](../modules/_chain_index_.md)>*
|
||||
|
||||
*Defined in [index.ts:23](https://github.com/polkadot-js/api/blob/07d6139/packages/api-derive/src/index.ts#L23)*
|
||||
*Defined in [index.ts:26](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api-derive/src/index.ts#L26)*
|
||||
|
||||
___
|
||||
<a id="democracy"></a>
|
||||
|
||||
## democracy
|
||||
|
||||
**● democracy**: *`ReturnTypes`<["democracy/index"](../modules/_democracy_index_.md)>*
|
||||
|
||||
*Defined in [index.ts:27](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api-derive/src/index.ts#L27)*
|
||||
|
||||
___
|
||||
<a id="session"></a>
|
||||
@@ -21,7 +39,7 @@ ___
|
||||
|
||||
**● session**: *`ReturnTypes`<["session/index"](../modules/_session_index_.md)>*
|
||||
|
||||
*Defined in [index.ts:24](https://github.com/polkadot-js/api/blob/07d6139/packages/api-derive/src/index.ts#L24)*
|
||||
*Defined in [index.ts:28](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api-derive/src/index.ts#L28)*
|
||||
|
||||
___
|
||||
|
||||
|
||||
@@ -0,0 +1,34 @@
|
||||
|
||||
|
||||
# Type aliases
|
||||
|
||||
<a id="idandindex"></a>
|
||||
|
||||
## IdAndIndex
|
||||
|
||||
**Ƭ IdAndIndex**: *[`AccountId` | `undefined`, `AccountIndex` | `undefined`]*
|
||||
|
||||
*Defined in [balances/accountIdAndIndex.ts:15](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api-derive/src/balances/accountIdAndIndex.ts#L15)*
|
||||
|
||||
___
|
||||
|
||||
# Functions
|
||||
|
||||
<a id="accountidandindex"></a>
|
||||
|
||||
## accountIdAndIndex
|
||||
|
||||
▸ **accountIdAndIndex**(api: *`ApiRx`*): `(Anonymous function)`
|
||||
|
||||
*Defined in [balances/accountIdAndIndex.ts:17](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api-derive/src/balances/accountIdAndIndex.ts#L17)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| api | `ApiRx` |
|
||||
|
||||
**Returns:** `(Anonymous function)`
|
||||
|
||||
___
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
|
||||
|
||||
# Functions
|
||||
|
||||
<a id="accountidtoindex"></a>
|
||||
|
||||
## accountIdToIndex
|
||||
|
||||
▸ **accountIdToIndex**(api: *`ApiRx`*): `(Anonymous function)`
|
||||
|
||||
*Defined in [balances/accountIdToIndex.ts:13](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api-derive/src/balances/accountIdToIndex.ts#L13)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| api | `ApiRx` |
|
||||
|
||||
**Returns:** `(Anonymous function)`
|
||||
|
||||
___
|
||||
|
||||
@@ -0,0 +1,38 @@
|
||||
|
||||
|
||||
# Type aliases
|
||||
|
||||
<a id="accountindexes"></a>
|
||||
|
||||
## AccountIndexes
|
||||
|
||||
**Ƭ AccountIndexes**: *`object`*
|
||||
|
||||
*Defined in [balances/accountIndexes.ts:14](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api-derive/src/balances/accountIndexes.ts#L14)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
[index: `string`]: `AccountIndex`
|
||||
|
||||
___
|
||||
|
||||
# Functions
|
||||
|
||||
<a id="accountindexes-1"></a>
|
||||
|
||||
## accountIndexes
|
||||
|
||||
▸ **accountIndexes**(api: *`ApiRx`*): `(Anonymous function)`
|
||||
|
||||
*Defined in [balances/accountIndexes.ts:16](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api-derive/src/balances/accountIndexes.ts#L16)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| api | `ApiRx` |
|
||||
|
||||
**Returns:** `(Anonymous function)`
|
||||
|
||||
___
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
|
||||
|
||||
# Functions
|
||||
|
||||
<a id="accountindextoid"></a>
|
||||
|
||||
## accountIndexToId
|
||||
|
||||
▸ **accountIndexToId**(api: *`ApiRx`*): `(Anonymous function)`
|
||||
|
||||
*Defined in [balances/accountIndexToId.ts:14](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api-derive/src/balances/accountIndexToId.ts#L14)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| api | `ApiRx` |
|
||||
|
||||
**Returns:** `(Anonymous function)`
|
||||
|
||||
___
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
|
||||
|
||||
# Functions
|
||||
|
||||
<a id="fees"></a>
|
||||
|
||||
## fees
|
||||
|
||||
▸ **fees**(api: *`ApiRx`*): `(Anonymous function)`
|
||||
|
||||
*Defined in [balances/fees.ts:12](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api-derive/src/balances/fees.ts#L12)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| api | `ApiRx` |
|
||||
|
||||
**Returns:** `(Anonymous function)`
|
||||
|
||||
___
|
||||
|
||||
@@ -0,0 +1,2 @@
|
||||
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
|
||||
|
||||
# Functions
|
||||
|
||||
<a id="validatingbalance"></a>
|
||||
|
||||
## validatingBalance
|
||||
|
||||
▸ **validatingBalance**(api: *`ApiRx`*): `(Anonymous function)`
|
||||
|
||||
*Defined in [balances/validatingBalance.ts:16](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api-derive/src/balances/validatingBalance.ts#L16)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| api | `ApiRx` |
|
||||
|
||||
**Returns:** `(Anonymous function)`
|
||||
|
||||
___
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
|
||||
|
||||
# Functions
|
||||
|
||||
<a id="validatingbalances"></a>
|
||||
|
||||
## validatingBalances
|
||||
|
||||
▸ **validatingBalances**(api: *`ApiRx`*): `(Anonymous function)`
|
||||
|
||||
*Defined in [balances/validatingBalances.ts:14](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api-derive/src/balances/validatingBalances.ts#L14)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| api | `ApiRx` |
|
||||
|
||||
**Returns:** `(Anonymous function)`
|
||||
|
||||
___
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
|
||||
|
||||
# Functions
|
||||
|
||||
<a id="votingbalance"></a>
|
||||
|
||||
## votingBalance
|
||||
|
||||
▸ **votingBalance**(api: *`ApiRx`*): `(Anonymous function)`
|
||||
|
||||
*Defined in [balances/votingBalance.ts:16](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api-derive/src/balances/votingBalance.ts#L16)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| api | `ApiRx` |
|
||||
|
||||
**Returns:** `(Anonymous function)`
|
||||
|
||||
___
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
|
||||
|
||||
# Functions
|
||||
|
||||
<a id="votingbalances"></a>
|
||||
|
||||
## votingBalances
|
||||
|
||||
▸ **votingBalances**(api: *`ApiRx`*): `(Anonymous function)`
|
||||
|
||||
*Defined in [balances/votingBalances.ts:13](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api-derive/src/balances/votingBalances.ts#L13)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| api | `ApiRx` |
|
||||
|
||||
**Returns:** `(Anonymous function)`
|
||||
|
||||
___
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
|
||||
|
||||
# Functions
|
||||
|
||||
<a id="votingbalancesnominatorsfor"></a>
|
||||
|
||||
## votingBalancesNominatorsFor
|
||||
|
||||
▸ **votingBalancesNominatorsFor**(api: *`ApiRx`*): `(Anonymous function)`
|
||||
|
||||
*Defined in [balances/votingBalancesNominatorsFor.ts:14](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api-derive/src/balances/votingBalancesNominatorsFor.ts#L14)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| api | `ApiRx` |
|
||||
|
||||
**Returns:** `(Anonymous function)`
|
||||
|
||||
___
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
▸ **bestNumber**(api: *`ApiRx`*): `(Anonymous function)`
|
||||
|
||||
*Defined in [chain/bestNumber.ts:13](https://github.com/polkadot-js/api/blob/07d6139/packages/api-derive/src/chain/bestNumber.ts#L13)*
|
||||
*Defined in [chain/bestNumber.ts:15](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api-derive/src/chain/bestNumber.ts#L15)*
|
||||
|
||||
Get the latest block number.
|
||||
|
||||
|
||||
@@ -0,0 +1,24 @@
|
||||
|
||||
|
||||
# Functions
|
||||
|
||||
<a id="bestnumberfinalised"></a>
|
||||
|
||||
## bestNumberFinalised
|
||||
|
||||
▸ **bestNumberFinalised**(api: *`ApiRx`*): `(Anonymous function)`
|
||||
|
||||
*Defined in [chain/bestNumberFinalised.ts:15](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api-derive/src/chain/bestNumberFinalised.ts#L15)*
|
||||
|
||||
Get the latest finalised block number.
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| api | `ApiRx` |
|
||||
|
||||
**Returns:** `(Anonymous function)`
|
||||
|
||||
___
|
||||
|
||||
@@ -0,0 +1,2 @@
|
||||
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
|
||||
|
||||
# Functions
|
||||
|
||||
<a id="referenduminfos"></a>
|
||||
|
||||
## referendumInfos
|
||||
|
||||
▸ **referendumInfos**(api: *`ApiRx`*): `(Anonymous function)`
|
||||
|
||||
*Defined in [democracy/referendumInfos.ts:13](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api-derive/src/democracy/referendumInfos.ts#L13)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| api | `ApiRx` |
|
||||
|
||||
**Returns:** `(Anonymous function)`
|
||||
|
||||
___
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
|
||||
|
||||
# Functions
|
||||
|
||||
<a id="referendums"></a>
|
||||
|
||||
## referendums
|
||||
|
||||
▸ **referendums**(api: *`ApiRx`*): `(Anonymous function)`
|
||||
|
||||
*Defined in [democracy/referendums.ts:13](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api-derive/src/democracy/referendums.ts#L13)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| api | `ApiRx` |
|
||||
|
||||
**Returns:** `(Anonymous function)`
|
||||
|
||||
___
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
|
||||
|
||||
# Functions
|
||||
|
||||
<a id="referendumvotesfor"></a>
|
||||
|
||||
## referendumVotesFor
|
||||
|
||||
▸ **referendumVotesFor**(api: *`ApiRx`*): `(Anonymous function)`
|
||||
|
||||
*Defined in [democracy/referendumVotesFor.ts:17](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api-derive/src/democracy/referendumVotesFor.ts#L17)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| api | `ApiRx` |
|
||||
|
||||
**Returns:** `(Anonymous function)`
|
||||
|
||||
___
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
|
||||
|
||||
# Functions
|
||||
|
||||
<a id="votes"></a>
|
||||
|
||||
## votes
|
||||
|
||||
▸ **votes**(api: *`ApiRx`*): `(Anonymous function)`
|
||||
|
||||
*Defined in [democracy/votes.ts:12](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api-derive/src/democracy/votes.ts#L12)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| api | `ApiRx` |
|
||||
|
||||
**Returns:** `(Anonymous function)`
|
||||
|
||||
___
|
||||
|
||||
@@ -20,7 +20,7 @@
|
||||
|
||||
▸ **decorateDerive**(api: *`ApiRx`*): [Derive](../interfaces/_index_.derive.md)
|
||||
|
||||
*Defined in [index.ts:27](https://github.com/polkadot-js/api/blob/07d6139/packages/api-derive/src/index.ts#L27)*
|
||||
*Defined in [index.ts:31](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api-derive/src/index.ts#L31)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
|
||||
|
||||
# Functions
|
||||
|
||||
<a id="eralength"></a>
|
||||
|
||||
## eraLength
|
||||
|
||||
▸ **eraLength**(api: *`ApiRx`*): `(Anonymous function)`
|
||||
|
||||
*Defined in [session/eraLength.ts:13](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api-derive/src/session/eraLength.ts#L13)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| api | `ApiRx` |
|
||||
|
||||
**Returns:** `(Anonymous function)`
|
||||
|
||||
___
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
|
||||
|
||||
# Functions
|
||||
|
||||
<a id="eraprogress"></a>
|
||||
|
||||
## eraProgress
|
||||
|
||||
▸ **eraProgress**(api: *`ApiRx`*): `(Anonymous function)`
|
||||
|
||||
*Defined in [session/eraProgress.ts:14](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api-derive/src/session/eraProgress.ts#L14)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| api | `ApiRx` |
|
||||
|
||||
**Returns:** `(Anonymous function)`
|
||||
|
||||
___
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
▸ **sessionProgress**(api: *`ApiRx`*): `(Anonymous function)`
|
||||
|
||||
*Defined in [session/sessionProgress.ts:14](https://github.com/polkadot-js/api/blob/07d6139/packages/api-derive/src/session/sessionProgress.ts#L14)*
|
||||
*Defined in [session/sessionProgress.ts:14](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api-derive/src/session/sessionProgress.ts#L14)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
|
||||
|
||||
# Type aliases
|
||||
|
||||
<a id="derivedbalances"></a>
|
||||
|
||||
## DerivedBalances
|
||||
|
||||
**Ƭ DerivedBalances**: *`object`*
|
||||
|
||||
*Defined in [types.ts:7](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api-derive/src/types.ts#L7)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
___
|
||||
<a id="derivedbalancesmap"></a>
|
||||
|
||||
## DerivedBalancesMap
|
||||
|
||||
**Ƭ DerivedBalancesMap**: *`object`*
|
||||
|
||||
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api-derive/src/types.ts#L17)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
[index: `string`]: [DerivedBalances](_types_.md#derivedbalances)
|
||||
|
||||
___
|
||||
<a id="derivedreferendumvote"></a>
|
||||
|
||||
## DerivedReferendumVote
|
||||
|
||||
**Ƭ DerivedReferendumVote**: *`object`*
|
||||
|
||||
*Defined in [types.ts:21](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api-derive/src/types.ts#L21)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
___
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
▸ **cache**(fn: *`Function`*, map?: *`WeakMap`<`object`, `any`>*): `(Anonymous function)`
|
||||
|
||||
*Defined in [util/cache.ts:23](https://github.com/polkadot-js/api/blob/07d6139/packages/api-derive/src/util/cache.ts#L23)*
|
||||
*Defined in [util/cache.ts:23](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api-derive/src/util/cache.ts#L23)*
|
||||
|
||||
Create memoization for a 2-currified function.
|
||||
|
||||
|
||||
@@ -24,7 +24,7 @@
|
||||
|
||||
⊕ **new ApiBase**(provider?: *[ApiOptions](../interfaces/_types_.apioptions.md) | `ProviderInterface`*): [ApiBase](_base_.apibase.md)
|
||||
|
||||
*Defined in [Base.ts:38](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/Base.ts#L38)*
|
||||
*Defined in [Base.ts:38](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/Base.ts#L38)*
|
||||
|
||||
*__description__*: Create an instance of the class
|
||||
|
||||
@@ -58,7 +58,7 @@ ___
|
||||
|
||||
getgenesisHash(): `Hash`
|
||||
|
||||
*Defined in [Base.ts:77](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/Base.ts#L77)*
|
||||
*Defined in [Base.ts:77](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/Base.ts#L77)*
|
||||
|
||||
*__description__*: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions.
|
||||
|
||||
@@ -71,7 +71,7 @@ ___
|
||||
|
||||
gethasSubscriptions(): `boolean`
|
||||
|
||||
*Defined in [Base.ts:86](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/Base.ts#L86)*
|
||||
*Defined in [Base.ts:86](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/Base.ts#L86)*
|
||||
|
||||
*__description__*: `true` when subscriptions are supported
|
||||
|
||||
@@ -84,7 +84,7 @@ ___
|
||||
|
||||
getquery(): `S`
|
||||
|
||||
*Defined in [Base.ts:122](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/Base.ts#L122)*
|
||||
*Defined in [Base.ts:122](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/Base.ts#L122)*
|
||||
|
||||
*__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.
|
||||
|
||||
@@ -107,7 +107,7 @@ ___
|
||||
|
||||
getrpc(): `R`
|
||||
|
||||
*Defined in [Base.ts:142](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/Base.ts#L142)*
|
||||
*Defined in [Base.ts:142](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/Base.ts#L142)*
|
||||
|
||||
*__description__*: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic `api.query` and `api.tx` sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime.
|
||||
|
||||
@@ -130,7 +130,7 @@ ___
|
||||
|
||||
getruntimeMetadata(): `Metadata`
|
||||
|
||||
*Defined in [Base.ts:93](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/Base.ts#L93)*
|
||||
*Defined in [Base.ts:93](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/Base.ts#L93)*
|
||||
|
||||
*__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.
|
||||
|
||||
@@ -143,7 +143,7 @@ ___
|
||||
|
||||
getruntimeVersion(): `RuntimeVersion`
|
||||
|
||||
*Defined in [Base.ts:102](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/Base.ts#L102)*
|
||||
*Defined in [Base.ts:102](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/Base.ts#L102)*
|
||||
|
||||
*__description__*: Contains the version information for the current runtime.
|
||||
|
||||
@@ -156,7 +156,7 @@ ___
|
||||
|
||||
gettx(): `E`
|
||||
|
||||
*Defined in [Base.ts:161](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/Base.ts#L161)*
|
||||
*Defined in [Base.ts:161](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/Base.ts#L161)*
|
||||
|
||||
*__description__*: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata.
|
||||
|
||||
@@ -183,7 +183,7 @@ ___
|
||||
|
||||
▸ **on**(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this`
|
||||
|
||||
*Defined in [Base.ts:186](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/Base.ts#L186)*
|
||||
*Defined in [Base.ts:186](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/Base.ts#L186)*
|
||||
|
||||
*__description__*: Attach an eventemitter handler to listen to a specific event
|
||||
|
||||
@@ -215,7 +215,7 @@ ___
|
||||
|
||||
▸ **once**(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this`
|
||||
|
||||
*Defined in [Base.ts:211](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/Base.ts#L211)*
|
||||
*Defined in [Base.ts:211](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/Base.ts#L211)*
|
||||
|
||||
*__description__*: Attach an one-time eventemitter handler to listen to a specific event
|
||||
|
||||
|
||||
@@ -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)
|
||||
|
||||
*Defined in [promise/Combinator.ts:21](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/promise/Combinator.ts#L21)*
|
||||
*Defined in [promise/Combinator.ts:21](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/promise/Combinator.ts#L21)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -33,7 +33,7 @@ ___
|
||||
|
||||
▸ **unsubscribe**(): `void`
|
||||
|
||||
*Defined in [promise/Combinator.ts:67](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/promise/Combinator.ts#L67)*
|
||||
*Defined in [promise/Combinator.ts:67](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/promise/Combinator.ts#L67)*
|
||||
|
||||
**Returns:** `void`
|
||||
|
||||
|
||||
@@ -2062,7 +2062,7 @@
|
||||
<h2 id="constructor">constructor</h2>
|
||||
<p>⊕ <strong>new ApiPromise</strong>(options?: <em><a href="../interfaces/_types_.apioptions.md">ApiOptions</a> | <code>ProviderInterface</code></em>): <a href="_promise_index_.apipromise.html">ApiPromise</a></p>
|
||||
<p><em>Overrides <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#constructor">constructor</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/promise/index.ts#L135" target="_blank">promise/index.ts:135</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/promise/index.ts#L135" target="_blank">promise/index.ts:135</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Creates an instance of the ApiPromise class</p>
|
||||
<p><em><strong>example</strong></em>: </p>
|
||||
<pre><code class="lang-javascript"><div class="sunlight-container sunlight-theme-gitbook"><div class="sunlight-code-container"><pre class="sunlight-highlight-javascript sunlight-highlighted"><span class="sunlight-javascript"><span class="sunlight-reservedWord">import</span> <span class="sunlight-ident">Api</span> <span class="sunlight-ident">from</span> <span class="sunlight-string">'@polkadot/api/promise'</span><span class="sunlight-punctuation">;</span>
|
||||
@@ -2098,7 +2098,7 @@
|
||||
<h2 id="genesishash">genesisHash</h2>
|
||||
<p>getgenesisHash(): <code>Hash</code></p>
|
||||
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#genesishash">genesisHash</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/Base.ts#L77" target="_blank">Base.ts:77</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/Base.ts#L77" target="_blank">Base.ts:77</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions.</p>
|
||||
<p><strong>Returns:</strong> <code>Hash</code></p>
|
||||
<hr>
|
||||
@@ -2106,14 +2106,14 @@
|
||||
<h2 id="hassubscriptions">hasSubscriptions</h2>
|
||||
<p>gethasSubscriptions(): <code>boolean</code></p>
|
||||
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#hassubscriptions">hasSubscriptions</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/Base.ts#L86" target="_blank">Base.ts:86</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/Base.ts#L86" target="_blank">Base.ts:86</a></em></p>
|
||||
<p><em><strong>description</strong></em>: <code>true</code> when subscriptions are supported</p>
|
||||
<p><strong>Returns:</strong> <code>boolean</code></p>
|
||||
<hr>
|
||||
<p><a id="isready"></a></p>
|
||||
<h2 id="isready">isReady</h2>
|
||||
<p>getisReady(): <code>Promise</code><<a href="_promise_index_.apipromise.html">ApiPromise</a>></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/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/2a2df9a/packages/api/src/promise/index.ts#L170" target="_blank">promise/index.ts:170</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Promise that returns the first time we are connected and loaded</p>
|
||||
<p><strong>Returns:</strong> <code>Promise</code><<a href="_promise_index_.apipromise.html">ApiPromise</a>></p>
|
||||
<hr>
|
||||
@@ -2121,7 +2121,7 @@
|
||||
<h2 id="query">query</h2>
|
||||
<p>getquery(): <a href="../interfaces/_promise_types_.queryablestorage.md">QueryableStorage</a></p>
|
||||
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#query">query</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/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/2a2df9a/packages/api/src/Base.ts#L122" target="_blank">Base.ts:122</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.</p>
|
||||
<p>All calls inside the namespace, is denoted by <code>section</code>.<code>method</code> and may take an optional query parameter. As an example, <code>api.query.timestamp.now()</code> (current block timestamp) does not take parameters, while <code>api.query.system.accountNonce(<accountId>)</code> (retrieving the associated nonce for an account), takes the <code>AccountId</code> as a parameter.</p>
|
||||
<p><em><strong>example</strong></em>: </p>
|
||||
@@ -2135,7 +2135,7 @@
|
||||
<h2 id="rpc">rpc</h2>
|
||||
<p>getrpc(): <a href="../interfaces/_promise_types_.decoratedrpc.md">DecoratedRpc</a></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/07d6139/packages/api/src/Base.ts#L142" target="_blank">Base.ts:142</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/Base.ts#L142" target="_blank">Base.ts:142</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic <code>api.query</code> and <code>api.tx</code> sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime.</p>
|
||||
<p>RPC endpoints available here allow for the query of chain, node and system information, in addition to providing interfaces for the raw queries of state (usine known keys) and the submission of transactions.</p>
|
||||
<p><em><strong>example</strong></em>: </p>
|
||||
@@ -2149,7 +2149,7 @@
|
||||
<h2 id="runtimemetadata">runtimeMetadata</h2>
|
||||
<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>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/Base.ts#L93" target="_blank">Base.ts:93</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/Base.ts#L93" target="_blank">Base.ts:93</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.</p>
|
||||
<p><strong>Returns:</strong> <code>Metadata</code></p>
|
||||
<hr>
|
||||
@@ -2157,7 +2157,7 @@
|
||||
<h2 id="runtimeversion">runtimeVersion</h2>
|
||||
<p>getruntimeVersion(): <code>RuntimeVersion</code></p>
|
||||
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#runtimeversion">runtimeVersion</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/Base.ts#L102" target="_blank">Base.ts:102</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/Base.ts#L102" target="_blank">Base.ts:102</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Contains the version information for the current runtime.</p>
|
||||
<p><strong>Returns:</strong> <code>RuntimeVersion</code></p>
|
||||
<hr>
|
||||
@@ -2165,7 +2165,7 @@
|
||||
<h2 id="tx">tx</h2>
|
||||
<p>gettx(): <a href="../interfaces/_promise_types_.submittableextrinsics.md">SubmittableExtrinsics</a></p>
|
||||
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#tx">tx</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/Base.ts#L161" target="_blank">Base.ts:161</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/Base.ts#L161" target="_blank">Base.ts:161</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata.</p>
|
||||
<p><em><strong>example</strong></em>: </p>
|
||||
<pre><code class="lang-javascript"><div class="sunlight-container sunlight-theme-gitbook"><div class="sunlight-code-container"><pre class="sunlight-highlight-javascript sunlight-highlighted"><span class="sunlight-javascript"><span class="sunlight-ident">api</span><span class="sunlight-operator">.</span><span class="sunlight-ident">tx</span><span class="sunlight-operator">.</span><span class="sunlight-ident">balances</span>
|
||||
@@ -2181,7 +2181,7 @@
|
||||
<p><a id="combinelatest"></a></p>
|
||||
<h2 id="combinelatest">combineLatest</h2>
|
||||
<p>▸ <strong>combineLatest</strong>(fns: <em><code>Array</code><<a href="../modules/_promise_combinator_.md#combinatorfunction">CombinatorFunction</a> | [<a href="../modules/_promise_combinator_.md#combinatorfunction">CombinatorFunction</a>, <code>Array</code>]></em>, callback: <em><a href="../modules/_promise_combinator_.md#combinatorcallback">CombinatorCallback</a></em>): <a href="../modules/_promise_types_.md#unsubfunction">UnsubFunction</a></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/promise/index.ts#L232" target="_blank">promise/index.ts:232</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/promise/index.ts#L232" target="_blank">promise/index.ts:232</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Creates a combinator that can be used to combine the latest results from multiple subscriptions</p>
|
||||
<p><em><strong>example</strong></em>: </p>
|
||||
<pre><code class="lang-javascript"><div class="sunlight-container sunlight-theme-gitbook"><div class="sunlight-code-container"><pre class="sunlight-highlight-javascript sunlight-highlighted"><span class="sunlight-javascript"><span class="sunlight-reservedWord">const</span> <span class="sunlight-ident">address</span> <span class="sunlight-operator">=</span> <span class="sunlight-string">'5DTestUPts3kjeXSTMyerHihn1uwMfLj8vU8sqF7qYrFacT7'</span><span class="sunlight-punctuation">;</span>
|
||||
@@ -2224,7 +2224,7 @@
|
||||
<h2 id="on">on</h2>
|
||||
<p>▸ <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>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/Base.ts#L186" target="_blank">Base.ts:186</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/Base.ts#L186" target="_blank">Base.ts:186</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Attach an eventemitter handler to listen to a specific event</p>
|
||||
<p><em><strong>example</strong></em>: </p>
|
||||
<pre><code class="lang-javascript"><div class="sunlight-container sunlight-theme-gitbook"><div class="sunlight-code-container"><pre class="sunlight-highlight-javascript sunlight-highlighted"><span class="sunlight-javascript"><span class="sunlight-ident">api</span><span class="sunlight-operator">.</span><span class="sunlight-ident">on</span><span class="sunlight-punctuation">(</span><span class="sunlight-string">'connected'</span><span class="sunlight-punctuation">,</span> <span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">)</span> <span class="sunlight-operator">=</span><span class="sunlight-operator">></span> <span class="sunlight-punctuation">{</span>
|
||||
@@ -2263,7 +2263,7 @@
|
||||
<h2 id="once">once</h2>
|
||||
<p>▸ <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>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/Base.ts#L211" target="_blank">Base.ts:211</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/Base.ts#L211" target="_blank">Base.ts:211</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>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">'connected'</span><span class="sunlight-punctuation">,</span> <span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">)</span> <span class="sunlight-operator">=</span><span class="sunlight-operator">></span> <span class="sunlight-punctuation">{</span>
|
||||
@@ -2301,7 +2301,7 @@
|
||||
<p><a id="create"></a></p>
|
||||
<h2 id="static-create"><code><Static></code> create</h2>
|
||||
<p>▸ <strong>create</strong>(options?: <em><a href="../interfaces/_types_.apioptions.md">ApiOptions</a> | <code>ProviderInterface</code></em>): <code>Promise</code><<a href="_promise_index_.apipromise.html">ApiPromise</a>></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/promise/index.ts#L133" target="_blank">promise/index.ts:133</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/promise/index.ts#L133" target="_blank">promise/index.ts:133</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Creates an ApiPromise instance using the supplied provider. Returns an Promise containing the actual Api instance.</p>
|
||||
<p><em><strong>example</strong></em>: </p>
|
||||
<pre><code class="lang-javascript"><div class="sunlight-container sunlight-theme-gitbook"><div class="sunlight-code-container"><pre class="sunlight-highlight-javascript sunlight-highlighted"><span class="sunlight-javascript"><span class="sunlight-reservedWord">import</span> <span class="sunlight-ident">Api</span> <span class="sunlight-ident">from</span> <span class="sunlight-string">'@polkadot/api/promise'</span><span class="sunlight-punctuation">;</span>
|
||||
@@ -2377,7 +2377,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"ApiPromise","level":"1.2.1","depth":2,"next":{"title":"ApiRx","level":"1.2.2","depth":2,"path":"api/classes/_rx_index_.apirx.md","ref":"api/classes/_rx_index_.apirx.md","articles":[]},"previous":{"title":"api","level":"1.2","depth":1,"path":"api/README.md","ref":"api/README.md","articles":[{"title":"ApiPromise","level":"1.2.1","depth":2,"path":"api/classes/_promise_index_.apipromise.md","ref":"api/classes/_promise_index_.apipromise.md","articles":[]},{"title":"ApiRx","level":"1.2.2","depth":2,"path":"api/classes/_rx_index_.apirx.md","ref":"api/classes/_rx_index_.apirx.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"api/classes/_promise_index_.apipromise.md","mtime":"2019-01-10T10:41:09.515Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-10T10:42:38.095Z"},"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-01-10T16:42:41.535Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-10T16:44:09.217Z"},"basePath":"../..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -106,7 +106,7 @@ ApiPromise.create().then((api) => {
|
||||
|
||||
*Overrides [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
|
||||
|
||||
*Defined in [promise/index.ts:135](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/promise/index.ts#L135)*
|
||||
*Defined in [promise/index.ts:135](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/promise/index.ts#L135)*
|
||||
|
||||
*__description__*: Creates an instance of the ApiPromise class
|
||||
|
||||
@@ -142,7 +142,7 @@ getgenesisHash(): `Hash`
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)*
|
||||
|
||||
*Defined in [Base.ts:77](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/Base.ts#L77)*
|
||||
*Defined in [Base.ts:77](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/Base.ts#L77)*
|
||||
|
||||
*__description__*: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions.
|
||||
|
||||
@@ -157,7 +157,7 @@ gethasSubscriptions(): `boolean`
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[hasSubscriptions](_base_.apibase.md#hassubscriptions)*
|
||||
|
||||
*Defined in [Base.ts:86](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/Base.ts#L86)*
|
||||
*Defined in [Base.ts:86](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/Base.ts#L86)*
|
||||
|
||||
*__description__*: `true` when subscriptions are supported
|
||||
|
||||
@@ -170,7 +170,7 @@ ___
|
||||
|
||||
getisReady(): `Promise`<[ApiPromise](_promise_index_.apipromise.md)>
|
||||
|
||||
*Defined in [promise/index.ts:170](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/promise/index.ts#L170)*
|
||||
*Defined in [promise/index.ts:170](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/promise/index.ts#L170)*
|
||||
|
||||
*__description__*: Promise that returns the first time we are connected and loaded
|
||||
|
||||
@@ -185,7 +185,7 @@ getquery(): [QueryableStorage](../interfaces/_promise_types_.queryablestorage.md
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[query](_base_.apibase.md#query)*
|
||||
|
||||
*Defined in [Base.ts:122](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/Base.ts#L122)*
|
||||
*Defined in [Base.ts:122](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/Base.ts#L122)*
|
||||
|
||||
*__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.
|
||||
|
||||
@@ -210,7 +210,7 @@ getrpc(): [DecoratedRpc](../interfaces/_promise_types_.decoratedrpc.md)
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[rpc](_base_.apibase.md#rpc)*
|
||||
|
||||
*Defined in [Base.ts:142](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/Base.ts#L142)*
|
||||
*Defined in [Base.ts:142](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/Base.ts#L142)*
|
||||
|
||||
*__description__*: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic `api.query` and `api.tx` sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime.
|
||||
|
||||
@@ -235,7 +235,7 @@ getruntimeMetadata(): `Metadata`
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[runtimeMetadata](_base_.apibase.md#runtimemetadata)*
|
||||
|
||||
*Defined in [Base.ts:93](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/Base.ts#L93)*
|
||||
*Defined in [Base.ts:93](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/Base.ts#L93)*
|
||||
|
||||
*__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.
|
||||
|
||||
@@ -250,7 +250,7 @@ getruntimeVersion(): `RuntimeVersion`
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[runtimeVersion](_base_.apibase.md#runtimeversion)*
|
||||
|
||||
*Defined in [Base.ts:102](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/Base.ts#L102)*
|
||||
*Defined in [Base.ts:102](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/Base.ts#L102)*
|
||||
|
||||
*__description__*: Contains the version information for the current runtime.
|
||||
|
||||
@@ -265,7 +265,7 @@ gettx(): [SubmittableExtrinsics](../interfaces/_promise_types_.submittableextrin
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[tx](_base_.apibase.md#tx)*
|
||||
|
||||
*Defined in [Base.ts:161](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/Base.ts#L161)*
|
||||
*Defined in [Base.ts:161](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/Base.ts#L161)*
|
||||
|
||||
*__description__*: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata.
|
||||
|
||||
@@ -292,7 +292,7 @@ ___
|
||||
|
||||
▸ **combineLatest**(fns: *`Array`<[CombinatorFunction](../modules/_promise_combinator_.md#combinatorfunction) | [[CombinatorFunction](../modules/_promise_combinator_.md#combinatorfunction), `Array`]>*, callback: *[CombinatorCallback](../modules/_promise_combinator_.md#combinatorcallback)*): [UnsubFunction](../modules/_promise_types_.md#unsubfunction)
|
||||
|
||||
*Defined in [promise/index.ts:232](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/promise/index.ts#L232)*
|
||||
*Defined in [promise/index.ts:232](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/promise/index.ts#L232)*
|
||||
|
||||
*__description__*: Creates a combinator that can be used to combine the latest results from multiple subscriptions
|
||||
|
||||
@@ -329,7 +329,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[on](_base_.apibase.md#on)*
|
||||
|
||||
*Defined in [Base.ts:186](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/Base.ts#L186)*
|
||||
*Defined in [Base.ts:186](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/Base.ts#L186)*
|
||||
|
||||
*__description__*: Attach an eventemitter handler to listen to a specific event
|
||||
|
||||
@@ -363,7 +363,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[once](_base_.apibase.md#once)*
|
||||
|
||||
*Defined in [Base.ts:211](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/Base.ts#L211)*
|
||||
*Defined in [Base.ts:211](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/Base.ts#L211)*
|
||||
|
||||
*__description__*: Attach an one-time eventemitter handler to listen to a specific event
|
||||
|
||||
@@ -395,7 +395,7 @@ ___
|
||||
|
||||
▸ **create**(options?: *[ApiOptions](../interfaces/_types_.apioptions.md) | `ProviderInterface`*): `Promise`<[ApiPromise](_promise_index_.apipromise.md)>
|
||||
|
||||
*Defined in [promise/index.ts:133](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/promise/index.ts#L133)*
|
||||
*Defined in [promise/index.ts:133](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/promise/index.ts#L133)*
|
||||
|
||||
*__description__*: Creates an ApiPromise instance using the supplied provider. Returns an Promise containing the actual Api instance.
|
||||
|
||||
|
||||
@@ -25,7 +25,7 @@
|
||||
|
||||
*Overrides Extrinsic.__constructor*
|
||||
|
||||
*Defined in [promise/SubmittableExtrinsic.ts:15](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/promise/SubmittableExtrinsic.ts#L15)*
|
||||
*Defined in [promise/SubmittableExtrinsic.ts:15](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/promise/SubmittableExtrinsic.ts#L15)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -73,7 +73,7 @@ getType(): `E`
|
||||
|
||||
*Inherited from Struct.Type*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/07d6139/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/2a2df9a/packages/types/src/codec/Struct.ts#L142)*
|
||||
|
||||
*__description__*: Returns the Type description to sthe structure
|
||||
|
||||
@@ -88,7 +88,7 @@ getargs(): `Array`<`Codec`>
|
||||
|
||||
*Inherited from Extrinsic.args*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:71](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/Extrinsic.ts#L71)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:71](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/Extrinsic.ts#L71)*
|
||||
|
||||
*__description__*: The arguments passed to for the call, exposes args so it is compatible with \[\[Method\]\]
|
||||
|
||||
@@ -103,7 +103,7 @@ getcallIndex(): `Uint8Array`
|
||||
|
||||
*Inherited from Extrinsic.callIndex*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:78](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/Extrinsic.ts#L78)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:78](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/Extrinsic.ts#L78)*
|
||||
|
||||
*__description__*: The actual `[sectionIndex, methodIndex]` as used in the Method
|
||||
|
||||
@@ -118,7 +118,7 @@ getdata(): `Uint8Array`
|
||||
|
||||
*Inherited from Extrinsic.data*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:85](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/Extrinsic.ts#L85)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:85](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/Extrinsic.ts#L85)*
|
||||
|
||||
*__description__*: The actual data for the Method
|
||||
|
||||
@@ -135,7 +135,7 @@ getencodedLength(): `number`
|
||||
|
||||
*Overrides Struct.encodedLength*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:92](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/Extrinsic.ts#L92)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:92](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/Extrinsic.ts#L92)*
|
||||
|
||||
*__description__*: The length of the value when encoded as a Uint8Array
|
||||
|
||||
@@ -150,7 +150,7 @@ gethash(): `Hash`
|
||||
|
||||
*Inherited from Extrinsic.hash*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:101](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/Extrinsic.ts#L101)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:101](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/Extrinsic.ts#L101)*
|
||||
|
||||
*__description__*: Convernience function, encodes the extrinsic and returns the actual hash
|
||||
|
||||
@@ -165,7 +165,7 @@ getisSigned(): `boolean`
|
||||
|
||||
*Inherited from Extrinsic.isSigned*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:110](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/Extrinsic.ts#L110)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:110](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/Extrinsic.ts#L110)*
|
||||
|
||||
*__description__*: `true` id the extrinsic is signed
|
||||
|
||||
@@ -180,7 +180,7 @@ getlength(): `number`
|
||||
|
||||
*Inherited from Extrinsic.length*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:117](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/Extrinsic.ts#L117)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:117](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/Extrinsic.ts#L117)*
|
||||
|
||||
*__description__*: The length of the encoded value
|
||||
|
||||
@@ -195,7 +195,7 @@ getmeta(): `FunctionMetadata`
|
||||
|
||||
*Inherited from Extrinsic.meta*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:124](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/Extrinsic.ts#L124)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:124](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/Extrinsic.ts#L124)*
|
||||
|
||||
*__description__*: The \[\[FunctionMetadata\]\] that describes the extrinsic
|
||||
|
||||
@@ -210,7 +210,7 @@ getmethod(): `Method`
|
||||
|
||||
*Inherited from Extrinsic.method*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:131](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/Extrinsic.ts#L131)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:131](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/Extrinsic.ts#L131)*
|
||||
|
||||
*__description__*: The \[\[Method\]\] this extrinsic wraps
|
||||
|
||||
@@ -225,7 +225,7 @@ getsignature(): `ExtrinsicSignature`
|
||||
|
||||
*Inherited from Extrinsic.signature*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:138](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/Extrinsic.ts#L138)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:138](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/Extrinsic.ts#L138)*
|
||||
|
||||
*__description__*: The \[\[ExtrinsicSignature\]\]
|
||||
|
||||
@@ -258,7 +258,7 @@ ___
|
||||
|
||||
*Inherited from Extrinsic.addSignature*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:145](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/Extrinsic.ts#L145)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:145](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/Extrinsic.ts#L145)*
|
||||
|
||||
*__description__*: Add an \[\[ExtrinsicSignature\]\] to the extrinsic (already generated)
|
||||
|
||||
@@ -351,7 +351,7 @@ ___
|
||||
|
||||
*Overrides Map.get*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/codec/Struct.ts#L159)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/codec/Struct.ts#L159)*
|
||||
|
||||
*__description__*: Returns a specific names entry in the structure
|
||||
|
||||
@@ -372,7 +372,7 @@ ___
|
||||
|
||||
*Inherited from Struct.getAtIndex*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/07d6139/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/2a2df9a/packages/types/src/codec/Struct.ts#L166)*
|
||||
|
||||
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
|
||||
|
||||
@@ -425,7 +425,7 @@ ___
|
||||
|
||||
▸ **send**(statusCb?: *`undefined` | `function`*): `Promise`<`Hash`> | [UnsubFunction](../modules/_promise_types_.md#unsubfunction)
|
||||
|
||||
*Defined in [promise/SubmittableExtrinsic.ts:44](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/promise/SubmittableExtrinsic.ts#L44)*
|
||||
*Defined in [promise/SubmittableExtrinsic.ts:44](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/promise/SubmittableExtrinsic.ts#L44)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -464,7 +464,7 @@ ___
|
||||
|
||||
*Overrides Extrinsic.sign*
|
||||
|
||||
*Defined in [promise/SubmittableExtrinsic.ts:52](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/promise/SubmittableExtrinsic.ts#L52)*
|
||||
*Defined in [promise/SubmittableExtrinsic.ts:52](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/promise/SubmittableExtrinsic.ts#L52)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -485,7 +485,7 @@ ___
|
||||
|
||||
*Inherited from Struct.toArray*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/07d6139/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/2a2df9a/packages/types/src/codec/Struct.ts#L173)*
|
||||
|
||||
*__description__*: Converts the Object to an standard JavaScript Array
|
||||
|
||||
@@ -502,7 +502,7 @@ ___
|
||||
|
||||
*Overrides Struct.toHex*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:163](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/Extrinsic.ts#L163)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:163](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/Extrinsic.ts#L163)*
|
||||
|
||||
*__description__*: Returns a hex string representation of the value
|
||||
|
||||
@@ -519,7 +519,7 @@ ___
|
||||
|
||||
*Overrides Struct.toJSON*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:170](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/Extrinsic.ts#L170)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:170](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/Extrinsic.ts#L170)*
|
||||
|
||||
*__description__*: Converts the Object to JSON, typically used for RPC transfers
|
||||
|
||||
@@ -534,7 +534,7 @@ ___
|
||||
|
||||
*Inherited from Struct.toString*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/codec/Struct.ts#L201)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/codec/Struct.ts#L201)*
|
||||
|
||||
*__description__*: Returns the string representation of the value
|
||||
|
||||
@@ -551,7 +551,7 @@ ___
|
||||
|
||||
*Overrides Struct.toU8a*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:178](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/Extrinsic.ts#L178)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:178](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/Extrinsic.ts#L178)*
|
||||
|
||||
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
|
||||
|
||||
@@ -587,7 +587,7 @@ ___
|
||||
|
||||
*Inherited from Extrinsic.decodeExtrinsic*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:44](https://github.com/polkadot-js/api/blob/07d6139/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/2a2df9a/packages/types/src/Extrinsic.ts#L44)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -606,7 +606,7 @@ ___
|
||||
|
||||
*Inherited from Struct.with*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/07d6139/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/2a2df9a/packages/types/src/codec/Struct.ts#L122)*
|
||||
|
||||
**Type parameters:**
|
||||
|
||||
|
||||
@@ -2073,7 +2073,7 @@
|
||||
<h2 id="constructor">constructor</h2>
|
||||
<p>⊕ <strong>new ApiRx</strong>(options?: <em><a href="../interfaces/_types_.apioptions.md">ApiOptions</a> | <code>ProviderInterface</code></em>): <a href="_rx_index_.apirx.html">ApiRx</a></p>
|
||||
<p><em>Overrides <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#constructor">constructor</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/rx/index.ts#L145" target="_blank">rx/index.ts:145</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/rx/index.ts#L145" target="_blank">rx/index.ts:145</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Create an instance of the ApiRx class</p>
|
||||
<p><em><strong>example</strong></em>: </p>
|
||||
<pre><code class="lang-javascript"><div class="sunlight-container sunlight-theme-gitbook"><div class="sunlight-code-container"><pre class="sunlight-highlight-javascript sunlight-highlighted"><span class="sunlight-javascript"><span class="sunlight-reservedWord">import</span> <span class="sunlight-ident">Api</span> <span class="sunlight-ident">from</span> <span class="sunlight-string">'@polkadot/api/rx'</span><span class="sunlight-punctuation">;</span>
|
||||
@@ -2108,14 +2108,14 @@
|
||||
<p><a id="derive"></a></p>
|
||||
<h2 id="derive">derive</h2>
|
||||
<p>getderive(): <code>Derive</code></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/rx/index.ts#L181" target="_blank">rx/index.ts:181</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/rx/index.ts#L181" target="_blank">rx/index.ts:181</a></em></p>
|
||||
<p><strong>Returns:</strong> <code>Derive</code></p>
|
||||
<hr>
|
||||
<p><a id="genesishash"></a></p>
|
||||
<h2 id="genesishash">genesisHash</h2>
|
||||
<p>getgenesisHash(): <code>Hash</code></p>
|
||||
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#genesishash">genesisHash</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/Base.ts#L77" target="_blank">Base.ts:77</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/Base.ts#L77" target="_blank">Base.ts:77</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions.</p>
|
||||
<p><strong>Returns:</strong> <code>Hash</code></p>
|
||||
<hr>
|
||||
@@ -2123,21 +2123,21 @@
|
||||
<h2 id="hassubscriptions">hasSubscriptions</h2>
|
||||
<p>gethasSubscriptions(): <code>boolean</code></p>
|
||||
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#hassubscriptions">hasSubscriptions</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/Base.ts#L86" target="_blank">Base.ts:86</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/Base.ts#L86" target="_blank">Base.ts:86</a></em></p>
|
||||
<p><em><strong>description</strong></em>: <code>true</code> when subscriptions are supported</p>
|
||||
<p><strong>Returns:</strong> <code>boolean</code></p>
|
||||
<hr>
|
||||
<p><a id="isconnected"></a></p>
|
||||
<h2 id="isconnected">isConnected</h2>
|
||||
<p>getisConnected(): <code>Observable</code><<code>boolean</code>></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/rx/index.ts#L188" target="_blank">rx/index.ts:188</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/rx/index.ts#L188" target="_blank">rx/index.ts:188</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Observable that carries the connected state for the provider. Results in a boolean flag that is true/false based on the connectivity.</p>
|
||||
<p><strong>Returns:</strong> <code>Observable</code><<code>boolean</code>></p>
|
||||
<hr>
|
||||
<p><a id="isready"></a></p>
|
||||
<h2 id="isready">isReady</h2>
|
||||
<p>getisReady(): <code>Observable</code><<a href="_rx_index_.apirx.html">ApiRx</a>></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/rx/index.ts#L195" target="_blank">rx/index.ts:195</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/rx/index.ts#L195" target="_blank">rx/index.ts:195</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Observable that returns the first time we are connected and loaded</p>
|
||||
<p><strong>Returns:</strong> <code>Observable</code><<a href="_rx_index_.apirx.html">ApiRx</a>></p>
|
||||
<hr>
|
||||
@@ -2145,7 +2145,7 @@
|
||||
<h2 id="query">query</h2>
|
||||
<p>getquery(): <a href="../interfaces/_rx_types_.queryablestorage.md">QueryableStorage</a></p>
|
||||
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#query">query</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/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/2a2df9a/packages/api/src/Base.ts#L122" target="_blank">Base.ts:122</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.</p>
|
||||
<p>All calls inside the namespace, is denoted by <code>section</code>.<code>method</code> and may take an optional query parameter. As an example, <code>api.query.timestamp.now()</code> (current block timestamp) does not take parameters, while <code>api.query.system.accountNonce(<accountId>)</code> (retrieving the associated nonce for an account), takes the <code>AccountId</code> as a parameter.</p>
|
||||
<p><em><strong>example</strong></em>: </p>
|
||||
@@ -2159,7 +2159,7 @@
|
||||
<h2 id="rpc">rpc</h2>
|
||||
<p>getrpc(): <code>RpcRx</code></p>
|
||||
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#rpc">rpc</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/Base.ts#L142" target="_blank">Base.ts:142</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/Base.ts#L142" target="_blank">Base.ts:142</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic <code>api.query</code> and <code>api.tx</code> sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime.</p>
|
||||
<p>RPC endpoints available here allow for the query of chain, node and system information, in addition to providing interfaces for the raw queries of state (usine known keys) and the submission of transactions.</p>
|
||||
<p><em><strong>example</strong></em>: </p>
|
||||
@@ -2173,7 +2173,7 @@
|
||||
<h2 id="runtimemetadata">runtimeMetadata</h2>
|
||||
<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>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/Base.ts#L93" target="_blank">Base.ts:93</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/Base.ts#L93" target="_blank">Base.ts:93</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.</p>
|
||||
<p><strong>Returns:</strong> <code>Metadata</code></p>
|
||||
<hr>
|
||||
@@ -2181,7 +2181,7 @@
|
||||
<h2 id="runtimeversion">runtimeVersion</h2>
|
||||
<p>getruntimeVersion(): <code>RuntimeVersion</code></p>
|
||||
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#runtimeversion">runtimeVersion</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/Base.ts#L102" target="_blank">Base.ts:102</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/Base.ts#L102" target="_blank">Base.ts:102</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Contains the version information for the current runtime.</p>
|
||||
<p><strong>Returns:</strong> <code>RuntimeVersion</code></p>
|
||||
<hr>
|
||||
@@ -2189,7 +2189,7 @@
|
||||
<h2 id="tx">tx</h2>
|
||||
<p>gettx(): <a href="../interfaces/_rx_types_.submittableextrinsics.md">SubmittableExtrinsics</a></p>
|
||||
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#tx">tx</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/Base.ts#L161" target="_blank">Base.ts:161</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/Base.ts#L161" target="_blank">Base.ts:161</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata.</p>
|
||||
<p><em><strong>example</strong></em>: </p>
|
||||
<pre><code class="lang-javascript"><div class="sunlight-container sunlight-theme-gitbook"><div class="sunlight-code-container"><pre class="sunlight-highlight-javascript sunlight-highlighted"><span class="sunlight-javascript"><span class="sunlight-ident">api</span><span class="sunlight-operator">.</span><span class="sunlight-ident">tx</span><span class="sunlight-operator">.</span><span class="sunlight-ident">balances</span>
|
||||
@@ -2206,7 +2206,7 @@
|
||||
<h2 id="on">on</h2>
|
||||
<p>▸ <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>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/Base.ts#L186" target="_blank">Base.ts:186</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/Base.ts#L186" target="_blank">Base.ts:186</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Attach an eventemitter handler to listen to a specific event</p>
|
||||
<p><em><strong>example</strong></em>: </p>
|
||||
<pre><code class="lang-javascript"><div class="sunlight-container sunlight-theme-gitbook"><div class="sunlight-code-container"><pre class="sunlight-highlight-javascript sunlight-highlighted"><span class="sunlight-javascript"><span class="sunlight-ident">api</span><span class="sunlight-operator">.</span><span class="sunlight-ident">on</span><span class="sunlight-punctuation">(</span><span class="sunlight-string">'connected'</span><span class="sunlight-punctuation">,</span> <span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">)</span> <span class="sunlight-operator">=</span><span class="sunlight-operator">></span> <span class="sunlight-punctuation">{</span>
|
||||
@@ -2245,7 +2245,7 @@
|
||||
<h2 id="once">once</h2>
|
||||
<p>▸ <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>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/Base.ts#L211" target="_blank">Base.ts:211</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/Base.ts#L211" target="_blank">Base.ts:211</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>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">'connected'</span><span class="sunlight-punctuation">,</span> <span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">)</span> <span class="sunlight-operator">=</span><span class="sunlight-operator">></span> <span class="sunlight-punctuation">{</span>
|
||||
@@ -2283,7 +2283,7 @@
|
||||
<p><a id="create"></a></p>
|
||||
<h2 id="static-create"><code><Static></code> create</h2>
|
||||
<p>▸ <strong>create</strong>(options?: <em><a href="../interfaces/_types_.apioptions.md">ApiOptions</a> | <code>ProviderInterface</code></em>): <code>Observable</code><<a href="_rx_index_.apirx.html">ApiRx</a>></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/rx/index.ts#L143" target="_blank">rx/index.ts:143</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/rx/index.ts#L143" target="_blank">rx/index.ts:143</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Creates an ApiRx instance using the supplied provider. Returns an Observable containing the actual Api instance.</p>
|
||||
<p><em><strong>example</strong></em>: </p>
|
||||
<pre><code class="lang-javascript"><div class="sunlight-container sunlight-theme-gitbook"><div class="sunlight-code-container"><pre class="sunlight-highlight-javascript sunlight-highlighted"><span class="sunlight-javascript"><span class="sunlight-reservedWord">import</span> <span class="sunlight-ident">Api</span> <span class="sunlight-ident">from</span> <span class="sunlight-string">'@polkadot/api/rx'</span><span class="sunlight-punctuation">;</span>
|
||||
@@ -2357,7 +2357,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"ApiRx","level":"1.2.2","depth":2,"next":{"title":"rpc-provider","level":"1.3","depth":1,"path":"rpc-provider/README.md","ref":"rpc-provider/README.md","articles":[{"title":"HttpProvider","level":"1.3.1","depth":2,"path":"rpc-provider/classes/_http_index_.httpprovider.md","ref":"rpc-provider/classes/_http_index_.httpprovider.md","articles":[]},{"title":"WsProvider","level":"1.3.2","depth":2,"path":"rpc-provider/classes/_ws_index_.wsprovider.md","ref":"rpc-provider/classes/_ws_index_.wsprovider.md","articles":[]}]},"previous":{"title":"ApiPromise","level":"1.2.1","depth":2,"path":"api/classes/_promise_index_.apipromise.md","ref":"api/classes/_promise_index_.apipromise.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"api/classes/_rx_index_.apirx.md","mtime":"2019-01-10T10:41:09.727Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-10T10:42:38.095Z"},"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-01-10T16:42:41.727Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-10T16:44:09.217Z"},"basePath":"../..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -117,7 +117,7 @@ api.query.system
|
||||
|
||||
*Overrides [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
|
||||
|
||||
*Defined in [rx/index.ts:145](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/rx/index.ts#L145)*
|
||||
*Defined in [rx/index.ts:145](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/rx/index.ts#L145)*
|
||||
|
||||
*__description__*: Create an instance of the ApiRx class
|
||||
|
||||
@@ -151,7 +151,7 @@ ___
|
||||
|
||||
getderive(): `Derive`
|
||||
|
||||
*Defined in [rx/index.ts:181](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/rx/index.ts#L181)*
|
||||
*Defined in [rx/index.ts:181](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/rx/index.ts#L181)*
|
||||
|
||||
**Returns:** `Derive`
|
||||
|
||||
@@ -164,7 +164,7 @@ getgenesisHash(): `Hash`
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)*
|
||||
|
||||
*Defined in [Base.ts:77](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/Base.ts#L77)*
|
||||
*Defined in [Base.ts:77](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/Base.ts#L77)*
|
||||
|
||||
*__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.
|
||||
|
||||
@@ -179,7 +179,7 @@ gethasSubscriptions(): `boolean`
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[hasSubscriptions](_base_.apibase.md#hassubscriptions)*
|
||||
|
||||
*Defined in [Base.ts:86](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/Base.ts#L86)*
|
||||
*Defined in [Base.ts:86](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/Base.ts#L86)*
|
||||
|
||||
*__description__*: `true` when subscriptions are supported
|
||||
|
||||
@@ -192,7 +192,7 @@ ___
|
||||
|
||||
getisConnected(): `Observable`<`boolean`>
|
||||
|
||||
*Defined in [rx/index.ts:188](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/rx/index.ts#L188)*
|
||||
*Defined in [rx/index.ts:188](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/rx/index.ts#L188)*
|
||||
|
||||
*__description__*: Observable that carries the connected state for the provider. Results in a boolean flag that is true/false based on the connectivity.
|
||||
|
||||
@@ -205,7 +205,7 @@ ___
|
||||
|
||||
getisReady(): `Observable`<[ApiRx](_rx_index_.apirx.md)>
|
||||
|
||||
*Defined in [rx/index.ts:195](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/rx/index.ts#L195)*
|
||||
*Defined in [rx/index.ts:195](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/rx/index.ts#L195)*
|
||||
|
||||
*__description__*: Observable that returns the first time we are connected and loaded
|
||||
|
||||
@@ -220,7 +220,7 @@ getquery(): [QueryableStorage](../interfaces/_rx_types_.queryablestorage.md)
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[query](_base_.apibase.md#query)*
|
||||
|
||||
*Defined in [Base.ts:122](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/Base.ts#L122)*
|
||||
*Defined in [Base.ts:122](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/Base.ts#L122)*
|
||||
|
||||
*__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.
|
||||
|
||||
@@ -245,7 +245,7 @@ getrpc(): `RpcRx`
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[rpc](_base_.apibase.md#rpc)*
|
||||
|
||||
*Defined in [Base.ts:142](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/Base.ts#L142)*
|
||||
*Defined in [Base.ts:142](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/Base.ts#L142)*
|
||||
|
||||
*__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.
|
||||
|
||||
@@ -270,7 +270,7 @@ getruntimeMetadata(): `Metadata`
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[runtimeMetadata](_base_.apibase.md#runtimemetadata)*
|
||||
|
||||
*Defined in [Base.ts:93](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/Base.ts#L93)*
|
||||
*Defined in [Base.ts:93](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/Base.ts#L93)*
|
||||
|
||||
*__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.
|
||||
|
||||
@@ -285,7 +285,7 @@ getruntimeVersion(): `RuntimeVersion`
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[runtimeVersion](_base_.apibase.md#runtimeversion)*
|
||||
|
||||
*Defined in [Base.ts:102](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/Base.ts#L102)*
|
||||
*Defined in [Base.ts:102](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/Base.ts#L102)*
|
||||
|
||||
*__description__*: Contains the version information for the current runtime.
|
||||
|
||||
@@ -300,7 +300,7 @@ gettx(): [SubmittableExtrinsics](../interfaces/_rx_types_.submittableextrinsics.
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[tx](_base_.apibase.md#tx)*
|
||||
|
||||
*Defined in [Base.ts:161](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/Base.ts#L161)*
|
||||
*Defined in [Base.ts:161](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/Base.ts#L161)*
|
||||
|
||||
*__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.
|
||||
|
||||
@@ -329,7 +329,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[on](_base_.apibase.md#on)*
|
||||
|
||||
*Defined in [Base.ts:186](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/Base.ts#L186)*
|
||||
*Defined in [Base.ts:186](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/Base.ts#L186)*
|
||||
|
||||
*__description__*: Attach an eventemitter handler to listen to a specific event
|
||||
|
||||
@@ -363,7 +363,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[once](_base_.apibase.md#once)*
|
||||
|
||||
*Defined in [Base.ts:211](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/Base.ts#L211)*
|
||||
*Defined in [Base.ts:211](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/Base.ts#L211)*
|
||||
|
||||
*__description__*: Attach an one-time eventemitter handler to listen to a specific event
|
||||
|
||||
@@ -395,7 +395,7 @@ ___
|
||||
|
||||
▸ **create**(options?: *[ApiOptions](../interfaces/_types_.apioptions.md) | `ProviderInterface`*): `Observable`<[ApiRx](_rx_index_.apirx.md)>
|
||||
|
||||
*Defined in [rx/index.ts:143](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/rx/index.ts#L143)*
|
||||
*Defined in [rx/index.ts:143](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/rx/index.ts#L143)*
|
||||
|
||||
*__description__*: Creates an ApiRx instance using the supplied provider. Returns an Observable containing the actual Api instance.
|
||||
|
||||
|
||||
@@ -25,7 +25,7 @@
|
||||
|
||||
*Overrides Extrinsic.__constructor*
|
||||
|
||||
*Defined in [rx/SubmittableExtrinsic.ts:17](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/rx/SubmittableExtrinsic.ts#L17)*
|
||||
*Defined in [rx/SubmittableExtrinsic.ts:17](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/rx/SubmittableExtrinsic.ts#L17)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -73,7 +73,7 @@ getType(): `E`
|
||||
|
||||
*Inherited from Struct.Type*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/07d6139/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/2a2df9a/packages/types/src/codec/Struct.ts#L142)*
|
||||
|
||||
*__description__*: Returns the Type description to sthe structure
|
||||
|
||||
@@ -88,7 +88,7 @@ getargs(): `Array`<`Codec`>
|
||||
|
||||
*Inherited from Extrinsic.args*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:71](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/Extrinsic.ts#L71)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:71](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/Extrinsic.ts#L71)*
|
||||
|
||||
*__description__*: The arguments passed to for the call, exposes args so it is compatible with \[\[Method\]\]
|
||||
|
||||
@@ -103,7 +103,7 @@ getcallIndex(): `Uint8Array`
|
||||
|
||||
*Inherited from Extrinsic.callIndex*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:78](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/Extrinsic.ts#L78)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:78](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/Extrinsic.ts#L78)*
|
||||
|
||||
*__description__*: The actual `[sectionIndex, methodIndex]` as used in the Method
|
||||
|
||||
@@ -118,7 +118,7 @@ getdata(): `Uint8Array`
|
||||
|
||||
*Inherited from Extrinsic.data*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:85](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/Extrinsic.ts#L85)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:85](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/Extrinsic.ts#L85)*
|
||||
|
||||
*__description__*: The actual data for the Method
|
||||
|
||||
@@ -135,7 +135,7 @@ getencodedLength(): `number`
|
||||
|
||||
*Overrides Struct.encodedLength*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:92](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/Extrinsic.ts#L92)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:92](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/Extrinsic.ts#L92)*
|
||||
|
||||
*__description__*: The length of the value when encoded as a Uint8Array
|
||||
|
||||
@@ -150,7 +150,7 @@ gethash(): `Hash`
|
||||
|
||||
*Inherited from Extrinsic.hash*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:101](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/Extrinsic.ts#L101)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:101](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/Extrinsic.ts#L101)*
|
||||
|
||||
*__description__*: Convernience function, encodes the extrinsic and returns the actual hash
|
||||
|
||||
@@ -165,7 +165,7 @@ getisSigned(): `boolean`
|
||||
|
||||
*Inherited from Extrinsic.isSigned*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:110](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/Extrinsic.ts#L110)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:110](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/Extrinsic.ts#L110)*
|
||||
|
||||
*__description__*: `true` id the extrinsic is signed
|
||||
|
||||
@@ -180,7 +180,7 @@ getlength(): `number`
|
||||
|
||||
*Inherited from Extrinsic.length*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:117](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/Extrinsic.ts#L117)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:117](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/Extrinsic.ts#L117)*
|
||||
|
||||
*__description__*: The length of the encoded value
|
||||
|
||||
@@ -195,7 +195,7 @@ getmeta(): `FunctionMetadata`
|
||||
|
||||
*Inherited from Extrinsic.meta*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:124](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/Extrinsic.ts#L124)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:124](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/Extrinsic.ts#L124)*
|
||||
|
||||
*__description__*: The \[\[FunctionMetadata\]\] that describes the extrinsic
|
||||
|
||||
@@ -210,7 +210,7 @@ getmethod(): `Method`
|
||||
|
||||
*Inherited from Extrinsic.method*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:131](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/Extrinsic.ts#L131)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:131](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/Extrinsic.ts#L131)*
|
||||
|
||||
*__description__*: The \[\[Method\]\] this extrinsic wraps
|
||||
|
||||
@@ -225,7 +225,7 @@ getsignature(): `ExtrinsicSignature`
|
||||
|
||||
*Inherited from Extrinsic.signature*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:138](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/Extrinsic.ts#L138)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:138](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/Extrinsic.ts#L138)*
|
||||
|
||||
*__description__*: The \[\[ExtrinsicSignature\]\]
|
||||
|
||||
@@ -258,7 +258,7 @@ ___
|
||||
|
||||
*Inherited from Extrinsic.addSignature*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:145](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/Extrinsic.ts#L145)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:145](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/Extrinsic.ts#L145)*
|
||||
|
||||
*__description__*: Add an \[\[ExtrinsicSignature\]\] to the extrinsic (already generated)
|
||||
|
||||
@@ -351,7 +351,7 @@ ___
|
||||
|
||||
*Overrides Map.get*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/codec/Struct.ts#L159)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/codec/Struct.ts#L159)*
|
||||
|
||||
*__description__*: Returns a specific names entry in the structure
|
||||
|
||||
@@ -372,7 +372,7 @@ ___
|
||||
|
||||
*Inherited from Struct.getAtIndex*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/07d6139/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/2a2df9a/packages/types/src/codec/Struct.ts#L166)*
|
||||
|
||||
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
|
||||
|
||||
@@ -425,7 +425,7 @@ ___
|
||||
|
||||
▸ **send**(): `Observable`<[SubmittableSendResult](../modules/_types_.md#submittablesendresult)>
|
||||
|
||||
*Defined in [rx/SubmittableExtrinsic.ts:48](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/rx/SubmittableExtrinsic.ts#L48)*
|
||||
*Defined in [rx/SubmittableExtrinsic.ts:48](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/rx/SubmittableExtrinsic.ts#L48)*
|
||||
|
||||
**Returns:** `Observable`<[SubmittableSendResult](../modules/_types_.md#submittablesendresult)>
|
||||
|
||||
@@ -458,7 +458,7 @@ ___
|
||||
|
||||
*Overrides Extrinsic.sign*
|
||||
|
||||
*Defined in [rx/SubmittableExtrinsic.ts:54](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/rx/SubmittableExtrinsic.ts#L54)*
|
||||
*Defined in [rx/SubmittableExtrinsic.ts:54](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/rx/SubmittableExtrinsic.ts#L54)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -479,7 +479,7 @@ ___
|
||||
|
||||
*Inherited from Struct.toArray*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/07d6139/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/2a2df9a/packages/types/src/codec/Struct.ts#L173)*
|
||||
|
||||
*__description__*: Converts the Object to an standard JavaScript Array
|
||||
|
||||
@@ -496,7 +496,7 @@ ___
|
||||
|
||||
*Overrides Struct.toHex*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:163](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/Extrinsic.ts#L163)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:163](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/Extrinsic.ts#L163)*
|
||||
|
||||
*__description__*: Returns a hex string representation of the value
|
||||
|
||||
@@ -513,7 +513,7 @@ ___
|
||||
|
||||
*Overrides Struct.toJSON*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:170](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/Extrinsic.ts#L170)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:170](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/Extrinsic.ts#L170)*
|
||||
|
||||
*__description__*: Converts the Object to JSON, typically used for RPC transfers
|
||||
|
||||
@@ -528,7 +528,7 @@ ___
|
||||
|
||||
*Inherited from Struct.toString*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/codec/Struct.ts#L201)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/codec/Struct.ts#L201)*
|
||||
|
||||
*__description__*: Returns the string representation of the value
|
||||
|
||||
@@ -545,7 +545,7 @@ ___
|
||||
|
||||
*Overrides Struct.toU8a*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:178](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/Extrinsic.ts#L178)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:178](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/Extrinsic.ts#L178)*
|
||||
|
||||
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
|
||||
|
||||
@@ -581,7 +581,7 @@ ___
|
||||
|
||||
*Inherited from Extrinsic.decodeExtrinsic*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:44](https://github.com/polkadot-js/api/blob/07d6139/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/2a2df9a/packages/types/src/Extrinsic.ts#L44)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -600,7 +600,7 @@ ___
|
||||
|
||||
*Inherited from Struct.with*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/07d6139/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/2a2df9a/packages/types/src/codec/Struct.ts#L122)*
|
||||
|
||||
**Type parameters:**
|
||||
|
||||
|
||||
+1
-1
@@ -2088,7 +2088,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"api","level":"1.2","depth":1,"next":{"title":"ApiPromise","level":"1.2.1","depth":2,"path":"api/classes/_promise_index_.apipromise.md","ref":"api/classes/_promise_index_.apipromise.md","articles":[]},"previous":{"title":"Introduction","level":"1.1","depth":1,"path":"README.md","ref":"README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"api/README.md","mtime":"2019-01-10T10:41:09.095Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-10T10:42:38.095Z"},"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-01-10T16:42:41.107Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-10T16:44:09.217Z"},"basePath":"..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -20,7 +20,7 @@
|
||||
|
||||
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[genesisHash](_types_.apibaseinterface.md#genesishash)*
|
||||
|
||||
*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/types.ts#L13)*
|
||||
*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/types.ts#L13)*
|
||||
|
||||
___
|
||||
<a id="hassubscriptions"></a>
|
||||
@@ -31,7 +31,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[hasSubscriptions](_types_.apibaseinterface.md#hassubscriptions)*
|
||||
|
||||
*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/types.ts#L14)*
|
||||
*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/types.ts#L14)*
|
||||
|
||||
___
|
||||
<a id="isready"></a>
|
||||
@@ -40,7 +40,7 @@ ___
|
||||
|
||||
**● isReady**: *`Promise`<[ApiPromiseInterface](_promise_types_.apipromiseinterface.md)>*
|
||||
|
||||
*Defined in [promise/types.ts:61](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/promise/types.ts#L61)*
|
||||
*Defined in [promise/types.ts:61](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/promise/types.ts#L61)*
|
||||
|
||||
___
|
||||
<a id="on"></a>
|
||||
@@ -51,7 +51,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[on](_types_.apibaseinterface.md#on)*
|
||||
|
||||
*Defined in [types.ts:21](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/types.ts#L21)*
|
||||
*Defined in [types.ts:21](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/types.ts#L21)*
|
||||
|
||||
#### Type declaration
|
||||
▸(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this`
|
||||
@@ -74,7 +74,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[once](_types_.apibaseinterface.md#once)*
|
||||
|
||||
*Defined in [types.ts:22](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/types.ts#L22)*
|
||||
*Defined in [types.ts:22](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/types.ts#L22)*
|
||||
|
||||
#### Type declaration
|
||||
▸(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this`
|
||||
@@ -97,7 +97,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[query](_types_.apibaseinterface.md#query)*
|
||||
|
||||
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/types.ts#L17)*
|
||||
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/types.ts#L17)*
|
||||
|
||||
___
|
||||
<a id="rpc"></a>
|
||||
@@ -108,7 +108,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[rpc](_types_.apibaseinterface.md#rpc)*
|
||||
|
||||
*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/types.ts#L18)*
|
||||
*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/types.ts#L18)*
|
||||
|
||||
___
|
||||
<a id="runtimemetadata"></a>
|
||||
@@ -119,7 +119,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[runtimeMetadata](_types_.apibaseinterface.md#runtimemetadata)*
|
||||
|
||||
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/types.ts#L15)*
|
||||
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/types.ts#L15)*
|
||||
|
||||
___
|
||||
<a id="runtimeversion"></a>
|
||||
@@ -130,7 +130,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[runtimeVersion](_types_.apibaseinterface.md#runtimeversion)*
|
||||
|
||||
*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/types.ts#L16)*
|
||||
*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/types.ts#L16)*
|
||||
|
||||
___
|
||||
<a id="tx"></a>
|
||||
@@ -141,7 +141,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[tx](_types_.apibaseinterface.md#tx)*
|
||||
|
||||
*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/types.ts#L19)*
|
||||
*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/types.ts#L19)*
|
||||
|
||||
___
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@
|
||||
|
||||
**● author**: *[DecoratedRpc$Section](_promise_types_.decoratedrpc_section.md)*
|
||||
|
||||
*Defined in [promise/types.ts:22](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/promise/types.ts#L22)*
|
||||
*Defined in [promise/types.ts:22](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/promise/types.ts#L22)*
|
||||
|
||||
___
|
||||
<a id="chain"></a>
|
||||
@@ -21,7 +21,7 @@ ___
|
||||
|
||||
**● chain**: *[DecoratedRpc$Section](_promise_types_.decoratedrpc_section.md)*
|
||||
|
||||
*Defined in [promise/types.ts:23](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/promise/types.ts#L23)*
|
||||
*Defined in [promise/types.ts:23](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/promise/types.ts#L23)*
|
||||
|
||||
___
|
||||
<a id="state"></a>
|
||||
@@ -30,7 +30,7 @@ ___
|
||||
|
||||
**● state**: *[DecoratedRpc$Section](_promise_types_.decoratedrpc_section.md)*
|
||||
|
||||
*Defined in [promise/types.ts:24](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/promise/types.ts#L24)*
|
||||
*Defined in [promise/types.ts:24](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/promise/types.ts#L24)*
|
||||
|
||||
___
|
||||
<a id="system"></a>
|
||||
@@ -39,7 +39,7 @@ ___
|
||||
|
||||
**● system**: *[DecoratedRpc$Section](_promise_types_.decoratedrpc_section.md)*
|
||||
|
||||
*Defined in [promise/types.ts:25](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/promise/types.ts#L25)*
|
||||
*Defined in [promise/types.ts:25](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/promise/types.ts#L25)*
|
||||
|
||||
___
|
||||
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
|
||||
▸ **__call**(arg?: *`any`*): `Uint8Array`
|
||||
|
||||
*Defined in [promise/types.ts:33](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/promise/types.ts#L33)*
|
||||
*Defined in [promise/types.ts:33](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/promise/types.ts#L33)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -25,7 +25,7 @@
|
||||
|
||||
**Returns:** [UnsubFunction](../modules/_promise_types_.md#unsubfunction)
|
||||
|
||||
*Defined in [promise/types.ts:34](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/promise/types.ts#L34)*
|
||||
*Defined in [promise/types.ts:34](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/promise/types.ts#L34)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -36,7 +36,7 @@
|
||||
|
||||
**Returns:** [UnsubFunction](../modules/_promise_types_.md#unsubfunction)
|
||||
|
||||
*Defined in [promise/types.ts:35](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/promise/types.ts#L35)*
|
||||
*Defined in [promise/types.ts:35](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/promise/types.ts#L35)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -46,7 +46,7 @@
|
||||
|
||||
**Returns:** `Promise`<`Codec` | `null` | `undefined`>
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:12](https://github.com/polkadot-js/api/blob/07d6139/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/2a2df9a/packages/types/src/StorageKey.ts#L12)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -64,7 +64,7 @@
|
||||
|
||||
**● at**: *`function`*
|
||||
|
||||
*Defined in [promise/types.ts:37](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/promise/types.ts#L37)*
|
||||
*Defined in [promise/types.ts:37](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/promise/types.ts#L37)*
|
||||
|
||||
#### Type declaration
|
||||
▸(hash: *`Hash`*, arg?: *`any`*): `Promise`<`Codec` | `null` | `undefined`>
|
||||
@@ -87,7 +87,7 @@ ___
|
||||
|
||||
*Inherited from StorageFunction.meta*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:14](https://github.com/polkadot-js/api/blob/07d6139/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/2a2df9a/packages/types/src/StorageKey.ts#L14)*
|
||||
|
||||
___
|
||||
<a id="method"></a>
|
||||
@@ -98,7 +98,7 @@ ___
|
||||
|
||||
*Inherited from StorageFunction.method*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:15](https://github.com/polkadot-js/api/blob/07d6139/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/2a2df9a/packages/types/src/StorageKey.ts#L15)*
|
||||
|
||||
___
|
||||
<a id="section"></a>
|
||||
@@ -109,7 +109,7 @@ ___
|
||||
|
||||
*Inherited from StorageFunction.section*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:16](https://github.com/polkadot-js/api/blob/07d6139/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/2a2df9a/packages/types/src/StorageKey.ts#L16)*
|
||||
|
||||
___
|
||||
<a id="tojson"></a>
|
||||
@@ -120,7 +120,7 @@ ___
|
||||
|
||||
*Inherited from StorageFunction.toJSON*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:17](https://github.com/polkadot-js/api/blob/07d6139/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/2a2df9a/packages/types/src/StorageKey.ts#L17)*
|
||||
|
||||
#### Type declaration
|
||||
▸(): `any`
|
||||
|
||||
@@ -9,7 +9,7 @@
|
||||
|
||||
▸ **__call**(cb: *`function`*): [UnsubFunction](../modules/_promise_types_.md#unsubfunction)
|
||||
|
||||
*Defined in [promise/types.ts:28](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/promise/types.ts#L28)*
|
||||
*Defined in [promise/types.ts:28](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/promise/types.ts#L28)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -20,7 +20,7 @@
|
||||
|
||||
**Returns:** [UnsubFunction](../modules/_promise_types_.md#unsubfunction)
|
||||
|
||||
*Defined in [promise/types.ts:29](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/promise/types.ts#L29)*
|
||||
*Defined in [promise/types.ts:29](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/promise/types.ts#L29)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -11,7 +11,7 @@
|
||||
|
||||
▸ **__call**(...args: *`any`[]*): `Method`
|
||||
|
||||
*Defined in [promise/types.ts:48](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/promise/types.ts#L48)*
|
||||
*Defined in [promise/types.ts:48](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/promise/types.ts#L48)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -21,7 +21,7 @@
|
||||
|
||||
**Returns:** [SubmittableExtrinsic](../classes/_promise_submittableextrinsic_.submittableextrinsic.md)
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:28](https://github.com/polkadot-js/api/blob/07d6139/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/2a2df9a/packages/types/src/Method.ts#L28)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -41,7 +41,7 @@
|
||||
|
||||
*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/07d6139/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/2a2df9a/packages/types/src/Method.ts#L30)*
|
||||
|
||||
___
|
||||
<a id="meta"></a>
|
||||
@@ -52,7 +52,7 @@ ___
|
||||
|
||||
*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/07d6139/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/2a2df9a/packages/types/src/Method.ts#L31)*
|
||||
|
||||
___
|
||||
<a id="method"></a>
|
||||
@@ -63,7 +63,7 @@ ___
|
||||
|
||||
*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/07d6139/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/2a2df9a/packages/types/src/Method.ts#L32)*
|
||||
|
||||
___
|
||||
<a id="section"></a>
|
||||
@@ -74,7 +74,7 @@ ___
|
||||
|
||||
*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/07d6139/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/2a2df9a/packages/types/src/Method.ts#L33)*
|
||||
|
||||
___
|
||||
<a id="tojson"></a>
|
||||
@@ -85,7 +85,7 @@ ___
|
||||
|
||||
*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/07d6139/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/2a2df9a/packages/types/src/Method.ts#L34)*
|
||||
|
||||
#### Type declaration
|
||||
▸(): `any`
|
||||
|
||||
@@ -20,7 +20,7 @@
|
||||
|
||||
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[genesisHash](_types_.apibaseinterface.md#genesishash)*
|
||||
|
||||
*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/types.ts#L13)*
|
||||
*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/types.ts#L13)*
|
||||
|
||||
___
|
||||
<a id="hassubscriptions"></a>
|
||||
@@ -31,7 +31,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[hasSubscriptions](_types_.apibaseinterface.md#hassubscriptions)*
|
||||
|
||||
*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/types.ts#L14)*
|
||||
*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/types.ts#L14)*
|
||||
|
||||
___
|
||||
<a id="isconnected"></a>
|
||||
@@ -40,7 +40,7 @@ ___
|
||||
|
||||
**● isConnected**: *`Observable`<`boolean`>*
|
||||
|
||||
*Defined in [rx/types.ts:42](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/rx/types.ts#L42)*
|
||||
*Defined in [rx/types.ts:42](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/rx/types.ts#L42)*
|
||||
|
||||
___
|
||||
<a id="isready"></a>
|
||||
@@ -49,7 +49,7 @@ ___
|
||||
|
||||
**● isReady**: *`Observable`<[ApiRxInterface](_rx_types_.apirxinterface.md)>*
|
||||
|
||||
*Defined in [rx/types.ts:43](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/rx/types.ts#L43)*
|
||||
*Defined in [rx/types.ts:43](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/rx/types.ts#L43)*
|
||||
|
||||
___
|
||||
<a id="on"></a>
|
||||
@@ -60,7 +60,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[on](_types_.apibaseinterface.md#on)*
|
||||
|
||||
*Defined in [types.ts:21](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/types.ts#L21)*
|
||||
*Defined in [types.ts:21](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/types.ts#L21)*
|
||||
|
||||
#### Type declaration
|
||||
▸(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this`
|
||||
@@ -83,7 +83,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[once](_types_.apibaseinterface.md#once)*
|
||||
|
||||
*Defined in [types.ts:22](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/types.ts#L22)*
|
||||
*Defined in [types.ts:22](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/types.ts#L22)*
|
||||
|
||||
#### Type declaration
|
||||
▸(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this`
|
||||
@@ -106,7 +106,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[query](_types_.apibaseinterface.md#query)*
|
||||
|
||||
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/types.ts#L17)*
|
||||
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/types.ts#L17)*
|
||||
|
||||
___
|
||||
<a id="rpc"></a>
|
||||
@@ -117,7 +117,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[rpc](_types_.apibaseinterface.md#rpc)*
|
||||
|
||||
*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/types.ts#L18)*
|
||||
*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/types.ts#L18)*
|
||||
|
||||
___
|
||||
<a id="runtimemetadata"></a>
|
||||
@@ -128,7 +128,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[runtimeMetadata](_types_.apibaseinterface.md#runtimemetadata)*
|
||||
|
||||
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/types.ts#L15)*
|
||||
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/types.ts#L15)*
|
||||
|
||||
___
|
||||
<a id="runtimeversion"></a>
|
||||
@@ -139,7 +139,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[runtimeVersion](_types_.apibaseinterface.md#runtimeversion)*
|
||||
|
||||
*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/types.ts#L16)*
|
||||
*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/types.ts#L16)*
|
||||
|
||||
___
|
||||
<a id="tx"></a>
|
||||
@@ -150,7 +150,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[tx](_types_.apibaseinterface.md#tx)*
|
||||
|
||||
*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/types.ts#L19)*
|
||||
*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/types.ts#L19)*
|
||||
|
||||
___
|
||||
|
||||
|
||||
@@ -11,7 +11,7 @@
|
||||
|
||||
▸ **__call**(arg?: *`any`*): `Uint8Array`
|
||||
|
||||
*Defined in [rx/types.ts:16](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/rx/types.ts#L16)*
|
||||
*Defined in [rx/types.ts:16](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/rx/types.ts#L16)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -21,7 +21,7 @@
|
||||
|
||||
**Returns:** `Observable`<`Codec` | `null` | `undefined`>
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:12](https://github.com/polkadot-js/api/blob/07d6139/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/2a2df9a/packages/types/src/StorageKey.ts#L12)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -39,7 +39,7 @@
|
||||
|
||||
**● at**: *`function`*
|
||||
|
||||
*Defined in [rx/types.ts:18](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/rx/types.ts#L18)*
|
||||
*Defined in [rx/types.ts:18](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/rx/types.ts#L18)*
|
||||
|
||||
#### Type declaration
|
||||
▸(hash: *`Hash`*, arg?: *`any`*): `Observable`<`Codec` | `null` | `undefined`>
|
||||
@@ -62,7 +62,7 @@ ___
|
||||
|
||||
*Inherited from StorageFunction.meta*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:14](https://github.com/polkadot-js/api/blob/07d6139/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/2a2df9a/packages/types/src/StorageKey.ts#L14)*
|
||||
|
||||
___
|
||||
<a id="method"></a>
|
||||
@@ -73,7 +73,7 @@ ___
|
||||
|
||||
*Inherited from StorageFunction.method*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:15](https://github.com/polkadot-js/api/blob/07d6139/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/2a2df9a/packages/types/src/StorageKey.ts#L15)*
|
||||
|
||||
___
|
||||
<a id="section"></a>
|
||||
@@ -84,7 +84,7 @@ ___
|
||||
|
||||
*Inherited from StorageFunction.section*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:16](https://github.com/polkadot-js/api/blob/07d6139/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/2a2df9a/packages/types/src/StorageKey.ts#L16)*
|
||||
|
||||
___
|
||||
<a id="tojson"></a>
|
||||
@@ -95,7 +95,7 @@ ___
|
||||
|
||||
*Inherited from StorageFunction.toJSON*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:17](https://github.com/polkadot-js/api/blob/07d6139/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/2a2df9a/packages/types/src/StorageKey.ts#L17)*
|
||||
|
||||
#### Type declaration
|
||||
▸(): `any`
|
||||
|
||||
@@ -11,7 +11,7 @@
|
||||
|
||||
▸ **__call**(...args: *`any`[]*): `Method`
|
||||
|
||||
*Defined in [rx/types.ts:29](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/rx/types.ts#L29)*
|
||||
*Defined in [rx/types.ts:29](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/rx/types.ts#L29)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -21,7 +21,7 @@
|
||||
|
||||
**Returns:** [SubmittableExtrinsic](../classes/_rx_submittableextrinsic_.submittableextrinsic.md)
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:28](https://github.com/polkadot-js/api/blob/07d6139/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/2a2df9a/packages/types/src/Method.ts#L28)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -41,7 +41,7 @@
|
||||
|
||||
*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/07d6139/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/2a2df9a/packages/types/src/Method.ts#L30)*
|
||||
|
||||
___
|
||||
<a id="meta"></a>
|
||||
@@ -52,7 +52,7 @@ ___
|
||||
|
||||
*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/07d6139/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/2a2df9a/packages/types/src/Method.ts#L31)*
|
||||
|
||||
___
|
||||
<a id="method"></a>
|
||||
@@ -63,7 +63,7 @@ ___
|
||||
|
||||
*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/07d6139/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/2a2df9a/packages/types/src/Method.ts#L32)*
|
||||
|
||||
___
|
||||
<a id="section"></a>
|
||||
@@ -74,7 +74,7 @@ ___
|
||||
|
||||
*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/07d6139/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/2a2df9a/packages/types/src/Method.ts#L33)*
|
||||
|
||||
___
|
||||
<a id="tojson"></a>
|
||||
@@ -85,7 +85,7 @@ ___
|
||||
|
||||
*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/07d6139/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/2a2df9a/packages/types/src/Method.ts#L34)*
|
||||
|
||||
#### Type declaration
|
||||
▸(): `any`
|
||||
|
||||
@@ -26,7 +26,7 @@
|
||||
|
||||
**● genesisHash**: *`Hash`*
|
||||
|
||||
*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/types.ts#L13)*
|
||||
*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/types.ts#L13)*
|
||||
|
||||
___
|
||||
<a id="hassubscriptions"></a>
|
||||
@@ -35,7 +35,7 @@ ___
|
||||
|
||||
**● hasSubscriptions**: *`boolean`*
|
||||
|
||||
*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/types.ts#L14)*
|
||||
*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/types.ts#L14)*
|
||||
|
||||
___
|
||||
<a id="on"></a>
|
||||
@@ -44,7 +44,7 @@ ___
|
||||
|
||||
**● on**: *`function`*
|
||||
|
||||
*Defined in [types.ts:21](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/types.ts#L21)*
|
||||
*Defined in [types.ts:21](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/types.ts#L21)*
|
||||
|
||||
#### Type declaration
|
||||
▸(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this`
|
||||
@@ -65,7 +65,7 @@ ___
|
||||
|
||||
**● once**: *`function`*
|
||||
|
||||
*Defined in [types.ts:22](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/types.ts#L22)*
|
||||
*Defined in [types.ts:22](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/types.ts#L22)*
|
||||
|
||||
#### Type declaration
|
||||
▸(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this`
|
||||
@@ -86,7 +86,7 @@ ___
|
||||
|
||||
**● query**: *`S`*
|
||||
|
||||
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/types.ts#L17)*
|
||||
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/types.ts#L17)*
|
||||
|
||||
___
|
||||
<a id="rpc"></a>
|
||||
@@ -95,7 +95,7 @@ ___
|
||||
|
||||
**● rpc**: *`R`*
|
||||
|
||||
*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/types.ts#L18)*
|
||||
*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/types.ts#L18)*
|
||||
|
||||
___
|
||||
<a id="runtimemetadata"></a>
|
||||
@@ -104,7 +104,7 @@ ___
|
||||
|
||||
**● runtimeMetadata**: *`Metadata`*
|
||||
|
||||
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/types.ts#L15)*
|
||||
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/types.ts#L15)*
|
||||
|
||||
___
|
||||
<a id="runtimeversion"></a>
|
||||
@@ -113,7 +113,7 @@ ___
|
||||
|
||||
**● runtimeVersion**: *`RuntimeVersion`*
|
||||
|
||||
*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/types.ts#L16)*
|
||||
*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/types.ts#L16)*
|
||||
|
||||
___
|
||||
<a id="tx"></a>
|
||||
@@ -122,7 +122,7 @@ ___
|
||||
|
||||
**● tx**: *`E`*
|
||||
|
||||
*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/types.ts#L19)*
|
||||
*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/types.ts#L19)*
|
||||
|
||||
___
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@
|
||||
|
||||
**● provider**: *`ProviderInterface`*
|
||||
|
||||
*Defined in [types.ts:30](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/types.ts#L30)*
|
||||
*Defined in [types.ts:30](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/types.ts#L30)*
|
||||
|
||||
*__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`
|
||||
|
||||
@@ -23,7 +23,7 @@ ___
|
||||
|
||||
**● types**: *`undefined` | `object`*
|
||||
|
||||
*Defined in [types.ts:35](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/types.ts#L35)*
|
||||
*Defined in [types.ts:35](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/types.ts#L35)*
|
||||
|
||||
*__description__*: Additional types used by runtime modules. This is nessusary if the runtime modules uses types not available in the base Substrate runtime.
|
||||
|
||||
|
||||
@@ -21,7 +21,7 @@
|
||||
|
||||
**Ƭ CombinatorCallback**: *`function`*
|
||||
|
||||
*Defined in [promise/Combinator.ts:9](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/promise/Combinator.ts#L9)*
|
||||
*Defined in [promise/Combinator.ts:9](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/promise/Combinator.ts#L9)*
|
||||
|
||||
#### Type declaration
|
||||
▸(value: *`Array`<`any`>*): `any`
|
||||
@@ -41,7 +41,7 @@ ___
|
||||
|
||||
**Ƭ CombinatorFunction**: *`function`*
|
||||
|
||||
*Defined in [promise/Combinator.ts:10](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/promise/Combinator.ts#L10)*
|
||||
*Defined in [promise/Combinator.ts:10](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/promise/Combinator.ts#L10)*
|
||||
|
||||
#### Type declaration
|
||||
▸(cb: *`function`*): [UnsubFunction](_promise_types_.md#unsubfunction) | `any`
|
||||
|
||||
@@ -31,7 +31,7 @@
|
||||
|
||||
**Ƭ DecoratedRpc$Method**: *`function`*
|
||||
|
||||
*Defined in [promise/types.ts:15](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/promise/types.ts#L15)*
|
||||
*Defined in [promise/types.ts:15](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/promise/types.ts#L15)*
|
||||
|
||||
#### Type declaration
|
||||
▸(...params: *`Array`<`any`>*): `Promise`<`any`> | [UnsubFunction](_promise_types_.md#unsubfunction)
|
||||
@@ -51,7 +51,7 @@ ___
|
||||
|
||||
**Ƭ SubmittableSendResult**: *`object`*
|
||||
|
||||
*Defined in [promise/types.ts:64](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/promise/types.ts#L64)*
|
||||
*Defined in [promise/types.ts:64](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/promise/types.ts#L64)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
@@ -62,7 +62,7 @@ ___
|
||||
|
||||
**Ƭ UnsubFunction**: *`function`*
|
||||
|
||||
*Defined in [promise/types.ts:13](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/promise/types.ts#L13)*
|
||||
*Defined in [promise/types.ts:13](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/promise/types.ts#L13)*
|
||||
|
||||
#### Type declaration
|
||||
▸(): `void`
|
||||
|
||||
@@ -26,7 +26,7 @@
|
||||
|
||||
**Ƭ SubmittableSendResult**: *`object`*
|
||||
|
||||
*Defined in [rx/types.ts:46](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/rx/types.ts#L46)*
|
||||
*Defined in [rx/types.ts:46](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/rx/types.ts#L46)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
|
||||
@@ -22,7 +22,7 @@
|
||||
|
||||
**Ƭ ApiInterface$Events**: *`RpcRxInterface$Events` | "ready"*
|
||||
|
||||
*Defined in [types.ts:10](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/types.ts#L10)*
|
||||
*Defined in [types.ts:10](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/types.ts#L10)*
|
||||
|
||||
___
|
||||
<a id="submittablesendresult"></a>
|
||||
@@ -31,7 +31,7 @@ ___
|
||||
|
||||
**Ƭ SubmittableSendResult**: *`object`*
|
||||
|
||||
*Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/types.ts#L38)*
|
||||
*Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/types.ts#L38)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
▸ **filterEvents**(extHash: *`Hash`*, __namedParameters: *`object`*, allEvents: *`Array`<`EventRecord`>*): `Array`<`EventRecord`> | `undefined`
|
||||
|
||||
*Defined in [util/filterEvents.ts:9](https://github.com/polkadot-js/api/blob/07d6139/packages/api/src/util/filterEvents.ts#L9)*
|
||||
*Defined in [util/filterEvents.ts:9](https://github.com/polkadot-js/api/blob/2a2df9a/packages/api/src/util/filterEvents.ts#L9)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -2054,7 +2054,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"Simple connect","level":"3.1.1","depth":2,"next":{"title":"Listen to blocks","level":"3.1.2","depth":2,"path":"examples/promise/02_listen_to_blocks/README.md","ref":"examples/promise/02_listen_to_blocks/README.md","articles":[]},"previous":{"title":"ApiPromise","level":"3.1","depth":1,"path":"examples/promise/README.md","ref":"examples/promise/README.md","articles":[{"title":"Simple connect","level":"3.1.1","depth":2,"path":"examples/promise/01_simple_connect/README.md","ref":"examples/promise/01_simple_connect/README.md","articles":[]},{"title":"Listen to blocks","level":"3.1.2","depth":2,"path":"examples/promise/02_listen_to_blocks/README.md","ref":"examples/promise/02_listen_to_blocks/README.md","articles":[]},{"title":"Listen to balance change","level":"3.1.3","depth":2,"path":"examples/promise/03_listen_to_balance_change/README.md","ref":"examples/promise/03_listen_to_balance_change/README.md","articles":[]},{"title":"Read chain state","level":"3.1.4","depth":2,"path":"examples/promise/05_read_storage/README.md","ref":"examples/promise/05_read_storage/README.md","articles":[]},{"title":"Make a transfer","level":"3.1.5","depth":2,"path":"examples/promise/07_transfer_dots/README.md","ref":"examples/promise/07_transfer_dots/README.md","articles":[]},{"title":"Display system events","level":"3.1.6","depth":2,"path":"examples/promise/08_system_events/README.md","ref":"examples/promise/08_system_events/README.md","articles":[]},{"title":"Transaction with events","level":"3.1.7","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.8","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-01-10T10:38:44.698Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-10T10:42:38.095Z"},"basePath":"../../..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"Simple connect","level":"3.1.1","depth":2,"next":{"title":"Listen to blocks","level":"3.1.2","depth":2,"path":"examples/promise/02_listen_to_blocks/README.md","ref":"examples/promise/02_listen_to_blocks/README.md","articles":[]},"previous":{"title":"ApiPromise","level":"3.1","depth":1,"path":"examples/promise/README.md","ref":"examples/promise/README.md","articles":[{"title":"Simple connect","level":"3.1.1","depth":2,"path":"examples/promise/01_simple_connect/README.md","ref":"examples/promise/01_simple_connect/README.md","articles":[]},{"title":"Listen to blocks","level":"3.1.2","depth":2,"path":"examples/promise/02_listen_to_blocks/README.md","ref":"examples/promise/02_listen_to_blocks/README.md","articles":[]},{"title":"Listen to balance change","level":"3.1.3","depth":2,"path":"examples/promise/03_listen_to_balance_change/README.md","ref":"examples/promise/03_listen_to_balance_change/README.md","articles":[]},{"title":"Read chain state","level":"3.1.4","depth":2,"path":"examples/promise/05_read_storage/README.md","ref":"examples/promise/05_read_storage/README.md","articles":[]},{"title":"Make a transfer","level":"3.1.5","depth":2,"path":"examples/promise/07_transfer_dots/README.md","ref":"examples/promise/07_transfer_dots/README.md","articles":[]},{"title":"Display system events","level":"3.1.6","depth":2,"path":"examples/promise/08_system_events/README.md","ref":"examples/promise/08_system_events/README.md","articles":[]},{"title":"Transaction with events","level":"3.1.7","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.8","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-01-10T16:40:14.034Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-10T16:44:09.217Z"},"basePath":"../../..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -2056,7 +2056,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"Listen to blocks","level":"3.1.2","depth":2,"next":{"title":"Listen to balance change","level":"3.1.3","depth":2,"path":"examples/promise/03_listen_to_balance_change/README.md","ref":"examples/promise/03_listen_to_balance_change/README.md","articles":[]},"previous":{"title":"Simple connect","level":"3.1.1","depth":2,"path":"examples/promise/01_simple_connect/README.md","ref":"examples/promise/01_simple_connect/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/02_listen_to_blocks/README.md","mtime":"2019-01-10T10:38:44.698Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-10T10:42:38.095Z"},"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-01-10T16:40:14.034Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-10T16:44:09.217Z"},"basePath":"../../..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -2067,7 +2067,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"Listen to balance change","level":"3.1.3","depth":2,"next":{"title":"Read chain state","level":"3.1.4","depth":2,"path":"examples/promise/05_read_storage/README.md","ref":"examples/promise/05_read_storage/README.md","articles":[]},"previous":{"title":"Listen to blocks","level":"3.1.2","depth":2,"path":"examples/promise/02_listen_to_blocks/README.md","ref":"examples/promise/02_listen_to_blocks/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/03_listen_to_balance_change/README.md","mtime":"2019-01-10T10:38:44.698Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-10T10:42:38.095Z"},"basePath":"../../..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"Listen to balance change","level":"3.1.3","depth":2,"next":{"title":"Read chain state","level":"3.1.4","depth":2,"path":"examples/promise/05_read_storage/README.md","ref":"examples/promise/05_read_storage/README.md","articles":[]},"previous":{"title":"Listen to blocks","level":"3.1.2","depth":2,"path":"examples/promise/02_listen_to_blocks/README.md","ref":"examples/promise/02_listen_to_blocks/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/03_listen_to_balance_change/README.md","mtime":"2019-01-10T16:40:14.034Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-10T16:44:09.217Z"},"basePath":"../../..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -2066,7 +2066,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"Read chain state","level":"3.1.4","depth":2,"next":{"title":"Make a transfer","level":"3.1.5","depth":2,"path":"examples/promise/07_transfer_dots/README.md","ref":"examples/promise/07_transfer_dots/README.md","articles":[]},"previous":{"title":"Listen to balance change","level":"3.1.3","depth":2,"path":"examples/promise/03_listen_to_balance_change/README.md","ref":"examples/promise/03_listen_to_balance_change/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/05_read_storage/README.md","mtime":"2019-01-10T10:38:44.698Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-10T10:42:38.095Z"},"basePath":"../../..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"Read chain state","level":"3.1.4","depth":2,"next":{"title":"Make a transfer","level":"3.1.5","depth":2,"path":"examples/promise/07_transfer_dots/README.md","ref":"examples/promise/07_transfer_dots/README.md","articles":[]},"previous":{"title":"Listen to balance change","level":"3.1.3","depth":2,"path":"examples/promise/03_listen_to_balance_change/README.md","ref":"examples/promise/03_listen_to_balance_change/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/05_read_storage/README.md","mtime":"2019-01-10T16:40:14.034Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-10T16:44:09.217Z"},"basePath":"../../..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -2068,7 +2068,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"Make a transfer","level":"3.1.5","depth":2,"next":{"title":"Display system events","level":"3.1.6","depth":2,"path":"examples/promise/08_system_events/README.md","ref":"examples/promise/08_system_events/README.md","articles":[]},"previous":{"title":"Read chain state","level":"3.1.4","depth":2,"path":"examples/promise/05_read_storage/README.md","ref":"examples/promise/05_read_storage/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/07_transfer_dots/README.md","mtime":"2019-01-10T10:38:44.698Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-10T10:42:38.095Z"},"basePath":"../../..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"Make a transfer","level":"3.1.5","depth":2,"next":{"title":"Display system events","level":"3.1.6","depth":2,"path":"examples/promise/08_system_events/README.md","ref":"examples/promise/08_system_events/README.md","articles":[]},"previous":{"title":"Read chain state","level":"3.1.4","depth":2,"path":"examples/promise/05_read_storage/README.md","ref":"examples/promise/05_read_storage/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/07_transfer_dots/README.md","mtime":"2019-01-10T16:40:14.034Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-10T16:44:09.217Z"},"basePath":"../../..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -2065,7 +2065,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"Display system events","level":"3.1.6","depth":2,"next":{"title":"Transaction with events","level":"3.1.7","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.5","depth":2,"path":"examples/promise/07_transfer_dots/README.md","ref":"examples/promise/07_transfer_dots/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/08_system_events/README.md","mtime":"2019-01-10T10:38:44.698Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-10T10:42:38.095Z"},"basePath":"../../..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"Display system events","level":"3.1.6","depth":2,"next":{"title":"Transaction with events","level":"3.1.7","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.5","depth":2,"path":"examples/promise/07_transfer_dots/README.md","ref":"examples/promise/07_transfer_dots/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/08_system_events/README.md","mtime":"2019-01-10T16:40:14.034Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-10T16:44:09.217Z"},"basePath":"../../..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -2084,7 +2084,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"Transaction with events","level":"3.1.7","depth":2,"next":{"title":"Upgrade via sudo","level":"3.1.8","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.6","depth":2,"path":"examples/promise/08_system_events/README.md","ref":"examples/promise/08_system_events/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/09_transfer_events/README.md","mtime":"2019-01-10T10:38:44.698Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-10T10:42:38.095Z"},"basePath":"../../..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"Transaction with events","level":"3.1.7","depth":2,"next":{"title":"Upgrade via sudo","level":"3.1.8","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.6","depth":2,"path":"examples/promise/08_system_events/README.md","ref":"examples/promise/08_system_events/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/09_transfer_events/README.md","mtime":"2019-01-10T16:40:14.034Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-10T16:44:09.217Z"},"basePath":"../../..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -2095,7 +2095,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"Upgrade via sudo","level":"3.1.8","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.1.7","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-01-10T10:38:44.698Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-10T10:42:38.095Z"},"basePath":"../../..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"Upgrade via sudo","level":"3.1.8","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.1.7","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-01-10T16:40:14.034Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-10T16:44:09.217Z"},"basePath":"../../..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -2044,7 +2044,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"ApiPromise","level":"3.1","depth":1,"next":{"title":"Simple connect","level":"3.1.1","depth":2,"path":"examples/promise/01_simple_connect/README.md","ref":"examples/promise/01_simple_connect/README.md","articles":[]},"previous":{"title":"Events (runtime)","level":"2.4","depth":1,"path":"METHODS_EVENTS.md","ref":"METHODS_EVENTS.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/README.md","mtime":"2019-01-10T10:38:44.706Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-10T10:42:38.095Z"},"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-01-10T16:40:14.042Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-10T16:44:09.217Z"},"basePath":"../..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
+1
-1
@@ -2037,7 +2037,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"Introduction","level":"1.1","depth":1,"next":{"title":"api","level":"1.2","depth":1,"path":"api/README.md","ref":"api/README.md","articles":[{"title":"ApiPromise","level":"1.2.1","depth":2,"path":"api/classes/_promise_index_.apipromise.md","ref":"api/classes/_promise_index_.apipromise.md","articles":[]},{"title":"ApiRx","level":"1.2.2","depth":2,"path":"api/classes/_rx_index_.apirx.md","ref":"api/classes/_rx_index_.apirx.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"README.md","mtime":"2019-01-10T10:38:44.694Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-10T10:42:38.095Z"},"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-01-10T16:40:14.030Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-10T16:44:09.217Z"},"basePath":".","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -38,7 +38,7 @@ const api = new Api(provider);
|
||||
|
||||
⊕ **new Rpc**(provider?: *`ProviderInterface`*): [Rpc](_index_.rpc.md)
|
||||
|
||||
*Defined in [index.ts:46](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-core/src/index.ts#L46)*
|
||||
*Defined in [index.ts:46](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-core/src/index.ts#L46)*
|
||||
|
||||
*__constructor__*: Default constructor for the Api Object
|
||||
|
||||
@@ -60,7 +60,7 @@ ___
|
||||
|
||||
**● _provider**: *`ProviderInterface`*
|
||||
|
||||
*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-core/src/index.ts#L42)*
|
||||
*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-core/src/index.ts#L42)*
|
||||
|
||||
___
|
||||
<a id="author"></a>
|
||||
@@ -71,7 +71,7 @@ ___
|
||||
|
||||
*Implementation of [RpcInterface](../interfaces/_types_.rpcinterface.md).[author](../interfaces/_types_.rpcinterface.md#author)*
|
||||
|
||||
*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-core/src/index.ts#L43)*
|
||||
*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-core/src/index.ts#L43)*
|
||||
|
||||
___
|
||||
<a id="chain"></a>
|
||||
@@ -82,7 +82,7 @@ ___
|
||||
|
||||
*Implementation of [RpcInterface](../interfaces/_types_.rpcinterface.md).[chain](../interfaces/_types_.rpcinterface.md#chain)*
|
||||
|
||||
*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-core/src/index.ts#L44)*
|
||||
*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-core/src/index.ts#L44)*
|
||||
|
||||
___
|
||||
<a id="state"></a>
|
||||
@@ -93,7 +93,7 @@ ___
|
||||
|
||||
*Implementation of [RpcInterface](../interfaces/_types_.rpcinterface.md).[state](../interfaces/_types_.rpcinterface.md#state)*
|
||||
|
||||
*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-core/src/index.ts#L45)*
|
||||
*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-core/src/index.ts#L45)*
|
||||
|
||||
___
|
||||
<a id="system"></a>
|
||||
@@ -104,7 +104,7 @@ ___
|
||||
|
||||
*Implementation of [RpcInterface](../interfaces/_types_.rpcinterface.md).[system](../interfaces/_types_.rpcinterface.md#system)*
|
||||
|
||||
*Defined in [index.ts:46](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-core/src/index.ts#L46)*
|
||||
*Defined in [index.ts:46](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-core/src/index.ts#L46)*
|
||||
|
||||
___
|
||||
|
||||
@@ -116,7 +116,7 @@ ___
|
||||
|
||||
▸ **signature**(__namedParameters: *`object`*): `string`
|
||||
|
||||
*Defined in [index.ts:79](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-core/src/index.ts#L79)*
|
||||
*Defined in [index.ts:79](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-core/src/index.ts#L79)*
|
||||
|
||||
*__name__*: signature
|
||||
|
||||
|
||||
@@ -16,7 +16,7 @@
|
||||
|
||||
**● author**: *[RpcInterface$Section](../modules/_types_.md#rpcinterface_section)*
|
||||
|
||||
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-core/src/types.ts#L17)*
|
||||
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-core/src/types.ts#L17)*
|
||||
|
||||
___
|
||||
<a id="chain"></a>
|
||||
@@ -25,7 +25,7 @@ ___
|
||||
|
||||
**● chain**: *[RpcInterface$Section](../modules/_types_.md#rpcinterface_section)*
|
||||
|
||||
*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-core/src/types.ts#L18)*
|
||||
*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-core/src/types.ts#L18)*
|
||||
|
||||
___
|
||||
<a id="state"></a>
|
||||
@@ -34,7 +34,7 @@ ___
|
||||
|
||||
**● state**: *[RpcInterface$Section](../modules/_types_.md#rpcinterface_section)*
|
||||
|
||||
*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-core/src/types.ts#L19)*
|
||||
*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-core/src/types.ts#L19)*
|
||||
|
||||
___
|
||||
<a id="system"></a>
|
||||
@@ -43,7 +43,7 @@ ___
|
||||
|
||||
**● system**: *[RpcInterface$Section](../modules/_types_.md#rpcinterface_section)*
|
||||
|
||||
*Defined in [types.ts:20](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-core/src/types.ts#L20)*
|
||||
*Defined in [types.ts:20](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-core/src/types.ts#L20)*
|
||||
|
||||
___
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@
|
||||
# Callable
|
||||
▸ **__call**(...params: *`Array`<`any`>*): `Promise`<`any`>
|
||||
|
||||
*Defined in [types.ts:5](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-core/src/types.ts#L5)*
|
||||
*Defined in [types.ts:5](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-core/src/types.ts#L5)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -25,7 +25,7 @@
|
||||
|
||||
**● subscription**: *`string`*
|
||||
|
||||
*Defined in [types.ts:8](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-core/src/types.ts#L8)*
|
||||
*Defined in [types.ts:8](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-core/src/types.ts#L8)*
|
||||
|
||||
___
|
||||
<a id="unsubscribe"></a>
|
||||
@@ -34,7 +34,7 @@ ___
|
||||
|
||||
**● unsubscribe**: *`function`*
|
||||
|
||||
*Defined in [types.ts:9](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-core/src/types.ts#L9)*
|
||||
*Defined in [types.ts:9](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-core/src/types.ts#L9)*
|
||||
|
||||
#### Type declaration
|
||||
▸(id: *`number`*): `Promise`<`any`>
|
||||
|
||||
@@ -21,7 +21,7 @@
|
||||
|
||||
**Ƭ RpcInterface$Section**: *`object`*
|
||||
|
||||
*Defined in [types.ts:12](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-core/src/types.ts#L12)*
|
||||
*Defined in [types.ts:12](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-core/src/types.ts#L12)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@
|
||||
|
||||
▸ **decodeResponse**(response: *[JsonRpcResponse](../modules/_types_.md#jsonrpcresponse)*): `any`
|
||||
|
||||
*Defined in [coder/index.ts:12](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/coder/index.ts#L12)*
|
||||
*Defined in [coder/index.ts:12](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/coder/index.ts#L12)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -29,7 +29,7 @@ ___
|
||||
|
||||
▸ **encodeJson**(method: *`string`*, params: *`any` | `Array`<`any`>*): `string`
|
||||
|
||||
*Defined in [coder/index.ts:33](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/coder/index.ts#L33)*
|
||||
*Defined in [coder/index.ts:33](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/coder/index.ts#L33)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -47,7 +47,7 @@ ___
|
||||
|
||||
▸ **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/07d6139/packages/rpc-provider/src/coder/index.ts#L39)*
|
||||
*Defined in [coder/index.ts:39](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/coder/index.ts#L39)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -65,7 +65,7 @@ ___
|
||||
|
||||
▸ **getId**(): `number`
|
||||
|
||||
*Defined in [coder/index.ts:48](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/coder/index.ts#L48)*
|
||||
*Defined in [coder/index.ts:48](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/coder/index.ts#L48)*
|
||||
|
||||
**Returns:** `number`
|
||||
|
||||
|
||||
@@ -2007,7 +2007,7 @@
|
||||
<p><a id="constructor"></a></p>
|
||||
<h2 id="constructor">constructor</h2>
|
||||
<p>⊕ <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/07d6139/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/2a2df9a/packages/rpc-provider/src/http/index.ts#L40" target="_blank">http/index.ts:40</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -2033,7 +2033,7 @@
|
||||
<p><a id="hassubscriptions"></a></p>
|
||||
<h2 id="hassubscriptions">hasSubscriptions</h2>
|
||||
<p>gethasSubscriptions(): <code>boolean</code></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/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/2a2df9a/packages/rpc-provider/src/http/index.ts#L55" target="_blank">http/index.ts:55</a></em></p>
|
||||
<p><em><strong>summary</strong></em>: <code>true</code> when this provider supports subscriptions</p>
|
||||
<p><strong>Returns:</strong> <code>boolean</code></p>
|
||||
<hr>
|
||||
@@ -2042,7 +2042,7 @@
|
||||
<h2 id="isconnected">isConnected</h2>
|
||||
<p>▸ <strong>isConnected</strong>(): <code>boolean</code></p>
|
||||
<p><em>Implementation of <a href="../interfaces/_types_.providerinterface.md">ProviderInterface</a>.<a href="../interfaces/_types_.providerinterface.md#isconnected">isConnected</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/http/index.ts#L63" target="_blank">http/index.ts:63</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/http/index.ts#L63" target="_blank">http/index.ts:63</a></em></p>
|
||||
<p><em><strong>summary</strong></em>: Whether the node is connected or not.</p>
|
||||
<p><strong>Returns:</strong> <code>boolean</code>
|
||||
true if connected</p>
|
||||
@@ -2051,7 +2051,7 @@ true if connected</p>
|
||||
<h2 id="on">on</h2>
|
||||
<p>▸ <strong>on</strong>(type: <em><a href="../modules/_types_.md#providerinterface_emitted">ProviderInterface$Emitted</a></em>, sub: <em><a href="../modules/_types_.md#providerinterface_emitcb">ProviderInterface$EmitCb</a></em>): <code>void</code></p>
|
||||
<p><em>Implementation of <a href="../interfaces/_types_.providerinterface.md">ProviderInterface</a>.<a href="../interfaces/_types_.providerinterface.md#on">on</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/http/index.ts#L71" target="_blank">http/index.ts:71</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/http/index.ts#L71" target="_blank">http/index.ts:71</a></em></p>
|
||||
<p><em><strong>summary</strong></em>: Events are not supported with the HttpProvider, see <a href="_ws_index_.wsprovider.html">WsProvider</a>.</p>
|
||||
<p><em><strong>description</strong></em>: HTTP Provider does not have 'on' emitters. WebSockets should be used instead.</p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
@@ -2079,7 +2079,7 @@ true if connected</p>
|
||||
<h2 id="send">send</h2>
|
||||
<p>▸ <strong>send</strong>(method: <em><code>string</code></em>, params: <em><code>Array</code><<code>any</code>></em>): <code>Promise</code><<code>any</code>></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/07d6139/packages/rpc-provider/src/http/index.ts#L78" target="_blank">http/index.ts:78</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/http/index.ts#L78" target="_blank">http/index.ts:78</a></em></p>
|
||||
<p><em><strong>summary</strong></em>: Send HTTP POST Request with Body to configured HTTP Endpoint.</p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
@@ -2106,7 +2106,7 @@ true if connected</p>
|
||||
<h2 id="subscribe">subscribe</h2>
|
||||
<p>▸ <strong>subscribe</strong>(types: <em><code>string</code></em>, method: <em><code>string</code></em>, params: <em><code>Array</code><<code>any</code>></em>, cb: <em><a href="../modules/_types_.md#providerinterface_callback">ProviderInterface$Callback</a></em>): <code>Promise</code><<code>number</code>></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/07d6139/packages/rpc-provider/src/http/index.ts#L100" target="_blank">http/index.ts:100</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/http/index.ts#L100" target="_blank">http/index.ts:100</a></em></p>
|
||||
<p><em><strong>summary</strong></em>: Subscriptions are not supported with the HttpProvider, see <a href="_ws_index_.wsprovider.html">WsProvider</a>.</p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
@@ -2141,7 +2141,7 @@ true if connected</p>
|
||||
<h2 id="unsubscribe">unsubscribe</h2>
|
||||
<p>▸ <strong>unsubscribe</strong>(type: <em><code>string</code></em>, method: <em><code>string</code></em>, id: <em><code>number</code></em>): <code>Promise</code><<code>boolean</code>></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/07d6139/packages/rpc-provider/src/http/index.ts#L109" target="_blank">http/index.ts:109</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/http/index.ts#L109" target="_blank">http/index.ts:109</a></em></p>
|
||||
<p><em><strong>summary</strong></em>: Subscriptions are not supported with the HttpProvider, see <a href="_ws_index_.wsprovider.html">WsProvider</a>.</p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
@@ -2211,7 +2211,7 @@ true if connected</p>
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"HttpProvider","level":"1.3.1","depth":2,"next":{"title":"WsProvider","level":"1.3.2","depth":2,"path":"rpc-provider/classes/_ws_index_.wsprovider.md","ref":"rpc-provider/classes/_ws_index_.wsprovider.md","articles":[]},"previous":{"title":"rpc-provider","level":"1.3","depth":1,"path":"rpc-provider/README.md","ref":"rpc-provider/README.md","articles":[{"title":"HttpProvider","level":"1.3.1","depth":2,"path":"rpc-provider/classes/_http_index_.httpprovider.md","ref":"rpc-provider/classes/_http_index_.httpprovider.md","articles":[]},{"title":"WsProvider","level":"1.3.2","depth":2,"path":"rpc-provider/classes/_ws_index_.wsprovider.md","ref":"rpc-provider/classes/_ws_index_.wsprovider.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"rpc-provider/classes/_http_index_.httpprovider.md","mtime":"2019-01-10T10:41:28.019Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-10T10:42:38.095Z"},"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-01-10T16:42:59.951Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-10T16:44:09.217Z"},"basePath":"../..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -34,7 +34,7 @@ const api = new Api(provider);
|
||||
|
||||
⊕ **new HttpProvider**(endpoint?: *`string`*): [HttpProvider](_http_index_.httpprovider.md)
|
||||
|
||||
*Defined in [http/index.ts:40](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/http/index.ts#L40)*
|
||||
*Defined in [http/index.ts:40](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/http/index.ts#L40)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -54,7 +54,7 @@ ___
|
||||
|
||||
gethasSubscriptions(): `boolean`
|
||||
|
||||
*Defined in [http/index.ts:55](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/http/index.ts#L55)*
|
||||
*Defined in [http/index.ts:55](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/http/index.ts#L55)*
|
||||
|
||||
*__summary__*: `true` when this provider supports subscriptions
|
||||
|
||||
@@ -72,7 +72,7 @@ ___
|
||||
|
||||
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[isConnected](../interfaces/_types_.providerinterface.md#isconnected)*
|
||||
|
||||
*Defined in [http/index.ts:63](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/http/index.ts#L63)*
|
||||
*Defined in [http/index.ts:63](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/http/index.ts#L63)*
|
||||
|
||||
*__summary__*: Whether the node is connected or not.
|
||||
|
||||
@@ -88,7 +88,7 @@ ___
|
||||
|
||||
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[on](../interfaces/_types_.providerinterface.md#on)*
|
||||
|
||||
*Defined in [http/index.ts:71](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/http/index.ts#L71)*
|
||||
*Defined in [http/index.ts:71](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/http/index.ts#L71)*
|
||||
|
||||
*__summary__*: Events are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md).
|
||||
|
||||
@@ -112,7 +112,7 @@ ___
|
||||
|
||||
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[send](../interfaces/_types_.providerinterface.md#send)*
|
||||
|
||||
*Defined in [http/index.ts:78](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/http/index.ts#L78)*
|
||||
*Defined in [http/index.ts:78](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/http/index.ts#L78)*
|
||||
|
||||
*__summary__*: Send HTTP POST Request with Body to configured HTTP Endpoint.
|
||||
|
||||
@@ -134,7 +134,7 @@ ___
|
||||
|
||||
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[subscribe](../interfaces/_types_.providerinterface.md#subscribe)*
|
||||
|
||||
*Defined in [http/index.ts:100](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/http/index.ts#L100)*
|
||||
*Defined in [http/index.ts:100](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/http/index.ts#L100)*
|
||||
|
||||
*__summary__*: Subscriptions are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md).
|
||||
|
||||
@@ -158,7 +158,7 @@ ___
|
||||
|
||||
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[unsubscribe](../interfaces/_types_.providerinterface.md#unsubscribe)*
|
||||
|
||||
*Defined in [http/index.ts:109](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/http/index.ts#L109)*
|
||||
*Defined in [http/index.ts:109](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/http/index.ts#L109)*
|
||||
|
||||
*__summary__*: Subscriptions are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md).
|
||||
|
||||
|
||||
@@ -19,7 +19,7 @@ A mock provider mainly used for testing.
|
||||
|
||||
⊕ **new Mock**(): [Mock](_mock_index_.mock.md)
|
||||
|
||||
*Defined in [mock/index.ts:68](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/mock/index.ts#L68)*
|
||||
*Defined in [mock/index.ts:68](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/mock/index.ts#L68)*
|
||||
|
||||
**Returns:** [Mock](_mock_index_.mock.md)
|
||||
|
||||
@@ -33,7 +33,7 @@ ___
|
||||
|
||||
**● isUpdating**: *`boolean`* = true
|
||||
|
||||
*Defined in [mock/index.ts:43](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/mock/index.ts#L43)*
|
||||
*Defined in [mock/index.ts:43](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/mock/index.ts#L43)*
|
||||
|
||||
___
|
||||
<a id="subscriptions"></a>
|
||||
@@ -49,7 +49,7 @@ ___
|
||||
return subs;
|
||||
}, ({} as MockState$Subscriptions))
|
||||
|
||||
*Defined in [mock/index.ts:57](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/mock/index.ts#L57)*
|
||||
*Defined in [mock/index.ts:57](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/mock/index.ts#L57)*
|
||||
|
||||
___
|
||||
|
||||
@@ -61,7 +61,7 @@ ___
|
||||
|
||||
gethasSubscriptions(): `boolean`
|
||||
|
||||
*Defined in [mock/index.ts:74](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/mock/index.ts#L74)*
|
||||
*Defined in [mock/index.ts:74](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/mock/index.ts#L74)*
|
||||
|
||||
**Returns:** `boolean`
|
||||
|
||||
@@ -77,7 +77,7 @@ ___
|
||||
|
||||
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[isConnected](../interfaces/_types_.providerinterface.md#isconnected)*
|
||||
|
||||
*Defined in [mock/index.ts:78](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/mock/index.ts#L78)*
|
||||
*Defined in [mock/index.ts:78](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/mock/index.ts#L78)*
|
||||
|
||||
**Returns:** `boolean`
|
||||
|
||||
@@ -90,7 +90,7 @@ ___
|
||||
|
||||
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[on](../interfaces/_types_.providerinterface.md#on)*
|
||||
|
||||
*Defined in [mock/index.ts:82](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/mock/index.ts#L82)*
|
||||
*Defined in [mock/index.ts:82](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/mock/index.ts#L82)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -110,7 +110,7 @@ ___
|
||||
|
||||
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[send](../interfaces/_types_.providerinterface.md#send)*
|
||||
|
||||
*Defined in [mock/index.ts:86](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/mock/index.ts#L86)*
|
||||
*Defined in [mock/index.ts:86](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/mock/index.ts#L86)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -128,7 +128,7 @@ ___
|
||||
|
||||
▸ **subscribe**(type: *`string`*, method: *`string`*, ...params: *`Array`<`any`>*): `Promise`<`number`>
|
||||
|
||||
*Defined in [mock/index.ts:94](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/mock/index.ts#L94)*
|
||||
*Defined in [mock/index.ts:94](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/mock/index.ts#L94)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -149,7 +149,7 @@ ___
|
||||
|
||||
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[unsubscribe](../interfaces/_types_.providerinterface.md#unsubscribe)*
|
||||
|
||||
*Defined in [mock/index.ts:114](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/mock/index.ts#L114)*
|
||||
*Defined in [mock/index.ts:114](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/mock/index.ts#L114)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -2007,7 +2007,7 @@
|
||||
<p><a id="constructor"></a></p>
|
||||
<h2 id="constructor">constructor</h2>
|
||||
<p>⊕ <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/07d6139/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/2a2df9a/packages/rpc-provider/src/ws/index.ts#L75" target="_blank">ws/index.ts:75</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -2039,7 +2039,7 @@
|
||||
<p><a id="hassubscriptions"></a></p>
|
||||
<h2 id="hassubscriptions">hasSubscriptions</h2>
|
||||
<p>gethasSubscriptions(): <code>boolean</code></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/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/2a2df9a/packages/rpc-provider/src/ws/index.ts#L101" target="_blank">ws/index.ts:101</a></em></p>
|
||||
<p><em><strong>summary</strong></em>: <code>true</code> when this provider supports subscriptions</p>
|
||||
<p><strong>Returns:</strong> <code>boolean</code></p>
|
||||
<hr>
|
||||
@@ -2047,7 +2047,7 @@
|
||||
<p><a id="connect"></a></p>
|
||||
<h2 id="connect">connect</h2>
|
||||
<p>▸ <strong>connect</strong>(): <code>void</code></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/ws/index.ts#L110" target="_blank">ws/index.ts:110</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/ws/index.ts#L110" target="_blank">ws/index.ts:110</a></em></p>
|
||||
<p><em><strong>summary</strong></em>: Manually connect</p>
|
||||
<p><em><strong>description</strong></em>: The <a href="_ws_index_.wsprovider.html">WsProvider</a> connects automatically by default, however if you decided otherwise, you may connect manually using this method.</p>
|
||||
<p><strong>Returns:</strong> <code>void</code></p>
|
||||
@@ -2055,7 +2055,7 @@
|
||||
<p><a id="isconnected"></a></p>
|
||||
<h2 id="isconnected">isConnected</h2>
|
||||
<p>▸ <strong>isConnected</strong>(): <code>boolean</code></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/ws/index.ts#L127" target="_blank">ws/index.ts:127</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/ws/index.ts#L127" target="_blank">ws/index.ts:127</a></em></p>
|
||||
<p><em><strong>summary</strong></em>: Whether the node is connected or not.</p>
|
||||
<p><strong>Returns:</strong> <code>boolean</code>
|
||||
true if connected</p>
|
||||
@@ -2063,7 +2063,7 @@ true if connected</p>
|
||||
<p><a id="on"></a></p>
|
||||
<h2 id="on">on</h2>
|
||||
<p>▸ <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/07d6139/packages/rpc-provider/src/ws/index.ts#L136" target="_blank">ws/index.ts:136</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/ws/index.ts#L136" target="_blank">ws/index.ts:136</a></em></p>
|
||||
<p><em><strong>summary</strong></em>: Listens on events after having subscribed using the <a href="_ws_index_.wsprovider.html#subscribe">subscribe</a> function.</p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
@@ -2092,7 +2092,7 @@ true if connected</p>
|
||||
<p><a id="send"></a></p>
|
||||
<h2 id="send">send</h2>
|
||||
<p>▸ <strong>send</strong>(method: <em><code>string</code></em>, params: <em><code>Array</code><<code>any</code>></em>, subscription?: <em><code>SubscriptionHandler</code></em>): <code>Promise</code><<code>any</code>></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/ws/index.ts#L146" target="_blank">ws/index.ts:146</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/ws/index.ts#L146" target="_blank">ws/index.ts:146</a></em></p>
|
||||
<p><em><strong>summary</strong></em>: Send JSON data using WebSockets to configured HTTP Endpoint or queue.</p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
@@ -2126,7 +2126,7 @@ true if connected</p>
|
||||
<p><a id="subscribe"></a></p>
|
||||
<h2 id="subscribe">subscribe</h2>
|
||||
<p>▸ <strong>subscribe</strong>(type: <em><code>string</code></em>, method: <em><code>string</code></em>, params: <em><code>Array</code><<code>any</code>></em>, callback: <em><a href="../modules/_types_.md#providerinterface_callback">ProviderInterface$Callback</a></em>): <code>Promise</code><<code>number</code>></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/ws/index.ts#L200" target="_blank">ws/index.ts:200</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/ws/index.ts#L200" target="_blank">ws/index.ts:200</a></em></p>
|
||||
<p><em><strong>name</strong></em>: subscribe</p>
|
||||
<p><em><strong>summary</strong></em>: Allows subscribing to a specific event.</p>
|
||||
<p><em><strong>example</strong></em>: </p>
|
||||
@@ -2177,7 +2177,7 @@ Promise resolving to the dd of the subscription you can use with [[unsubscribe]]
|
||||
<p><a id="unsubscribe"></a></p>
|
||||
<h2 id="unsubscribe">unsubscribe</h2>
|
||||
<p>▸ <strong>unsubscribe</strong>(type: <em><code>string</code></em>, method: <em><code>string</code></em>, id: <em><code>number</code></em>): <code>Promise</code><<code>boolean</code>></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/ws/index.ts#L209" target="_blank">ws/index.ts:209</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/ws/index.ts#L209" target="_blank">ws/index.ts:209</a></em></p>
|
||||
<p><em><strong>summary</strong></em>: Allows unsubscribing to subscriptions made with <a href="_ws_index_.wsprovider.html#subscribe">subscribe</a>.</p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
@@ -2247,7 +2247,7 @@ Promise resolving to the dd of the subscription you can use with [[unsubscribe]]
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"WsProvider","level":"1.3.2","depth":2,"next":{"title":"types (codec implementation)","level":"1.4","depth":1,"path":"types/README.md","ref":"types/README.md","articles":[]},"previous":{"title":"HttpProvider","level":"1.3.1","depth":2,"path":"rpc-provider/classes/_http_index_.httpprovider.md","ref":"rpc-provider/classes/_http_index_.httpprovider.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"rpc-provider/classes/_ws_index_.wsprovider.md","mtime":"2019-01-10T10:41:28.115Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-10T10:42:38.095Z"},"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-01-10T16:43:00.055Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-10T16:44:09.217Z"},"basePath":"../..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -34,7 +34,7 @@ const api = new Api(provider);
|
||||
|
||||
⊕ **new WsProvider**(endpoint?: *`string`*, autoConnect?: *`boolean`*): [WsProvider](_ws_index_.wsprovider.md)
|
||||
|
||||
*Defined in [ws/index.ts:75](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/ws/index.ts#L75)*
|
||||
*Defined in [ws/index.ts:75](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/ws/index.ts#L75)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -55,7 +55,7 @@ ___
|
||||
|
||||
gethasSubscriptions(): `boolean`
|
||||
|
||||
*Defined in [ws/index.ts:101](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/ws/index.ts#L101)*
|
||||
*Defined in [ws/index.ts:101](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/ws/index.ts#L101)*
|
||||
|
||||
*__summary__*: `true` when this provider supports subscriptions
|
||||
|
||||
@@ -71,7 +71,7 @@ ___
|
||||
|
||||
▸ **connect**(): `void`
|
||||
|
||||
*Defined in [ws/index.ts:110](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/ws/index.ts#L110)*
|
||||
*Defined in [ws/index.ts:110](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/ws/index.ts#L110)*
|
||||
|
||||
*__summary__*: Manually connect
|
||||
|
||||
@@ -86,7 +86,7 @@ ___
|
||||
|
||||
▸ **isConnected**(): `boolean`
|
||||
|
||||
*Defined in [ws/index.ts:127](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/ws/index.ts#L127)*
|
||||
*Defined in [ws/index.ts:127](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/ws/index.ts#L127)*
|
||||
|
||||
*__summary__*: Whether the node is connected or not.
|
||||
|
||||
@@ -100,7 +100,7 @@ ___
|
||||
|
||||
▸ **on**(type: *[ProviderInterface$Emitted](../modules/_types_.md#providerinterface_emitted)*, sub: *[ProviderInterface$EmitCb](../modules/_types_.md#providerinterface_emitcb)*): `void`
|
||||
|
||||
*Defined in [ws/index.ts:136](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/ws/index.ts#L136)*
|
||||
*Defined in [ws/index.ts:136](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/ws/index.ts#L136)*
|
||||
|
||||
*__summary__*: Listens on events after having subscribed using the [subscribe](_ws_index_.wsprovider.md#subscribe) function.
|
||||
|
||||
@@ -120,7 +120,7 @@ ___
|
||||
|
||||
▸ **send**(method: *`string`*, params: *`Array`<`any`>*, subscription?: *`SubscriptionHandler`*): `Promise`<`any`>
|
||||
|
||||
*Defined in [ws/index.ts:146](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/ws/index.ts#L146)*
|
||||
*Defined in [ws/index.ts:146](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/ws/index.ts#L146)*
|
||||
|
||||
*__summary__*: Send JSON data using WebSockets to configured HTTP Endpoint or queue.
|
||||
|
||||
@@ -141,7 +141,7 @@ ___
|
||||
|
||||
▸ **subscribe**(type: *`string`*, method: *`string`*, params: *`Array`<`any`>*, callback: *[ProviderInterface$Callback](../modules/_types_.md#providerinterface_callback)*): `Promise`<`number`>
|
||||
|
||||
*Defined in [ws/index.ts:200](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/ws/index.ts#L200)*
|
||||
*Defined in [ws/index.ts:200](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/ws/index.ts#L200)*
|
||||
|
||||
*__name__*: subscribe
|
||||
|
||||
@@ -179,7 +179,7 @@ ___
|
||||
|
||||
▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`>
|
||||
|
||||
*Defined in [ws/index.ts:209](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/ws/index.ts#L209)*
|
||||
*Defined in [ws/index.ts:209](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/ws/index.ts#L209)*
|
||||
|
||||
*__summary__*: Allows unsubscribing to subscriptions made with [subscribe](_ws_index_.wsprovider.md#subscribe).
|
||||
|
||||
|
||||
@@ -2055,7 +2055,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"rpc-provider","level":"1.3","depth":1,"next":{"title":"HttpProvider","level":"1.3.1","depth":2,"path":"rpc-provider/classes/_http_index_.httpprovider.md","ref":"rpc-provider/classes/_http_index_.httpprovider.md","articles":[]},"previous":{"title":"ApiRx","level":"1.2.2","depth":2,"path":"api/classes/_rx_index_.apirx.md","ref":"api/classes/_rx_index_.apirx.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"rpc-provider/README.md","mtime":"2019-01-10T10:41:27.835Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-10T10:42:38.095Z"},"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-01-10T16:42:59.763Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-10T16:44:09.217Z"},"basePath":"..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -17,7 +17,7 @@
|
||||
|
||||
**● hasSubscriptions**: *`boolean`*
|
||||
|
||||
*Defined in [types.ts:45](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/types.ts#L45)*
|
||||
*Defined in [types.ts:45](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/types.ts#L45)*
|
||||
|
||||
___
|
||||
|
||||
@@ -29,7 +29,7 @@ ___
|
||||
|
||||
▸ **isConnected**(): `boolean`
|
||||
|
||||
*Defined in [types.ts:46](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/types.ts#L46)*
|
||||
*Defined in [types.ts:46](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/types.ts#L46)*
|
||||
|
||||
**Returns:** `boolean`
|
||||
|
||||
@@ -40,7 +40,7 @@ ___
|
||||
|
||||
▸ **on**(type: *[ProviderInterface$Emitted](../modules/_types_.md#providerinterface_emitted)*, sub: *[ProviderInterface$EmitCb](../modules/_types_.md#providerinterface_emitcb)*): `void`
|
||||
|
||||
*Defined in [types.ts:47](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/types.ts#L47)*
|
||||
*Defined in [types.ts:47](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/types.ts#L47)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -58,7 +58,7 @@ ___
|
||||
|
||||
▸ **send**(method: *`string`*, params: *`Array`<`any`>*): `Promise`<`any`>
|
||||
|
||||
*Defined in [types.ts:48](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/types.ts#L48)*
|
||||
*Defined in [types.ts:48](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/types.ts#L48)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -76,7 +76,7 @@ ___
|
||||
|
||||
▸ **subscribe**(type: *`string`*, method: *`string`*, params: *`Array`<`any`>*, cb: *[ProviderInterface$Callback](../modules/_types_.md#providerinterface_callback)*): `Promise`<`number`>
|
||||
|
||||
*Defined in [types.ts:49](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/types.ts#L49)*
|
||||
*Defined in [types.ts:49](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/types.ts#L49)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -96,7 +96,7 @@ ___
|
||||
|
||||
▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`>
|
||||
|
||||
*Defined in [types.ts:50](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/types.ts#L50)*
|
||||
*Defined in [types.ts:50](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/types.ts#L50)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
**Ƭ HttpState**: *`object`*
|
||||
|
||||
*Defined in [http/types.ts:9](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/http/types.ts#L9)*
|
||||
*Defined in [http/types.ts:9](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/http/types.ts#L9)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
**Ƭ MockState$Db**: *`object`*
|
||||
|
||||
*Defined in [mock/types.ts:16](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/mock/types.ts#L16)*
|
||||
*Defined in [mock/types.ts:16](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/mock/types.ts#L16)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
@@ -21,7 +21,7 @@ ___
|
||||
|
||||
**Ƭ MockState$Requests**: *`object`*
|
||||
|
||||
*Defined in [mock/types.ts:20](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/mock/types.ts#L20)*
|
||||
*Defined in [mock/types.ts:20](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/mock/types.ts#L20)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
@@ -45,7 +45,7 @@ ___
|
||||
|
||||
**Ƭ MockState$Subscription$Callback**: *`function`*
|
||||
|
||||
*Defined in [mock/types.ts:5](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/mock/types.ts#L5)*
|
||||
*Defined in [mock/types.ts:5](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/mock/types.ts#L5)*
|
||||
|
||||
#### Type declaration
|
||||
▸(error: *`Error` | `null`*, value: *`any`*): `void`
|
||||
@@ -66,7 +66,7 @@ ___
|
||||
|
||||
**Ƭ MockState$Subscriptions**: *`object`*
|
||||
|
||||
*Defined in [mock/types.ts:7](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/mock/types.ts#L7)*
|
||||
*Defined in [mock/types.ts:7](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/mock/types.ts#L7)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
|
||||
@@ -27,7 +27,7 @@
|
||||
|
||||
**Ƭ JsonRpcObject**: *`object`*
|
||||
|
||||
*Defined in [types.ts:5](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/types.ts#L5)*
|
||||
*Defined in [types.ts:5](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/types.ts#L5)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
@@ -38,7 +38,7 @@ ___
|
||||
|
||||
**Ƭ JsonRpcRequest**: *[JsonRpcObject](_types_.md#jsonrpcobject) & `object`*
|
||||
|
||||
*Defined in [types.ts:10](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/types.ts#L10)*
|
||||
*Defined in [types.ts:10](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/types.ts#L10)*
|
||||
|
||||
___
|
||||
<a id="jsonrpcresponse"></a>
|
||||
@@ -47,7 +47,7 @@ ___
|
||||
|
||||
**Ƭ JsonRpcResponse**: *[JsonRpcObject](_types_.md#jsonrpcobject) & [JsonRpcResponseBase](_types_.md#jsonrpcresponsebase)*
|
||||
|
||||
*Defined in [types.ts:36](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/types.ts#L36)*
|
||||
*Defined in [types.ts:36](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/types.ts#L36)*
|
||||
|
||||
___
|
||||
<a id="jsonrpcresponsebase"></a>
|
||||
@@ -56,7 +56,7 @@ ___
|
||||
|
||||
**Ƭ JsonRpcResponseBase**: *`JsonRpcResponse$Single` & `JsonRpcResponse$Subscription`*
|
||||
|
||||
*Defined in [types.ts:34](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/types.ts#L34)*
|
||||
*Defined in [types.ts:34](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/types.ts#L34)*
|
||||
|
||||
___
|
||||
<a id="jsonrpcresponsebase_error"></a>
|
||||
@@ -65,7 +65,7 @@ ___
|
||||
|
||||
**Ƭ JsonRpcResponseBase$Error**: *`object`*
|
||||
|
||||
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/types.ts#L15)*
|
||||
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/types.ts#L15)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
@@ -76,7 +76,7 @@ ___
|
||||
|
||||
**Ƭ ProviderInterface$Callback**: *`function`*
|
||||
|
||||
*Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/types.ts#L38)*
|
||||
*Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/types.ts#L38)*
|
||||
|
||||
#### Type declaration
|
||||
▸(result: *`any`*): `void`
|
||||
@@ -96,7 +96,7 @@ ___
|
||||
|
||||
**Ƭ ProviderInterface$EmitCb**: *`function`*
|
||||
|
||||
*Defined in [types.ts:42](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/types.ts#L42)*
|
||||
*Defined in [types.ts:42](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/types.ts#L42)*
|
||||
|
||||
#### Type declaration
|
||||
▸(value?: *`any`*): `any`
|
||||
@@ -116,7 +116,7 @@ ___
|
||||
|
||||
**Ƭ ProviderInterface$Emitted**: *"connected" | "disconnected" | "error"*
|
||||
|
||||
*Defined in [types.ts:40](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-provider/src/types.ts#L40)*
|
||||
*Defined in [types.ts:40](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-provider/src/types.ts#L40)*
|
||||
|
||||
___
|
||||
|
||||
|
||||
@@ -32,7 +32,7 @@ const api = new RpcRx(provider);
|
||||
|
||||
⊕ **new RpcRx**(providerOrRpc?: *`Rpc` | `ProviderInterface`*): [RpcRx](_index_.rpcrx.md)
|
||||
|
||||
*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-rx/src/index.ts#L45)*
|
||||
*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-rx/src/index.ts#L45)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -52,7 +52,7 @@ ___
|
||||
|
||||
**● author**: *[RpcRxInterface$Section](../modules/_types_.md#rpcrxinterface_section)*
|
||||
|
||||
*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-rx/src/index.ts#L42)*
|
||||
*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-rx/src/index.ts#L42)*
|
||||
|
||||
___
|
||||
<a id="chain"></a>
|
||||
@@ -61,7 +61,7 @@ ___
|
||||
|
||||
**● chain**: *[RpcRxInterface$Section](../modules/_types_.md#rpcrxinterface_section)*
|
||||
|
||||
*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-rx/src/index.ts#L43)*
|
||||
*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-rx/src/index.ts#L43)*
|
||||
|
||||
___
|
||||
<a id="state"></a>
|
||||
@@ -70,7 +70,7 @@ ___
|
||||
|
||||
**● state**: *[RpcRxInterface$Section](../modules/_types_.md#rpcrxinterface_section)*
|
||||
|
||||
*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-rx/src/index.ts#L44)*
|
||||
*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-rx/src/index.ts#L44)*
|
||||
|
||||
___
|
||||
<a id="system"></a>
|
||||
@@ -79,7 +79,7 @@ ___
|
||||
|
||||
**● system**: *[RpcRxInterface$Section](../modules/_types_.md#rpcrxinterface_section)*
|
||||
|
||||
*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-rx/src/index.ts#L45)*
|
||||
*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-rx/src/index.ts#L45)*
|
||||
|
||||
___
|
||||
|
||||
@@ -91,7 +91,7 @@ ___
|
||||
|
||||
▸ **isConnected**(): `BehaviorSubject`<`boolean`>
|
||||
|
||||
*Defined in [index.ts:66](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-rx/src/index.ts#L66)*
|
||||
*Defined in [index.ts:66](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-rx/src/index.ts#L66)*
|
||||
|
||||
**Returns:** `BehaviorSubject`<`boolean`>
|
||||
|
||||
@@ -102,7 +102,7 @@ ___
|
||||
|
||||
▸ **on**(type: *[RpcRxInterface$Events](../modules/_types_.md#rpcrxinterface_events)*, handler: *`function`*): `void`
|
||||
|
||||
*Defined in [index.ts:70](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-rx/src/index.ts#L70)*
|
||||
*Defined in [index.ts:70](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-rx/src/index.ts#L70)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
**Ƭ RpcRxInterface**: *`object`*
|
||||
|
||||
*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-rx/src/types.ts#L16)*
|
||||
*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-rx/src/types.ts#L16)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
@@ -19,7 +19,7 @@ ___
|
||||
|
||||
**Ƭ RpcRxInterface$Events**: *`ProviderInterface$Emitted`*
|
||||
|
||||
*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-rx/src/types.ts#L14)*
|
||||
*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-rx/src/types.ts#L14)*
|
||||
|
||||
___
|
||||
<a id="rpcrxinterface_method"></a>
|
||||
@@ -28,7 +28,7 @@ ___
|
||||
|
||||
**Ƭ RpcRxInterface$Method**: *`function`*
|
||||
|
||||
*Defined in [types.ts:8](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-rx/src/types.ts#L8)*
|
||||
*Defined in [types.ts:8](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-rx/src/types.ts#L8)*
|
||||
|
||||
#### Type declaration
|
||||
▸(...params: *`Array`<`any`>*): `Observable`<`any`> | `ReplaySubject`<`any`>
|
||||
@@ -48,7 +48,7 @@ ___
|
||||
|
||||
**Ƭ RpcRxInterface$Section**: *`object`*
|
||||
|
||||
*Defined in [types.ts:10](https://github.com/polkadot-js/api/blob/07d6139/packages/rpc-rx/src/types.ts#L10)*
|
||||
*Defined in [types.ts:10](https://github.com/polkadot-js/api/blob/2a2df9a/packages/rpc-rx/src/types.ts#L10)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
▸ **fromMetadata**(metadata: *`Metadata`*): `ModulesWithMethods`
|
||||
|
||||
*Defined in [fromMetadata.ts:21](https://github.com/polkadot-js/api/blob/07d6139/packages/type-extrinsics/src/fromMetadata.ts#L21)*
|
||||
*Defined in [fromMetadata.ts:21](https://github.com/polkadot-js/api/blob/2a2df9a/packages/type-extrinsics/src/fromMetadata.ts#L21)*
|
||||
|
||||
Extend a storage object with the storage modules & module functions present in the metadata.
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
▸ **createDescriptor**(section: *`string`*, method: *`string`*, index: *`number`*, meta: *`FunctionMetadata`*): `MethodFunction`
|
||||
|
||||
*Defined in [utils/createUnchecked.ts:16](https://github.com/polkadot-js/api/blob/07d6139/packages/type-extrinsics/src/utils/createUnchecked.ts#L16)*
|
||||
*Defined in [utils/createUnchecked.ts:16](https://github.com/polkadot-js/api/blob/2a2df9a/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.
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
▸ **createMethod**(section: *`string`*, method: *`string`*, __namedParameters: *`object`*): [RpcMethod](_types_.md#rpcmethod)
|
||||
|
||||
*Defined in [create/method.ts:9](https://github.com/polkadot-js/api/blob/07d6139/packages/type-jsonrpc/src/create/method.ts#L9)*
|
||||
*Defined in [create/method.ts:9](https://github.com/polkadot-js/api/blob/2a2df9a/packages/type-jsonrpc/src/create/method.ts#L9)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
▸ **createParam**(name: *`string`*, type: *`CodecTypes`*, __namedParameters?: *`object`*): [RpcParam](_types_.md#rpcparam)
|
||||
|
||||
*Defined in [create/param.ts:12](https://github.com/polkadot-js/api/blob/07d6139/packages/type-jsonrpc/src/create/param.ts#L12)*
|
||||
*Defined in [create/param.ts:12](https://github.com/polkadot-js/api/blob/2a2df9a/packages/type-jsonrpc/src/create/param.ts#L12)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
**Ƭ RpcMethod**: *`object`*
|
||||
|
||||
*Defined in [types.ts:24](https://github.com/polkadot-js/api/blob/07d6139/packages/type-jsonrpc/src/types.ts#L24)*
|
||||
*Defined in [types.ts:24](https://github.com/polkadot-js/api/blob/2a2df9a/packages/type-jsonrpc/src/types.ts#L24)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
@@ -19,7 +19,7 @@ ___
|
||||
|
||||
**Ƭ RpcMethodOpt**: *`object`*
|
||||
|
||||
*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/07d6139/packages/type-jsonrpc/src/types.ts#L13)*
|
||||
*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/2a2df9a/packages/type-jsonrpc/src/types.ts#L13)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
@@ -30,7 +30,7 @@ ___
|
||||
|
||||
**Ƭ RpcParam**: *`object`*
|
||||
|
||||
*Defined in [types.ts:7](https://github.com/polkadot-js/api/blob/07d6139/packages/type-jsonrpc/src/types.ts#L7)*
|
||||
*Defined in [types.ts:7](https://github.com/polkadot-js/api/blob/2a2df9a/packages/type-jsonrpc/src/types.ts#L7)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
@@ -41,7 +41,7 @@ ___
|
||||
|
||||
**Ƭ RpcSection**: *`object`*
|
||||
|
||||
*Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/07d6139/packages/type-jsonrpc/src/types.ts#L38)*
|
||||
*Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/2a2df9a/packages/type-jsonrpc/src/types.ts#L38)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
|
||||
**● substrate**: *`object`*
|
||||
|
||||
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/07d6139/packages/type-storage/src/types.ts#L17)*
|
||||
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/2a2df9a/packages/type-storage/src/types.ts#L17)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@
|
||||
|
||||
**● isUnhashed**: *`undefined` | `false` | `true`*
|
||||
|
||||
*Defined in [utils/createFunction.ts:14](https://github.com/polkadot-js/api/blob/07d6139/packages/type-storage/src/utils/createFunction.ts#L14)*
|
||||
*Defined in [utils/createFunction.ts:14](https://github.com/polkadot-js/api/blob/2a2df9a/packages/type-storage/src/utils/createFunction.ts#L14)*
|
||||
|
||||
___
|
||||
<a id="key"></a>
|
||||
@@ -21,7 +21,7 @@ ___
|
||||
|
||||
**● key**: *`undefined` | `string`*
|
||||
|
||||
*Defined in [utils/createFunction.ts:15](https://github.com/polkadot-js/api/blob/07d6139/packages/type-storage/src/utils/createFunction.ts#L15)*
|
||||
*Defined in [utils/createFunction.ts:15](https://github.com/polkadot-js/api/blob/2a2df9a/packages/type-storage/src/utils/createFunction.ts#L15)*
|
||||
|
||||
___
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
▸ **fromMetadata**(metadata: *`Metadata`*): [Storage](../interfaces/_types_.storage.md)
|
||||
|
||||
*Defined in [fromMetadata.ts:20](https://github.com/polkadot-js/api/blob/07d6139/packages/type-storage/src/fromMetadata.ts#L20)*
|
||||
*Defined in [fromMetadata.ts:20](https://github.com/polkadot-js/api/blob/2a2df9a/packages/type-storage/src/fromMetadata.ts#L20)*
|
||||
|
||||
Extend a storage object with the storage modules & module functions present in the metadata.
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
**storage**: *`object`*
|
||||
|
||||
*Defined in [storage.ts:8](https://github.com/polkadot-js/api/blob/07d6139/packages/type-storage/src/storage.ts#L8)*
|
||||
*Defined in [storage.ts:8](https://github.com/polkadot-js/api/blob/2a2df9a/packages/type-storage/src/storage.ts#L8)*
|
||||
|
||||
<a id="storage.substrate"></a>
|
||||
|
||||
@@ -16,7 +16,7 @@
|
||||
|
||||
**● substrate**: *["substrate"](_substrate_.md)*
|
||||
|
||||
*Defined in [storage.ts:9](https://github.com/polkadot-js/api/blob/07d6139/packages/type-storage/src/storage.ts#L9)*
|
||||
*Defined in [storage.ts:9](https://github.com/polkadot-js/api/blob/2a2df9a/packages/type-storage/src/storage.ts#L9)*
|
||||
|
||||
___
|
||||
|
||||
|
||||
@@ -11,7 +11,7 @@
|
||||
type: 'u32'
|
||||
})
|
||||
|
||||
*Defined in [substrate.ts:45](https://github.com/polkadot-js/api/blob/07d6139/packages/type-storage/src/substrate.ts#L45)*
|
||||
*Defined in [substrate.ts:45](https://github.com/polkadot-js/api/blob/2a2df9a/packages/type-storage/src/substrate.ts#L45)*
|
||||
|
||||
___
|
||||
<a id="authorityprefix"></a>
|
||||
@@ -23,7 +23,7 @@ ___
|
||||
type: 'u32'
|
||||
})
|
||||
|
||||
*Defined in [substrate.ts:50](https://github.com/polkadot-js/api/blob/07d6139/packages/type-storage/src/substrate.ts#L50)*
|
||||
*Defined in [substrate.ts:50](https://github.com/polkadot-js/api/blob/2a2df9a/packages/type-storage/src/substrate.ts#L50)*
|
||||
|
||||
___
|
||||
<a id="changestrieconfig"></a>
|
||||
@@ -35,7 +35,7 @@ ___
|
||||
type: 'u32'
|
||||
})
|
||||
|
||||
*Defined in [substrate.ts:60](https://github.com/polkadot-js/api/blob/07d6139/packages/type-storage/src/substrate.ts#L60)*
|
||||
*Defined in [substrate.ts:60](https://github.com/polkadot-js/api/blob/2a2df9a/packages/type-storage/src/substrate.ts#L60)*
|
||||
|
||||
___
|
||||
<a id="code"></a>
|
||||
@@ -47,7 +47,7 @@ ___
|
||||
type: 'Bytes'
|
||||
})
|
||||
|
||||
*Defined in [substrate.ts:35](https://github.com/polkadot-js/api/blob/07d6139/packages/type-storage/src/substrate.ts#L35)*
|
||||
*Defined in [substrate.ts:35](https://github.com/polkadot-js/api/blob/2a2df9a/packages/type-storage/src/substrate.ts#L35)*
|
||||
|
||||
___
|
||||
<a id="extrinsicindex"></a>
|
||||
@@ -59,7 +59,7 @@ ___
|
||||
type: 'u32'
|
||||
})
|
||||
|
||||
*Defined in [substrate.ts:55](https://github.com/polkadot-js/api/blob/07d6139/packages/type-storage/src/substrate.ts#L55)*
|
||||
*Defined in [substrate.ts:55](https://github.com/polkadot-js/api/blob/2a2df9a/packages/type-storage/src/substrate.ts#L55)*
|
||||
|
||||
___
|
||||
<a id="heappages"></a>
|
||||
@@ -71,7 +71,7 @@ ___
|
||||
type: 'u64'
|
||||
})
|
||||
|
||||
*Defined in [substrate.ts:40](https://github.com/polkadot-js/api/blob/07d6139/packages/type-storage/src/substrate.ts#L40)*
|
||||
*Defined in [substrate.ts:40](https://github.com/polkadot-js/api/blob/2a2df9a/packages/type-storage/src/substrate.ts#L40)*
|
||||
|
||||
___
|
||||
|
||||
|
||||
@@ -20,7 +20,7 @@
|
||||
|
||||
▸ **createFunction**(section: *`Text` | `string`*, method: *`Text` | `string`*, meta: *`StorageFunctionMetadata`*, options?: *[CreateItemOptions](../interfaces/_utils_createfunction_.createitemoptions.md)*): `StorageFunction`
|
||||
|
||||
*Defined in [utils/createFunction.ts:28](https://github.com/polkadot-js/api/blob/07d6139/packages/type-storage/src/utils/createFunction.ts#L28)*
|
||||
*Defined in [utils/createFunction.ts:28](https://github.com/polkadot-js/api/blob/2a2df9a/packages/type-storage/src/utils/createFunction.ts#L28)*
|
||||
|
||||
From the schema of a function in the module's storage, generate the function that will return the correct storage key.
|
||||
|
||||
|
||||
@@ -2003,7 +2003,7 @@
|
||||
<h2 id="constructor">constructor</h2>
|
||||
<p>⊕ <strong>new AccountId</strong>(value?: <em><a href="../modules/_types_.md#anyu8a">AnyU8a</a></em>): <a href="_accountid_.accountid.html">AccountId</a></p>
|
||||
<p><em>Overrides <a href="_codec_u8afixed_.u8afixed.html">U8aFixed</a>.<a href="_codec_u8afixed_.u8afixed.html#constructor">constructor</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/AccountId.ts#L19" target="_blank">AccountId.ts:19</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/AccountId.ts#L19" target="_blank">AccountId.ts:19</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -2028,7 +2028,7 @@
|
||||
<h2 id="encodedlength">encodedLength</h2>
|
||||
<p>getencodedLength(): <code>number</code></p>
|
||||
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#encodedlength">encodedLength</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/codec/U8a.ts#L36" target="_blank">codec/U8a.ts:36</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/codec/U8a.ts#L36" target="_blank">codec/U8a.ts:36</a></em></p>
|
||||
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
|
||||
<p><strong>Returns:</strong> <code>number</code></p>
|
||||
<hr>
|
||||
@@ -2037,7 +2037,7 @@
|
||||
<p>getlength(): <code>number</code></p>
|
||||
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#length">length</a></em></p>
|
||||
<p><em>Overrides Uint8Array.length</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/codec/U8a.ts#L43" target="_blank">codec/U8a.ts:43</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/codec/U8a.ts#L43" target="_blank">codec/U8a.ts:43</a></em></p>
|
||||
<p><em><strong>description</strong></em>: The length of the value</p>
|
||||
<p><strong>Returns:</strong> <code>number</code></p>
|
||||
<hr>
|
||||
@@ -2046,7 +2046,7 @@
|
||||
<h2 id="bitlength">bitLength</h2>
|
||||
<p>▸ <strong>bitLength</strong>(): <code>number</code></p>
|
||||
<p><em>Inherited from <a href="_codec_u8afixed_.u8afixed.html">U8aFixed</a>.<a href="_codec_u8afixed_.u8afixed.html#bitlength">bitLength</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/codec/U8aFixed.ts#L39" target="_blank">codec/U8aFixed.ts:39</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/codec/U8aFixed.ts#L39" target="_blank">codec/U8aFixed.ts:39</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Returns the number of bits in the value</p>
|
||||
<p><strong>Returns:</strong> <code>number</code></p>
|
||||
<hr>
|
||||
@@ -2055,7 +2055,7 @@
|
||||
<p>▸ <strong>subarray</strong>(begin: <em><code>number</code></em>, end?: <em><code>undefined</code> | <code>number</code></em>): <code>Uint8Array</code></p>
|
||||
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#subarray">subarray</a></em></p>
|
||||
<p><em>Overrides Uint8Array.subarray</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/codec/U8a.ts#L53" target="_blank">codec/U8a.ts:53</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/codec/U8a.ts#L53" target="_blank">codec/U8a.ts:53</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here</p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
@@ -2087,7 +2087,7 @@
|
||||
<p>▸ <strong>toHex</strong>(): <code>string</code></p>
|
||||
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
|
||||
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#tohex">toHex</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/codec/U8a.ts#L60" target="_blank">codec/U8a.ts:60</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/codec/U8a.ts#L60" target="_blank">codec/U8a.ts:60</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
|
||||
<p><strong>Returns:</strong> <code>string</code></p>
|
||||
<hr>
|
||||
@@ -2096,7 +2096,7 @@
|
||||
<p>▸ <strong>toJSON</strong>(): <code>any</code></p>
|
||||
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
|
||||
<p><em>Overrides <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#tojson">toJSON</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/AccountId.ts#L46" target="_blank">AccountId.ts:46</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/AccountId.ts#L46" target="_blank">AccountId.ts:46</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
|
||||
<p><strong>Returns:</strong> <code>any</code></p>
|
||||
<hr>
|
||||
@@ -2105,7 +2105,7 @@
|
||||
<p>▸ <strong>toString</strong>(): <code>string</code></p>
|
||||
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
|
||||
<p><em>Overrides <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#tostring">toString</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/AccountId.ts#L53" target="_blank">AccountId.ts:53</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/AccountId.ts#L53" target="_blank">AccountId.ts:53</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
|
||||
<p><strong>Returns:</strong> <code>string</code></p>
|
||||
<hr>
|
||||
@@ -2113,7 +2113,7 @@
|
||||
<h2 id="tou8a">toU8a</h2>
|
||||
<p>▸ <strong>toU8a</strong>(isBare?: <em><code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></p>
|
||||
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#tou8a">toU8a</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/codec/U8a.ts#L82" target="_blank">codec/U8a.ts:82</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/codec/U8a.ts#L82" target="_blank">codec/U8a.ts:82</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
@@ -2139,7 +2139,7 @@
|
||||
<p><a id="encode"></a></p>
|
||||
<h2 id="static-encode"><code><Static></code> encode</h2>
|
||||
<p>▸ <strong>encode</strong>(value: <em><code>Uint8Array</code></em>): <code>string</code></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/AccountId.ts#L27" target="_blank">AccountId.ts:27</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/AccountId.ts#L27" target="_blank">AccountId.ts:27</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -2200,7 +2200,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.1","depth":1,"next":{"title":"hidden","level":"4.2","depth":1,"path":"types/classes/_accountindex_.accountindex.md","ref":"types/classes/_accountindex_.accountindex.md","articles":[]},"previous":{"title":"Upgrade via sudo","level":"3.1.8","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":"types/classes/_accountid_.accountid.md","mtime":"2019-01-10T10:41:56.623Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-10T10:42:38.095Z"},"basePath":"../..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.1","depth":1,"next":{"title":"hidden","level":"4.2","depth":1,"path":"types/classes/_accountindex_.accountindex.md","ref":"types/classes/_accountindex_.accountindex.md","articles":[]},"previous":{"title":"Upgrade via sudo","level":"3.1.8","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":"types/classes/_accountid_.accountid.md","mtime":"2019-01-10T16:43:28.483Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-10T16:44:09.217Z"},"basePath":"../..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -29,7 +29,7 @@
|
||||
|
||||
*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)*
|
||||
|
||||
*Defined in [AccountId.ts:19](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/AccountId.ts#L19)*
|
||||
*Defined in [AccountId.ts:19](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/AccountId.ts#L19)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -51,7 +51,7 @@ getencodedLength(): `number`
|
||||
|
||||
*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)*
|
||||
|
||||
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/codec/U8a.ts#L36)*
|
||||
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/codec/U8a.ts#L36)*
|
||||
|
||||
*__description__*: The length of the value when encoded as a Uint8Array
|
||||
|
||||
@@ -68,7 +68,7 @@ getlength(): `number`
|
||||
|
||||
*Overrides Uint8Array.length*
|
||||
|
||||
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/codec/U8a.ts#L43)*
|
||||
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/codec/U8a.ts#L43)*
|
||||
|
||||
*__description__*: The length of the value
|
||||
|
||||
@@ -86,7 +86,7 @@ ___
|
||||
|
||||
*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)*
|
||||
|
||||
*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/codec/U8aFixed.ts#L39)*
|
||||
*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/codec/U8aFixed.ts#L39)*
|
||||
|
||||
*__description__*: Returns the number of bits in the value
|
||||
|
||||
@@ -103,7 +103,7 @@ ___
|
||||
|
||||
*Overrides Uint8Array.subarray*
|
||||
|
||||
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/codec/U8a.ts#L53)*
|
||||
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/codec/U8a.ts#L53)*
|
||||
|
||||
*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here
|
||||
|
||||
@@ -127,7 +127,7 @@ ___
|
||||
|
||||
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
|
||||
|
||||
*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/codec/U8a.ts#L60)*
|
||||
*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/codec/U8a.ts#L60)*
|
||||
|
||||
*__description__*: Returns a hex string representation of the value
|
||||
|
||||
@@ -144,7 +144,7 @@ ___
|
||||
|
||||
*Overrides [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
|
||||
|
||||
*Defined in [AccountId.ts:46](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/AccountId.ts#L46)*
|
||||
*Defined in [AccountId.ts:46](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/AccountId.ts#L46)*
|
||||
|
||||
*__description__*: Converts the Object to JSON, typically used for RPC transfers
|
||||
|
||||
@@ -161,7 +161,7 @@ ___
|
||||
|
||||
*Overrides [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)*
|
||||
|
||||
*Defined in [AccountId.ts:53](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/AccountId.ts#L53)*
|
||||
*Defined in [AccountId.ts:53](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/AccountId.ts#L53)*
|
||||
|
||||
*__description__*: Returns the string representation of the value
|
||||
|
||||
@@ -176,7 +176,7 @@ ___
|
||||
|
||||
*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
|
||||
|
||||
*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/codec/U8a.ts#L82)*
|
||||
*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/codec/U8a.ts#L82)*
|
||||
|
||||
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
|
||||
|
||||
@@ -195,7 +195,7 @@ ___
|
||||
|
||||
▸ **encode**(value: *`Uint8Array`*): `string`
|
||||
|
||||
*Defined in [AccountId.ts:27](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/AccountId.ts#L27)*
|
||||
*Defined in [AccountId.ts:27](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/AccountId.ts#L27)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -2000,7 +2000,7 @@
|
||||
<h2 id="constructor">constructor</h2>
|
||||
<p>⊕ <strong>new AccountIndex</strong>(value?: <em><a href="../modules/_types_.md#anynumber">AnyNumber</a></em>): <a href="_accountindex_.accountindex.html">AccountIndex</a></p>
|
||||
<p><em>Overrides <a href="_u32_.u32.html">U32</a>.<a href="_u32_.u32.html#constructor">constructor</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/AccountIndex.ts#L29" target="_blank">AccountIndex.ts:29</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/AccountIndex.ts#L29" target="_blank">AccountIndex.ts:29</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -2025,7 +2025,7 @@
|
||||
<h2 id="tobn">toBn</h2>
|
||||
<p>▸ <strong>toBn</strong>(): <code>BN</code></p>
|
||||
<p><em>Overrides AbstractInt.toBn</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/AccountIndex.ts#L92" target="_blank">AccountIndex.ts:92</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/AccountIndex.ts#L92" target="_blank">AccountIndex.ts:92</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Returns the BN representation of the AccountIndex</p>
|
||||
<p><strong>Returns:</strong> <code>BN</code></p>
|
||||
<hr>
|
||||
@@ -2034,7 +2034,7 @@
|
||||
<p>▸ <strong>toHex</strong>(): <code>string</code></p>
|
||||
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
|
||||
<p><em>Overrides <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#tohex">toHex</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/AccountIndex.ts#L99" target="_blank">AccountIndex.ts:99</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/AccountIndex.ts#L99" target="_blank">AccountIndex.ts:99</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
|
||||
<p><strong>Returns:</strong> <code>string</code></p>
|
||||
<hr>
|
||||
@@ -2043,7 +2043,7 @@
|
||||
<p>▸ <strong>toJSON</strong>(): <code>any</code></p>
|
||||
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
|
||||
<p><em>Overrides AbstractInt.toJSON</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/AccountIndex.ts#L108" target="_blank">AccountIndex.ts:108</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/AccountIndex.ts#L108" target="_blank">AccountIndex.ts:108</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
|
||||
<p><strong>Returns:</strong> <code>any</code></p>
|
||||
<hr>
|
||||
@@ -2052,7 +2052,7 @@
|
||||
<p>▸ <strong>toString</strong>(): <code>string</code></p>
|
||||
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
|
||||
<p><em>Overrides AbstractInt.toString</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/AccountIndex.ts#L115" target="_blank">AccountIndex.ts:115</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/AccountIndex.ts#L115" target="_blank">AccountIndex.ts:115</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
|
||||
<p><strong>Returns:</strong> <code>string</code></p>
|
||||
<hr>
|
||||
@@ -2061,7 +2061,7 @@
|
||||
<p>▸ <strong>toU8a</strong>(isBare?: <em><code>undefined</code> | <code>false</code> | <code>true</code></em>, isStorageKey?: <em><code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></p>
|
||||
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tou8a">toU8a</a></em></p>
|
||||
<p><em>Overrides <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#tou8a">toU8a</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/AccountIndex.ts#L126" target="_blank">AccountIndex.ts:126</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/AccountIndex.ts#L126" target="_blank">AccountIndex.ts:126</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
@@ -2094,7 +2094,7 @@
|
||||
<p><a id="calclength"></a></p>
|
||||
<h2 id="static-calclength"><code><Static></code> calcLength</h2>
|
||||
<p>▸ <strong>calcLength</strong>(_value: <em><code>BN</code> | <code>number</code></em>): <code>number</code></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/AccountIndex.ts#L52" target="_blank">AccountIndex.ts:52</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/AccountIndex.ts#L52" target="_blank">AccountIndex.ts:52</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -2116,7 +2116,7 @@
|
||||
<p><a id="decodeaccountindex"></a></p>
|
||||
<h2 id="static-decodeaccountindex"><code><Static></code> decodeAccountIndex</h2>
|
||||
<p>▸ <strong>decodeAccountIndex</strong>(value: <em><a href="../modules/_types_.md#anynumber">AnyNumber</a></em>): <code>BN</code> | <code>Uint8Array</code> | <code>number</code> | <code>string</code></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/AccountIndex.ts#L36" target="_blank">AccountIndex.ts:36</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/AccountIndex.ts#L36" target="_blank">AccountIndex.ts:36</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -2137,7 +2137,7 @@
|
||||
<p><a id="readlength"></a></p>
|
||||
<h2 id="static-readlength"><code><Static></code> readLength</h2>
|
||||
<p>▸ <strong>readLength</strong>(input: <em><code>Uint8Array</code></em>): [<code>number</code>, <code>number</code>]</p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/AccountIndex.ts#L66" target="_blank">AccountIndex.ts:66</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/AccountIndex.ts#L66" target="_blank">AccountIndex.ts:66</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -2158,7 +2158,7 @@
|
||||
<p><a id="writelength"></a></p>
|
||||
<h2 id="static-writelength"><code><Static></code> writeLength</h2>
|
||||
<p>▸ <strong>writeLength</strong>(input: <em><code>Uint8Array</code></em>): <code>Uint8Array</code></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/AccountIndex.ts#L80" target="_blank">AccountIndex.ts:80</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/AccountIndex.ts#L80" target="_blank">AccountIndex.ts:80</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -2219,7 +2219,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.2","depth":1,"next":{"title":"hidden","level":"4.3","depth":1,"path":"types/classes/_address_.address.md","ref":"types/classes/_address_.address.md","articles":[]},"previous":{"title":"hidden","level":"4.1","depth":1,"path":"types/classes/_accountid_.accountid.md","ref":"types/classes/_accountid_.accountid.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"types/classes/_accountindex_.accountindex.md","mtime":"2019-01-10T10:41:56.647Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-10T10:42:38.095Z"},"basePath":"../..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.2","depth":1,"next":{"title":"hidden","level":"4.3","depth":1,"path":"types/classes/_address_.address.md","ref":"types/classes/_address_.address.md","articles":[]},"previous":{"title":"hidden","level":"4.1","depth":1,"path":"types/classes/_accountid_.accountid.md","ref":"types/classes/_accountid_.accountid.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"types/classes/_accountindex_.accountindex.md","mtime":"2019-01-10T16:43:28.515Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-10T16:44:09.217Z"},"basePath":"../..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -24,7 +24,7 @@
|
||||
|
||||
*Overrides [U32](_u32_.u32.md).[constructor](_u32_.u32.md#constructor)*
|
||||
|
||||
*Defined in [AccountIndex.ts:29](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/AccountIndex.ts#L29)*
|
||||
*Defined in [AccountIndex.ts:29](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/AccountIndex.ts#L29)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -46,7 +46,7 @@ ___
|
||||
|
||||
*Overrides AbstractInt.toBn*
|
||||
|
||||
*Defined in [AccountIndex.ts:92](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/AccountIndex.ts#L92)*
|
||||
*Defined in [AccountIndex.ts:92](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/AccountIndex.ts#L92)*
|
||||
|
||||
*__description__*: Returns the BN representation of the AccountIndex
|
||||
|
||||
@@ -63,7 +63,7 @@ ___
|
||||
|
||||
*Overrides [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)*
|
||||
|
||||
*Defined in [AccountIndex.ts:99](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/AccountIndex.ts#L99)*
|
||||
*Defined in [AccountIndex.ts:99](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/AccountIndex.ts#L99)*
|
||||
|
||||
*__description__*: Returns a hex string representation of the value
|
||||
|
||||
@@ -80,7 +80,7 @@ ___
|
||||
|
||||
*Overrides AbstractInt.toJSON*
|
||||
|
||||
*Defined in [AccountIndex.ts:108](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/AccountIndex.ts#L108)*
|
||||
*Defined in [AccountIndex.ts:108](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/AccountIndex.ts#L108)*
|
||||
|
||||
*__description__*: Converts the Object to JSON, typically used for RPC transfers
|
||||
|
||||
@@ -97,7 +97,7 @@ ___
|
||||
|
||||
*Overrides AbstractInt.toString*
|
||||
|
||||
*Defined in [AccountIndex.ts:115](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/AccountIndex.ts#L115)*
|
||||
*Defined in [AccountIndex.ts:115](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/AccountIndex.ts#L115)*
|
||||
|
||||
*__description__*: Returns the string representation of the value
|
||||
|
||||
@@ -114,7 +114,7 @@ ___
|
||||
|
||||
*Overrides [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)*
|
||||
|
||||
*Defined in [AccountIndex.ts:126](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/AccountIndex.ts#L126)*
|
||||
*Defined in [AccountIndex.ts:126](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/AccountIndex.ts#L126)*
|
||||
|
||||
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
|
||||
|
||||
@@ -134,7 +134,7 @@ ___
|
||||
|
||||
▸ **calcLength**(_value: *`BN` | `number`*): `number`
|
||||
|
||||
*Defined in [AccountIndex.ts:52](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/AccountIndex.ts#L52)*
|
||||
*Defined in [AccountIndex.ts:52](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/AccountIndex.ts#L52)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -151,7 +151,7 @@ ___
|
||||
|
||||
▸ **decodeAccountIndex**(value: *[AnyNumber](../modules/_types_.md#anynumber)*): `BN` | `Uint8Array` | `number` | `string`
|
||||
|
||||
*Defined in [AccountIndex.ts:36](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/AccountIndex.ts#L36)*
|
||||
*Defined in [AccountIndex.ts:36](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/AccountIndex.ts#L36)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -168,7 +168,7 @@ ___
|
||||
|
||||
▸ **readLength**(input: *`Uint8Array`*): [`number`, `number`]
|
||||
|
||||
*Defined in [AccountIndex.ts:66](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/AccountIndex.ts#L66)*
|
||||
*Defined in [AccountIndex.ts:66](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/AccountIndex.ts#L66)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -185,7 +185,7 @@ ___
|
||||
|
||||
▸ **writeLength**(input: *`Uint8Array`*): `Uint8Array`
|
||||
|
||||
*Defined in [AccountIndex.ts:80](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/AccountIndex.ts#L80)*
|
||||
*Defined in [AccountIndex.ts:80](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/AccountIndex.ts#L80)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -1996,7 +1996,7 @@
|
||||
<h2 id="constructor">constructor</h2>
|
||||
<p>⊕ <strong>new Address</strong>(value?: <em><code>AnyAddress</code></em>): <a href="_address_.address.html">Address</a></p>
|
||||
<p><em>Overrides <a href="_codec_base_.base.html">Base</a>.<a href="_codec_base_.base.html#constructor">constructor</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/Address.ts#L25" target="_blank">Address.ts:25</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/Address.ts#L25" target="_blank">Address.ts:25</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -2020,14 +2020,14 @@
|
||||
<p><a id="encodedlength"></a></p>
|
||||
<h2 id="encodedlength">encodedLength</h2>
|
||||
<p>getencodedLength(): <code>number</code></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/Address.ts#L67" target="_blank">Address.ts:67</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/Address.ts#L67" target="_blank">Address.ts:67</a></em></p>
|
||||
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
|
||||
<p><strong>Returns:</strong> <code>number</code></p>
|
||||
<hr>
|
||||
<p><a id="rawlength"></a></p>
|
||||
<h2 id="rawlength">rawLength</h2>
|
||||
<p>getrawLength(): <code>number</code></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/Address.ts#L81" target="_blank">Address.ts:81</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/Address.ts#L81" target="_blank">Address.ts:81</a></em></p>
|
||||
<p><em><strong>description</strong></em>: The length of the raw value, either AccountIndex or AccountId</p>
|
||||
<p><strong>Returns:</strong> <code>number</code></p>
|
||||
<hr>
|
||||
@@ -2035,28 +2035,28 @@
|
||||
<p><a id="tohex"></a></p>
|
||||
<h2 id="tohex">toHex</h2>
|
||||
<p>▸ <strong>toHex</strong>(): <code>string</code></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/Address.ts#L90" target="_blank">Address.ts:90</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/Address.ts#L90" target="_blank">Address.ts:90</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
|
||||
<p><strong>Returns:</strong> <code>string</code></p>
|
||||
<hr>
|
||||
<p><a id="tojson"></a></p>
|
||||
<h2 id="tojson">toJSON</h2>
|
||||
<p>▸ <strong>toJSON</strong>(): <code>any</code></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/Address.ts#L97" target="_blank">Address.ts:97</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/Address.ts#L97" target="_blank">Address.ts:97</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
|
||||
<p><strong>Returns:</strong> <code>any</code></p>
|
||||
<hr>
|
||||
<p><a id="tostring"></a></p>
|
||||
<h2 id="tostring">toString</h2>
|
||||
<p>▸ <strong>toString</strong>(): <code>string</code></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/Address.ts#L104" target="_blank">Address.ts:104</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/Address.ts#L104" target="_blank">Address.ts:104</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
|
||||
<p><strong>Returns:</strong> <code>string</code></p>
|
||||
<hr>
|
||||
<p><a id="tou8a"></a></p>
|
||||
<h2 id="tou8a">toU8a</h2>
|
||||
<p>▸ <strong>toU8a</strong>(isBare?: <em><code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/Address.ts#L112" target="_blank">Address.ts:112</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/Address.ts#L112" target="_blank">Address.ts:112</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
@@ -2082,7 +2082,7 @@
|
||||
<p><a id="decodeaddress"></a></p>
|
||||
<h2 id="static-decodeaddress"><code><Static></code> decodeAddress</h2>
|
||||
<p>▸ <strong>decodeAddress</strong>(value: <em><code>AnyAddress</code></em>): <a href="_accountid_.accountid.html">AccountId</a> | <a href="_accountindex_.accountindex.html">AccountIndex</a></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/Address.ts#L32" target="_blank">Address.ts:32</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/Address.ts#L32" target="_blank">Address.ts:32</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -2143,7 +2143,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.3","depth":1,"next":{"title":"hidden","level":"4.4","depth":1,"path":"types/classes/_authorityid_.authorityid.md","ref":"types/classes/_authorityid_.authorityid.md","articles":[]},"previous":{"title":"hidden","level":"4.2","depth":1,"path":"types/classes/_accountindex_.accountindex.md","ref":"types/classes/_accountindex_.accountindex.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"types/classes/_address_.address.md","mtime":"2019-01-10T10:41:56.675Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-10T10:42:38.095Z"},"basePath":"../..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.3","depth":1,"next":{"title":"hidden","level":"4.4","depth":1,"path":"types/classes/_authorityid_.authorityid.md","ref":"types/classes/_authorityid_.authorityid.md","articles":[]},"previous":{"title":"hidden","level":"4.2","depth":1,"path":"types/classes/_accountindex_.accountindex.md","ref":"types/classes/_accountindex_.accountindex.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"types/classes/_address_.address.md","mtime":"2019-01-10T16:43:28.547Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-10T16:44:09.217Z"},"basePath":"../..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -20,7 +20,7 @@
|
||||
|
||||
*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)*
|
||||
|
||||
*Defined in [Address.ts:25](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/Address.ts#L25)*
|
||||
*Defined in [Address.ts:25](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/Address.ts#L25)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -40,7 +40,7 @@ ___
|
||||
|
||||
getencodedLength(): `number`
|
||||
|
||||
*Defined in [Address.ts:67](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/Address.ts#L67)*
|
||||
*Defined in [Address.ts:67](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/Address.ts#L67)*
|
||||
|
||||
*__description__*: The length of the value when encoded as a Uint8Array
|
||||
|
||||
@@ -53,7 +53,7 @@ ___
|
||||
|
||||
getrawLength(): `number`
|
||||
|
||||
*Defined in [Address.ts:81](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/Address.ts#L81)*
|
||||
*Defined in [Address.ts:81](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/Address.ts#L81)*
|
||||
|
||||
*__description__*: The length of the raw value, either AccountIndex or AccountId
|
||||
|
||||
@@ -69,7 +69,7 @@ ___
|
||||
|
||||
▸ **toHex**(): `string`
|
||||
|
||||
*Defined in [Address.ts:90](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/Address.ts#L90)*
|
||||
*Defined in [Address.ts:90](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/Address.ts#L90)*
|
||||
|
||||
*__description__*: Returns a hex string representation of the value
|
||||
|
||||
@@ -82,7 +82,7 @@ ___
|
||||
|
||||
▸ **toJSON**(): `any`
|
||||
|
||||
*Defined in [Address.ts:97](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/Address.ts#L97)*
|
||||
*Defined in [Address.ts:97](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/Address.ts#L97)*
|
||||
|
||||
*__description__*: Converts the Object to JSON, typically used for RPC transfers
|
||||
|
||||
@@ -95,7 +95,7 @@ ___
|
||||
|
||||
▸ **toString**(): `string`
|
||||
|
||||
*Defined in [Address.ts:104](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/Address.ts#L104)*
|
||||
*Defined in [Address.ts:104](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/Address.ts#L104)*
|
||||
|
||||
*__description__*: Returns the string representation of the value
|
||||
|
||||
@@ -108,7 +108,7 @@ ___
|
||||
|
||||
▸ **toU8a**(isBare?: *`undefined` | `false` | `true`*): `Uint8Array`
|
||||
|
||||
*Defined in [Address.ts:112](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/Address.ts#L112)*
|
||||
*Defined in [Address.ts:112](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/Address.ts#L112)*
|
||||
|
||||
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
|
||||
|
||||
@@ -127,7 +127,7 @@ ___
|
||||
|
||||
▸ **decodeAddress**(value: *`AnyAddress`*): [AccountId](_accountid_.accountid.md) | [AccountIndex](_accountindex_.accountindex.md)
|
||||
|
||||
*Defined in [Address.ts:32](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/Address.ts#L32)*
|
||||
*Defined in [Address.ts:32](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/Address.ts#L32)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -29,7 +29,7 @@
|
||||
|
||||
*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)*
|
||||
|
||||
*Defined in [AttestedCandidate.ts:74](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/AttestedCandidate.ts#L74)*
|
||||
*Defined in [AttestedCandidate.ts:74](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/AttestedCandidate.ts#L74)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -51,7 +51,7 @@ getType(): `E`
|
||||
|
||||
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
|
||||
|
||||
*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/codec/Struct.ts#L142)*
|
||||
*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/codec/Struct.ts#L142)*
|
||||
|
||||
*__description__*: Returns the Type description to sthe structure
|
||||
|
||||
@@ -66,7 +66,7 @@ getencodedLength(): `number`
|
||||
|
||||
*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)*
|
||||
|
||||
*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/codec/Struct.ts#L149)*
|
||||
*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/codec/Struct.ts#L149)*
|
||||
|
||||
*__description__*: The length of the value when encoded as a Uint8Array
|
||||
|
||||
@@ -86,7 +86,7 @@ ___
|
||||
|
||||
*Overrides Map.get*
|
||||
|
||||
*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/codec/Struct.ts#L159)*
|
||||
*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/codec/Struct.ts#L159)*
|
||||
|
||||
*__description__*: Returns a specific names entry in the structure
|
||||
|
||||
@@ -107,7 +107,7 @@ ___
|
||||
|
||||
*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)*
|
||||
|
||||
*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/codec/Struct.ts#L166)*
|
||||
*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/codec/Struct.ts#L166)*
|
||||
|
||||
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
|
||||
|
||||
@@ -128,7 +128,7 @@ ___
|
||||
|
||||
*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)*
|
||||
|
||||
*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/codec/Struct.ts#L173)*
|
||||
*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/codec/Struct.ts#L173)*
|
||||
|
||||
*__description__*: Converts the Object to an standard JavaScript Array
|
||||
|
||||
@@ -145,7 +145,7 @@ ___
|
||||
|
||||
*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)*
|
||||
|
||||
*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/codec/Struct.ts#L180)*
|
||||
*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/codec/Struct.ts#L180)*
|
||||
|
||||
*__description__*: Returns a hex string representation of the value
|
||||
|
||||
@@ -162,7 +162,7 @@ ___
|
||||
|
||||
*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
|
||||
|
||||
*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/codec/Struct.ts#L187)*
|
||||
*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/codec/Struct.ts#L187)*
|
||||
|
||||
*__description__*: Converts the Object to JSON, typically used for RPC transfers
|
||||
|
||||
@@ -179,7 +179,7 @@ ___
|
||||
|
||||
*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)*
|
||||
|
||||
*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/codec/Struct.ts#L201)*
|
||||
*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/codec/Struct.ts#L201)*
|
||||
|
||||
*__description__*: Returns the string representation of the value
|
||||
|
||||
@@ -194,7 +194,7 @@ ___
|
||||
|
||||
*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
|
||||
|
||||
*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/codec/Struct.ts#L209)*
|
||||
*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/codec/Struct.ts#L209)*
|
||||
|
||||
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
|
||||
|
||||
@@ -215,7 +215,7 @@ ___
|
||||
|
||||
*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
|
||||
|
||||
*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/07d6139/packages/types/src/codec/Struct.ts#L122)*
|
||||
*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/2a2df9a/packages/types/src/codec/Struct.ts#L122)*
|
||||
|
||||
**Type parameters:**
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user