[CI Skip] 0.33.22
This commit is contained in:
+1
-1
@@ -1993,7 +1993,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"GLOSSARY.md","mtime":"2018-12-17T11:40:36.802Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T11:44:28.801Z"},"basePath":".","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"GLOSSARY.md","mtime":"2018-12-17T13:55:52.022Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T13:59:36.621Z"},"basePath":".","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -2167,7 +2167,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"Events (runtime)","level":"2.4","depth":1,"next":{"title":"ApiPromise","level":"3.1","depth":1,"path":"examples/promise/README.md","ref":"examples/promise/README.md","articles":[{"title":"Simple connect","level":"3.1.1","depth":2,"path":"examples/promise/01_simple_connect/README.md","ref":"examples/promise/01_simple_connect/README.md","articles":[]},{"title":"Listen to blocks","level":"3.1.2","depth":2,"path":"examples/promise/02_listen_to_blocks/README.md","ref":"examples/promise/02_listen_to_blocks/README.md","articles":[]},{"title":"Listen to balance change","level":"3.1.3","depth":2,"path":"examples/promise/03_listen_to_balance_change/README.md","ref":"examples/promise/03_listen_to_balance_change/README.md","articles":[]},{"title":"Read chain state","level":"3.1.4","depth":2,"path":"examples/promise/05_read_storage/README.md","ref":"examples/promise/05_read_storage/README.md","articles":[]},{"title":"Make a transfer","level":"3.1.5","depth":2,"path":"examples/promise/07_transfer_dots/README.md","ref":"examples/promise/07_transfer_dots/README.md","articles":[]},{"title":"Display system events","level":"3.1.6","depth":2,"path":"examples/promise/08_system_events/README.md","ref":"examples/promise/08_system_events/README.md","articles":[]}]},"previous":{"title":"Extrinsics (runtime)","level":"2.3","depth":1,"path":"METHODS_EXTRINSICS.md","ref":"METHODS_EXTRINSICS.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"METHODS_EVENTS.md","mtime":"2018-12-17T11:42:48.854Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T11:44:28.801Z"},"basePath":".","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"Events (runtime)","level":"2.4","depth":1,"next":{"title":"ApiPromise","level":"3.1","depth":1,"path":"examples/promise/README.md","ref":"examples/promise/README.md","articles":[{"title":"Simple connect","level":"3.1.1","depth":2,"path":"examples/promise/01_simple_connect/README.md","ref":"examples/promise/01_simple_connect/README.md","articles":[]},{"title":"Listen to blocks","level":"3.1.2","depth":2,"path":"examples/promise/02_listen_to_blocks/README.md","ref":"examples/promise/02_listen_to_blocks/README.md","articles":[]},{"title":"Listen to balance change","level":"3.1.3","depth":2,"path":"examples/promise/03_listen_to_balance_change/README.md","ref":"examples/promise/03_listen_to_balance_change/README.md","articles":[]},{"title":"Read chain state","level":"3.1.4","depth":2,"path":"examples/promise/05_read_storage/README.md","ref":"examples/promise/05_read_storage/README.md","articles":[]},{"title":"Make a transfer","level":"3.1.5","depth":2,"path":"examples/promise/07_transfer_dots/README.md","ref":"examples/promise/07_transfer_dots/README.md","articles":[]},{"title":"Display system events","level":"3.1.6","depth":2,"path":"examples/promise/08_system_events/README.md","ref":"examples/promise/08_system_events/README.md","articles":[]}]},"previous":{"title":"Extrinsics (runtime)","level":"2.3","depth":1,"path":"METHODS_EXTRINSICS.md","ref":"METHODS_EXTRINSICS.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"METHODS_EVENTS.md","mtime":"2018-12-17T13:58:00.775Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T13:59:36.621Z"},"basePath":".","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -2113,7 +2113,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"Extrinsics (runtime)","level":"2.3","depth":1,"next":{"title":"Events (runtime)","level":"2.4","depth":1,"path":"METHODS_EVENTS.md","ref":"METHODS_EVENTS.md","articles":[]},"previous":{"title":"Chain state (runtime)","level":"2.2","depth":1,"path":"METHODS_STORAGE.md","ref":"METHODS_STORAGE.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"METHODS_EXTRINSICS.md","mtime":"2018-12-17T11:42:48.854Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T11:44:28.801Z"},"basePath":".","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"Extrinsics (runtime)","level":"2.3","depth":1,"next":{"title":"Events (runtime)","level":"2.4","depth":1,"path":"METHODS_EVENTS.md","ref":"METHODS_EVENTS.md","articles":[]},"previous":{"title":"Chain state (runtime)","level":"2.2","depth":1,"path":"METHODS_STORAGE.md","ref":"METHODS_STORAGE.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"METHODS_EXTRINSICS.md","mtime":"2018-12-17T13:58:00.775Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T13:59:36.621Z"},"basePath":".","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -2119,7 +2119,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"RPC","level":"2.1","depth":1,"next":{"title":"Chain state (runtime)","level":"2.2","depth":1,"path":"METHODS_STORAGE.md","ref":"METHODS_STORAGE.md","articles":[]},"previous":{"title":"types (codec implementation)","level":"1.4","depth":1,"path":"types/README.md","ref":"types/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"METHODS_RPC.md","mtime":"2018-12-17T11:42:48.854Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T11:44:28.801Z"},"basePath":".","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"RPC","level":"2.1","depth":1,"next":{"title":"Chain state (runtime)","level":"2.2","depth":1,"path":"METHODS_STORAGE.md","ref":"METHODS_STORAGE.md","articles":[]},"previous":{"title":"types (codec implementation)","level":"1.4","depth":1,"path":"types/README.md","ref":"types/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"METHODS_RPC.md","mtime":"2018-12-17T13:58:00.775Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T13:59:36.621Z"},"basePath":".","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -2454,7 +2454,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"Chain state (runtime)","level":"2.2","depth":1,"next":{"title":"Extrinsics (runtime)","level":"2.3","depth":1,"path":"METHODS_EXTRINSICS.md","ref":"METHODS_EXTRINSICS.md","articles":[]},"previous":{"title":"RPC","level":"2.1","depth":1,"path":"METHODS_RPC.md","ref":"METHODS_RPC.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"METHODS_STORAGE.md","mtime":"2018-12-17T11:42:48.858Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T11:44:28.801Z"},"basePath":".","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"Chain state (runtime)","level":"2.2","depth":1,"next":{"title":"Extrinsics (runtime)","level":"2.3","depth":1,"path":"METHODS_EXTRINSICS.md","ref":"METHODS_EXTRINSICS.md","articles":[]},"previous":{"title":"RPC","level":"2.1","depth":1,"path":"METHODS_RPC.md","ref":"METHODS_RPC.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"METHODS_STORAGE.md","mtime":"2018-12-17T13:58:00.775Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T13:59:36.621Z"},"basePath":".","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -14,7 +14,7 @@
|
||||
|
||||
⊕ **new ApiBase**(api: *`RpcRxInterface`*): [ApiBase](_base_.apibase.md)
|
||||
|
||||
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Base.ts#L33)*
|
||||
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Base.ts#L33)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -34,7 +34,7 @@ ___
|
||||
|
||||
**● whenReady**: *`Observable`<`boolean`>*
|
||||
|
||||
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Base.ts#L33)*
|
||||
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Base.ts#L33)*
|
||||
|
||||
___
|
||||
<a id="extrinsics"></a>
|
||||
@@ -43,7 +43,7 @@ ___
|
||||
|
||||
**● extrinsics**: *`Extrinsics`* = extrinsicsStatic
|
||||
|
||||
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Base.ts#L41)*
|
||||
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Base.ts#L41)*
|
||||
|
||||
___
|
||||
<a id="storage"></a>
|
||||
@@ -52,7 +52,7 @@ ___
|
||||
|
||||
**● storage**: *`Storage`* = storageStatic
|
||||
|
||||
*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Base.ts#L42)*
|
||||
*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Base.ts#L42)*
|
||||
|
||||
___
|
||||
|
||||
@@ -64,7 +64,7 @@ ___
|
||||
|
||||
getgenesisHash(): `Hash`
|
||||
|
||||
*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Base.ts#L87)*
|
||||
*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Base.ts#L87)*
|
||||
|
||||
**Returns:** `Hash`
|
||||
|
||||
@@ -78,7 +78,7 @@ ___
|
||||
|
||||
▸ **isConnected**(): `Observable`<`boolean`>
|
||||
|
||||
*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Base.ts#L91)*
|
||||
*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Base.ts#L91)*
|
||||
|
||||
**Returns:** `Observable`<`boolean`>
|
||||
|
||||
@@ -89,7 +89,7 @@ ___
|
||||
|
||||
▸ **rawCall**<`T`>(__namedParameters: *`object`*, ...params: *`Array`<`any`>*): `Observable`<`T`>
|
||||
|
||||
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Base.ts#L95)*
|
||||
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Base.ts#L95)*
|
||||
|
||||
**Type parameters:**
|
||||
|
||||
@@ -110,7 +110,7 @@ ___
|
||||
|
||||
▸ **rawStorage**<`T`>(key: * `Uint8Array` | `StorageFunction`*, ...params: *`Array`<`any`>*): `Observable`< `T` | `undefined`>
|
||||
|
||||
*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Base.ts#L108)*
|
||||
*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Base.ts#L108)*
|
||||
|
||||
**Type parameters:**
|
||||
|
||||
@@ -131,7 +131,7 @@ ___
|
||||
|
||||
▸ **rawStorageMulti**<`T`>(...keys: *`Array`< `Uint8Array` | [`StorageFunction`] | [`StorageFunction`, `any`]>*): `Observable`<`T`>
|
||||
|
||||
*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Base.ts#L123)*
|
||||
*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Base.ts#L123)*
|
||||
|
||||
**Type parameters:**
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
|
||||
|
||||
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Base.ts#L33)*
|
||||
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Base.ts#L33)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -40,7 +40,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[whenReady](_base_.apibase.md#whenready)*
|
||||
|
||||
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Base.ts#L33)*
|
||||
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Base.ts#L33)*
|
||||
|
||||
___
|
||||
<a id="extrinsics"></a>
|
||||
@@ -51,7 +51,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[extrinsics](_base_.apibase.md#extrinsics)*
|
||||
|
||||
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Base.ts#L41)*
|
||||
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Base.ts#L41)*
|
||||
|
||||
___
|
||||
<a id="storage"></a>
|
||||
@@ -62,7 +62,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[storage](_base_.apibase.md#storage)*
|
||||
|
||||
*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Base.ts#L42)*
|
||||
*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Base.ts#L42)*
|
||||
|
||||
___
|
||||
|
||||
@@ -76,7 +76,7 @@ getgenesisHash(): `Hash`
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)*
|
||||
|
||||
*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Base.ts#L87)*
|
||||
*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Base.ts#L87)*
|
||||
|
||||
**Returns:** `Hash`
|
||||
|
||||
@@ -92,7 +92,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[accountNonce](_queries_.apiqueries.md#accountnonce)*
|
||||
|
||||
*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L19)*
|
||||
*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L19)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -111,7 +111,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceFree](_queries_.apiqueries.md#balancefree)*
|
||||
|
||||
*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L23)*
|
||||
*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L23)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -130,7 +130,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceReserved](_queries_.apiqueries.md#balancereserved)*
|
||||
|
||||
*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L27)*
|
||||
*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L27)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -147,7 +147,7 @@ ___
|
||||
|
||||
▸ **bestNumber**(): `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Calls.ts#L13)*
|
||||
*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Calls.ts#L13)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -160,7 +160,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[blockNow](_queries_.apiqueries.md#blocknow)*
|
||||
|
||||
*Defined in [Queries.ts:35](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L35)*
|
||||
*Defined in [Queries.ts:35](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L35)*
|
||||
|
||||
**Returns:** `Observable`< `Moment` | `undefined`>
|
||||
|
||||
@@ -173,7 +173,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[blockPeriod](_queries_.apiqueries.md#blockperiod)*
|
||||
|
||||
*Defined in [Queries.ts:31](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L31)*
|
||||
*Defined in [Queries.ts:31](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L31)*
|
||||
|
||||
**Returns:** `Observable`< `Moment` | `undefined`>
|
||||
|
||||
@@ -184,7 +184,7 @@ ___
|
||||
|
||||
▸ **chain**(): `Observable`< `Text` | `undefined`>
|
||||
|
||||
*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Calls.ts#L25)*
|
||||
*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Calls.ts#L25)*
|
||||
|
||||
**Returns:** `Observable`< `Text` | `undefined`>
|
||||
|
||||
@@ -195,7 +195,7 @@ ___
|
||||
|
||||
▸ **chainProperties**(): `Observable`<`ChainProperties`>
|
||||
|
||||
*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Calls.ts#L29)*
|
||||
*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Calls.ts#L29)*
|
||||
|
||||
**Returns:** `Observable`<`ChainProperties`>
|
||||
|
||||
@@ -208,7 +208,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyLaunchPeriod](_queries_.apiqueries.md#democracylaunchperiod)*
|
||||
|
||||
*Defined in [Queries.ts:39](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L39)*
|
||||
*Defined in [Queries.ts:39](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L39)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -221,7 +221,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyNextTally](_queries_.apiqueries.md#democracynexttally)*
|
||||
|
||||
*Defined in [Queries.ts:43](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L43)*
|
||||
*Defined in [Queries.ts:43](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L43)*
|
||||
|
||||
**Returns:** `Observable`< `ReferendumIndex` | `undefined`>
|
||||
|
||||
@@ -234,7 +234,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyVotingPeriod](_queries_.apiqueries.md#democracyvotingperiod)*
|
||||
|
||||
*Defined in [Queries.ts:126](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L126)*
|
||||
*Defined in [Queries.ts:126](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L126)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -247,7 +247,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[eraLastLengthChange](_queries_.apiqueries.md#eralastlengthchange)*
|
||||
|
||||
*Defined in [Queries.ts:151](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L151)*
|
||||
*Defined in [Queries.ts:151](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L151)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -260,7 +260,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[fees](_queries_.apiqueries.md#fees)*
|
||||
|
||||
*Defined in [Queries.ts:130](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L130)*
|
||||
*Defined in [Queries.ts:130](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L130)*
|
||||
|
||||
**Returns:** `Observable`<[RxFees](../modules/_types_.md#rxfees)>
|
||||
|
||||
@@ -273,7 +273,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[getAccountEnumSet](_queries_.apiqueries.md#getaccountenumset)*
|
||||
|
||||
*Defined in [Queries.ts:47](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L47)*
|
||||
*Defined in [Queries.ts:47](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L47)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -290,7 +290,7 @@ ___
|
||||
|
||||
▸ **getBlock**(hash: *`Uint8Array`*): `Observable`< `SignedBlock` | `undefined`>
|
||||
|
||||
*Defined in [Calls.ts:41](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Calls.ts#L41)*
|
||||
*Defined in [Calls.ts:41](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Calls.ts#L41)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -309,7 +309,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[isConnected](_base_.apibase.md#isconnected)*
|
||||
|
||||
*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Base.ts#L91)*
|
||||
*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Base.ts#L91)*
|
||||
|
||||
**Returns:** `Observable`<`boolean`>
|
||||
|
||||
@@ -322,7 +322,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[nextAccountEnumSet](_queries_.apiqueries.md#nextaccountenumset)*
|
||||
|
||||
*Defined in [Queries.ts:58](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L58)*
|
||||
*Defined in [Queries.ts:58](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L58)*
|
||||
|
||||
**Returns:** `Observable`< `AccountIndex` | `undefined`>
|
||||
|
||||
@@ -335,7 +335,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[proposalDeposits](_queries_.apiqueries.md#proposaldeposits)*
|
||||
|
||||
*Defined in [Queries.ts:62](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L62)*
|
||||
*Defined in [Queries.ts:62](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L62)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -354,7 +354,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[publicProposals](_queries_.apiqueries.md#publicproposals)*
|
||||
|
||||
*Defined in [Queries.ts:75](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L75)*
|
||||
*Defined in [Queries.ts:75](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L75)*
|
||||
|
||||
**Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>>
|
||||
|
||||
@@ -367,7 +367,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)*
|
||||
|
||||
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Base.ts#L95)*
|
||||
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Base.ts#L95)*
|
||||
|
||||
**Type parameters:**
|
||||
|
||||
@@ -390,7 +390,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)*
|
||||
|
||||
*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Base.ts#L108)*
|
||||
*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Base.ts#L108)*
|
||||
|
||||
**Type parameters:**
|
||||
|
||||
@@ -413,7 +413,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)*
|
||||
|
||||
*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Base.ts#L123)*
|
||||
*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Base.ts#L123)*
|
||||
|
||||
**Type parameters:**
|
||||
|
||||
@@ -435,7 +435,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumCount](_queries_.apiqueries.md#referendumcount)*
|
||||
|
||||
*Defined in [Queries.ts:94](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L94)*
|
||||
*Defined in [Queries.ts:94](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L94)*
|
||||
|
||||
**Returns:** `Observable`< `ReferendumIndex` | `undefined`>
|
||||
|
||||
@@ -448,7 +448,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumInfo](_queries_.apiqueries.md#referenduminfo)*
|
||||
|
||||
*Defined in [Queries.ts:98](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L98)*
|
||||
*Defined in [Queries.ts:98](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L98)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -467,7 +467,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVote](_queries_.apiqueries.md#referendumvote)*
|
||||
|
||||
*Defined in [Queries.ts:111](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L111)*
|
||||
*Defined in [Queries.ts:111](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L111)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -487,7 +487,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVoters](_queries_.apiqueries.md#referendumvoters)*
|
||||
|
||||
*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L115)*
|
||||
*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L115)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -506,7 +506,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentIndex](_queries_.apiqueries.md#sessioncurrentindex)*
|
||||
|
||||
*Defined in [Queries.ts:163](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L163)*
|
||||
*Defined in [Queries.ts:163](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L163)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -519,7 +519,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentStart](_queries_.apiqueries.md#sessioncurrentstart)*
|
||||
|
||||
*Defined in [Queries.ts:167](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L167)*
|
||||
*Defined in [Queries.ts:167](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L167)*
|
||||
|
||||
**Returns:** `Observable`< `Moment` | `undefined`>
|
||||
|
||||
@@ -532,7 +532,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLastLengthChange](_queries_.apiqueries.md#sessionlastlengthchange)*
|
||||
|
||||
*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L171)*
|
||||
*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L171)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -545,7 +545,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLength](_queries_.apiqueries.md#sessionlength)*
|
||||
|
||||
*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L175)*
|
||||
*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L175)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -558,7 +558,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionReward](_queries_.apiqueries.md#sessionreward)*
|
||||
|
||||
*Defined in [Queries.ts:155](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L155)*
|
||||
*Defined in [Queries.ts:155](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L155)*
|
||||
|
||||
**Returns:** `Observable`< `Perbill` | `undefined`>
|
||||
|
||||
@@ -571,7 +571,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionRewardCurrent](_queries_.apiqueries.md#sessionrewardcurrent)*
|
||||
|
||||
*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L159)*
|
||||
*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L159)*
|
||||
|
||||
**Returns:** `Observable`< `Balance` | `undefined`>
|
||||
|
||||
@@ -584,7 +584,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionValidators](_queries_.apiqueries.md#sessionvalidators)*
|
||||
|
||||
*Defined in [Queries.ts:183](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L183)*
|
||||
*Defined in [Queries.ts:183](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L183)*
|
||||
|
||||
**Returns:** `Observable`<`Array`<`AccountId`>>
|
||||
|
||||
@@ -597,7 +597,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionsPerEra](_queries_.apiqueries.md#sessionsperera)*
|
||||
|
||||
*Defined in [Queries.ts:179](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L179)*
|
||||
*Defined in [Queries.ts:179](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L179)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -610,7 +610,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingIntentions](_queries_.apiqueries.md#stakingintentions)*
|
||||
|
||||
*Defined in [Queries.ts:194](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L194)*
|
||||
*Defined in [Queries.ts:194](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L194)*
|
||||
|
||||
**Returns:** `Observable`<`Array`<`AccountId`>>
|
||||
|
||||
@@ -623,7 +623,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominating](_queries_.apiqueries.md#stakingnominating)*
|
||||
|
||||
*Defined in [Queries.ts:216](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L216)*
|
||||
*Defined in [Queries.ts:216](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L216)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -642,7 +642,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominatorsFor](_queries_.apiqueries.md#stakingnominatorsfor)*
|
||||
|
||||
*Defined in [Queries.ts:205](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L205)*
|
||||
*Defined in [Queries.ts:205](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L205)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -659,7 +659,7 @@ ___
|
||||
|
||||
▸ **submitAndWatchExtrinsic**(extrinsic: *`Extrinsic`*): `Observable`< `ExtrinsicStatus` | `undefined`>
|
||||
|
||||
*Defined in [Calls.ts:63](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Calls.ts#L63)*
|
||||
*Defined in [Calls.ts:63](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Calls.ts#L63)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -676,7 +676,7 @@ ___
|
||||
|
||||
▸ **submitExtrinsic**(extrinsic: *`Extrinsic`*): `Observable`< `Hash` | `undefined`>
|
||||
|
||||
*Defined in [Calls.ts:59](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Calls.ts#L59)*
|
||||
*Defined in [Calls.ts:59](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Calls.ts#L59)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -693,7 +693,7 @@ ___
|
||||
|
||||
▸ **subscribeNewHead**(): `Observable`< `Header` | `undefined`>
|
||||
|
||||
*Defined in [Calls.ts:45](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Calls.ts#L45)*
|
||||
*Defined in [Calls.ts:45](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Calls.ts#L45)*
|
||||
|
||||
**Returns:** `Observable`< `Header` | `undefined`>
|
||||
|
||||
@@ -706,7 +706,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[systemEvents](_queries_.apiqueries.md#systemevents)*
|
||||
|
||||
*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L220)*
|
||||
*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L220)*
|
||||
|
||||
**Returns:** `Observable`<`Array`<`EventRecord`>>
|
||||
|
||||
@@ -717,7 +717,7 @@ ___
|
||||
|
||||
▸ **systemName**(): `Observable`< `Text` | `undefined`>
|
||||
|
||||
*Defined in [Calls.ts:51](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Calls.ts#L51)*
|
||||
*Defined in [Calls.ts:51](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Calls.ts#L51)*
|
||||
|
||||
**Returns:** `Observable`< `Text` | `undefined`>
|
||||
|
||||
@@ -728,7 +728,7 @@ ___
|
||||
|
||||
▸ **systemVersion**(): `Observable`< `Text` | `undefined`>
|
||||
|
||||
*Defined in [Calls.ts:55](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Calls.ts#L55)*
|
||||
*Defined in [Calls.ts:55](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Calls.ts#L55)*
|
||||
|
||||
**Returns:** `Observable`< `Text` | `undefined`>
|
||||
|
||||
@@ -741,7 +741,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[validatorCount](_queries_.apiqueries.md#validatorcount)*
|
||||
|
||||
*Defined in [Queries.ts:231](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L231)*
|
||||
*Defined in [Queries.ts:231](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L231)*
|
||||
|
||||
**Returns:** `Observable`< `u32` | `undefined`>
|
||||
|
||||
|
||||
@@ -25,7 +25,7 @@
|
||||
|
||||
*Overrides Struct.__constructor*
|
||||
|
||||
*Defined in [classes.ts:12](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/classes.ts#L12)*
|
||||
*Defined in [classes.ts:12](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/classes.ts#L12)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -72,7 +72,7 @@ getType(): `E`
|
||||
|
||||
*Inherited from Struct.Type*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L141)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L141)*
|
||||
|
||||
*__description__*: Returns the Type description to sthe structure
|
||||
|
||||
@@ -85,7 +85,7 @@ ___
|
||||
|
||||
getaddress(): `AccountId`
|
||||
|
||||
*Defined in [classes.ts:21](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/classes.ts#L21)*
|
||||
*Defined in [classes.ts:21](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/classes.ts#L21)*
|
||||
|
||||
**Returns:** `AccountId`
|
||||
|
||||
@@ -98,7 +98,7 @@ getencodedLength(): `number`
|
||||
|
||||
*Inherited from Struct.encodedLength*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L148)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L148)*
|
||||
|
||||
*__description__*: The length of the value when encoded as a Uint8Array
|
||||
|
||||
@@ -111,7 +111,7 @@ ___
|
||||
|
||||
getid(): `PropIndex`
|
||||
|
||||
*Defined in [classes.ts:25](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/classes.ts#L25)*
|
||||
*Defined in [classes.ts:25](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/classes.ts#L25)*
|
||||
|
||||
**Returns:** `PropIndex`
|
||||
|
||||
@@ -122,7 +122,7 @@ ___
|
||||
|
||||
getproposal(): `Proposal`
|
||||
|
||||
*Defined in [classes.ts:29](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/classes.ts#L29)*
|
||||
*Defined in [classes.ts:29](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/classes.ts#L29)*
|
||||
|
||||
**Returns:** `Proposal`
|
||||
|
||||
@@ -222,7 +222,7 @@ ___
|
||||
|
||||
*Overrides Map.get*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L158)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L158)*
|
||||
|
||||
*__description__*: Returns a specific names entry in the structure
|
||||
|
||||
@@ -243,7 +243,7 @@ ___
|
||||
|
||||
*Inherited from Struct.getAtIndex*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:165](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L165)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:165](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L165)*
|
||||
|
||||
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
|
||||
|
||||
@@ -318,7 +318,7 @@ ___
|
||||
|
||||
*Inherited from Struct.toArray*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:172](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L172)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:172](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L172)*
|
||||
|
||||
*__description__*: Converts the Object to an standard JavaScript Array
|
||||
|
||||
@@ -333,7 +333,7 @@ ___
|
||||
|
||||
*Inherited from Struct.toHex*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:179](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L179)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:179](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L179)*
|
||||
|
||||
*__description__*: Returns a hex string representation of the value
|
||||
|
||||
@@ -348,7 +348,7 @@ ___
|
||||
|
||||
*Inherited from Struct.toJSON*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:186](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L186)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:186](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L186)*
|
||||
|
||||
*__description__*: Converts the Object to JSON, typically used for RPC transfers
|
||||
|
||||
@@ -363,7 +363,7 @@ ___
|
||||
|
||||
*Inherited from Struct.toString*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:200](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L200)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:200](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L200)*
|
||||
|
||||
*__description__*: Returns the string representation of the value
|
||||
|
||||
@@ -378,7 +378,7 @@ ___
|
||||
|
||||
*Inherited from Struct.toU8a*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L208)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L208)*
|
||||
|
||||
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
|
||||
|
||||
@@ -414,7 +414,7 @@ ___
|
||||
|
||||
*Inherited from Struct.with*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:121](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L121)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:121](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L121)*
|
||||
|
||||
**Type parameters:**
|
||||
|
||||
|
||||
@@ -25,7 +25,7 @@
|
||||
|
||||
*Overrides Struct.__constructor*
|
||||
|
||||
*Defined in [classes.ts:36](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/classes.ts#L36)*
|
||||
*Defined in [classes.ts:36](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/classes.ts#L36)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -72,7 +72,7 @@ getType(): `E`
|
||||
|
||||
*Inherited from Struct.Type*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L141)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L141)*
|
||||
|
||||
*__description__*: Returns the Type description to sthe structure
|
||||
|
||||
@@ -85,7 +85,7 @@ ___
|
||||
|
||||
getaddresses(): `Vector`<`AccountId`>
|
||||
|
||||
*Defined in [classes.ts:44](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/classes.ts#L44)*
|
||||
*Defined in [classes.ts:44](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/classes.ts#L44)*
|
||||
|
||||
**Returns:** `Vector`<`AccountId`>
|
||||
|
||||
@@ -96,7 +96,7 @@ ___
|
||||
|
||||
getbalance(): `Balance`
|
||||
|
||||
*Defined in [classes.ts:48](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/classes.ts#L48)*
|
||||
*Defined in [classes.ts:48](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/classes.ts#L48)*
|
||||
|
||||
**Returns:** `Balance`
|
||||
|
||||
@@ -109,7 +109,7 @@ getencodedLength(): `number`
|
||||
|
||||
*Inherited from Struct.encodedLength*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L148)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L148)*
|
||||
|
||||
*__description__*: The length of the value when encoded as a Uint8Array
|
||||
|
||||
@@ -211,7 +211,7 @@ ___
|
||||
|
||||
*Overrides Map.get*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L158)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L158)*
|
||||
|
||||
*__description__*: Returns a specific names entry in the structure
|
||||
|
||||
@@ -232,7 +232,7 @@ ___
|
||||
|
||||
*Inherited from Struct.getAtIndex*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:165](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L165)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:165](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L165)*
|
||||
|
||||
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
|
||||
|
||||
@@ -307,7 +307,7 @@ ___
|
||||
|
||||
*Inherited from Struct.toArray*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:172](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L172)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:172](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L172)*
|
||||
|
||||
*__description__*: Converts the Object to an standard JavaScript Array
|
||||
|
||||
@@ -322,7 +322,7 @@ ___
|
||||
|
||||
*Inherited from Struct.toHex*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:179](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L179)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:179](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L179)*
|
||||
|
||||
*__description__*: Returns a hex string representation of the value
|
||||
|
||||
@@ -337,7 +337,7 @@ ___
|
||||
|
||||
*Inherited from Struct.toJSON*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:186](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L186)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:186](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L186)*
|
||||
|
||||
*__description__*: Converts the Object to JSON, typically used for RPC transfers
|
||||
|
||||
@@ -352,7 +352,7 @@ ___
|
||||
|
||||
*Inherited from Struct.toString*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:200](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L200)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:200](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L200)*
|
||||
|
||||
*__description__*: Returns the string representation of the value
|
||||
|
||||
@@ -367,7 +367,7 @@ ___
|
||||
|
||||
*Inherited from Struct.toU8a*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L208)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L208)*
|
||||
|
||||
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
|
||||
|
||||
@@ -403,7 +403,7 @@ ___
|
||||
|
||||
*Inherited from Struct.with*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:121](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L121)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:121](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L121)*
|
||||
|
||||
**Type parameters:**
|
||||
|
||||
|
||||
@@ -25,7 +25,7 @@
|
||||
|
||||
*Overrides Struct.__constructor*
|
||||
|
||||
*Defined in [classes.ts:55](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/classes.ts#L55)*
|
||||
*Defined in [classes.ts:55](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/classes.ts#L55)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -73,7 +73,7 @@ getType(): `E`
|
||||
|
||||
*Inherited from Struct.Type*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L141)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L141)*
|
||||
|
||||
*__description__*: Returns the Type description to sthe structure
|
||||
|
||||
@@ -86,7 +86,7 @@ ___
|
||||
|
||||
getblockNumber(): `BlockNumber`
|
||||
|
||||
*Defined in [classes.ts:65](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/classes.ts#L65)*
|
||||
*Defined in [classes.ts:65](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/classes.ts#L65)*
|
||||
|
||||
**Returns:** `BlockNumber`
|
||||
|
||||
@@ -99,7 +99,7 @@ getencodedLength(): `number`
|
||||
|
||||
*Inherited from Struct.encodedLength*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L148)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L148)*
|
||||
|
||||
*__description__*: The length of the value when encoded as a Uint8Array
|
||||
|
||||
@@ -112,7 +112,7 @@ ___
|
||||
|
||||
getid(): `ReferendumIndex`
|
||||
|
||||
*Defined in [classes.ts:69](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/classes.ts#L69)*
|
||||
*Defined in [classes.ts:69](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/classes.ts#L69)*
|
||||
|
||||
**Returns:** `ReferendumIndex`
|
||||
|
||||
@@ -123,7 +123,7 @@ ___
|
||||
|
||||
getproposal(): `Proposal`
|
||||
|
||||
*Defined in [classes.ts:73](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/classes.ts#L73)*
|
||||
*Defined in [classes.ts:73](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/classes.ts#L73)*
|
||||
|
||||
**Returns:** `Proposal`
|
||||
|
||||
@@ -134,7 +134,7 @@ ___
|
||||
|
||||
getvoteThreshold(): `VoteThreshold`
|
||||
|
||||
*Defined in [classes.ts:77](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/classes.ts#L77)*
|
||||
*Defined in [classes.ts:77](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/classes.ts#L77)*
|
||||
|
||||
**Returns:** `VoteThreshold`
|
||||
|
||||
@@ -234,7 +234,7 @@ ___
|
||||
|
||||
*Overrides Map.get*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L158)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L158)*
|
||||
|
||||
*__description__*: Returns a specific names entry in the structure
|
||||
|
||||
@@ -255,7 +255,7 @@ ___
|
||||
|
||||
*Inherited from Struct.getAtIndex*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:165](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L165)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:165](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L165)*
|
||||
|
||||
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
|
||||
|
||||
@@ -330,7 +330,7 @@ ___
|
||||
|
||||
*Inherited from Struct.toArray*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:172](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L172)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:172](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L172)*
|
||||
|
||||
*__description__*: Converts the Object to an standard JavaScript Array
|
||||
|
||||
@@ -345,7 +345,7 @@ ___
|
||||
|
||||
*Inherited from Struct.toHex*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:179](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L179)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:179](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L179)*
|
||||
|
||||
*__description__*: Returns a hex string representation of the value
|
||||
|
||||
@@ -360,7 +360,7 @@ ___
|
||||
|
||||
*Inherited from Struct.toJSON*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:186](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L186)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:186](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L186)*
|
||||
|
||||
*__description__*: Converts the Object to JSON, typically used for RPC transfers
|
||||
|
||||
@@ -375,7 +375,7 @@ ___
|
||||
|
||||
*Inherited from Struct.toString*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:200](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L200)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:200](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L200)*
|
||||
|
||||
*__description__*: Returns the string representation of the value
|
||||
|
||||
@@ -390,7 +390,7 @@ ___
|
||||
|
||||
*Inherited from Struct.toU8a*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L208)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L208)*
|
||||
|
||||
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
|
||||
|
||||
@@ -426,7 +426,7 @@ ___
|
||||
|
||||
*Inherited from Struct.with*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:121](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L121)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:121](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L121)*
|
||||
|
||||
**Type parameters:**
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
|
||||
|
||||
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Base.ts#L33)*
|
||||
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Base.ts#L33)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -40,7 +40,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[whenReady](_base_.apibase.md#whenready)*
|
||||
|
||||
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Base.ts#L33)*
|
||||
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Base.ts#L33)*
|
||||
|
||||
___
|
||||
<a id="extrinsics"></a>
|
||||
@@ -51,7 +51,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[extrinsics](_base_.apibase.md#extrinsics)*
|
||||
|
||||
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Base.ts#L41)*
|
||||
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Base.ts#L41)*
|
||||
|
||||
___
|
||||
<a id="storage"></a>
|
||||
@@ -62,7 +62,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[storage](_base_.apibase.md#storage)*
|
||||
|
||||
*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Base.ts#L42)*
|
||||
*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Base.ts#L42)*
|
||||
|
||||
___
|
||||
|
||||
@@ -76,7 +76,7 @@ getgenesisHash(): `Hash`
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)*
|
||||
|
||||
*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Base.ts#L87)*
|
||||
*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Base.ts#L87)*
|
||||
|
||||
**Returns:** `Hash`
|
||||
|
||||
@@ -90,7 +90,7 @@ ___
|
||||
|
||||
▸ **accountIdAndIndex**(address?: * `AccountId` | `AccountIndex` | `string` | `null`*): `Observable`<[`AccountId` | `undefined`, `AccountIndex` | `undefined`]>
|
||||
|
||||
*Defined in [Combined.ts:79](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Combined.ts#L79)*
|
||||
*Defined in [Combined.ts:79](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Combined.ts#L79)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -107,7 +107,7 @@ ___
|
||||
|
||||
▸ **accountIdFromIndex**(_accountIndex: * `AccountIndex` | `string`*): `Observable`< `AccountId` | `undefined`>
|
||||
|
||||
*Defined in [Combined.ts:53](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Combined.ts#L53)*
|
||||
*Defined in [Combined.ts:53](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Combined.ts#L53)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -124,7 +124,7 @@ ___
|
||||
|
||||
▸ **accountIndexFromId**(accountId: * `AccountId` | `string`*): `Observable`< `AccountIndex` | `undefined`>
|
||||
|
||||
*Defined in [Combined.ts:68](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Combined.ts#L68)*
|
||||
*Defined in [Combined.ts:68](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Combined.ts#L68)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -141,7 +141,7 @@ ___
|
||||
|
||||
▸ **accountIndexes**(): `Observable`<`object`>
|
||||
|
||||
*Defined in [Combined.ts:23](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Combined.ts#L23)*
|
||||
*Defined in [Combined.ts:23](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Combined.ts#L23)*
|
||||
|
||||
**Returns:** `Observable`<`object`>
|
||||
|
||||
@@ -154,7 +154,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[accountNonce](_queries_.apiqueries.md#accountnonce)*
|
||||
|
||||
*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L19)*
|
||||
*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L19)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -173,7 +173,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceFree](_queries_.apiqueries.md#balancefree)*
|
||||
|
||||
*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L23)*
|
||||
*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L23)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -192,7 +192,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceReserved](_queries_.apiqueries.md#balancereserved)*
|
||||
|
||||
*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L27)*
|
||||
*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L27)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -211,7 +211,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCalls](_calls_.apicalls.md).[bestNumber](_calls_.apicalls.md#bestnumber)*
|
||||
|
||||
*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Calls.ts#L13)*
|
||||
*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Calls.ts#L13)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -224,7 +224,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[blockNow](_queries_.apiqueries.md#blocknow)*
|
||||
|
||||
*Defined in [Queries.ts:35](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L35)*
|
||||
*Defined in [Queries.ts:35](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L35)*
|
||||
|
||||
**Returns:** `Observable`< `Moment` | `undefined`>
|
||||
|
||||
@@ -237,7 +237,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[blockPeriod](_queries_.apiqueries.md#blockperiod)*
|
||||
|
||||
*Defined in [Queries.ts:31](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L31)*
|
||||
*Defined in [Queries.ts:31](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L31)*
|
||||
|
||||
**Returns:** `Observable`< `Moment` | `undefined`>
|
||||
|
||||
@@ -250,7 +250,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCalls](_calls_.apicalls.md).[chain](_calls_.apicalls.md#chain)*
|
||||
|
||||
*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Calls.ts#L25)*
|
||||
*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Calls.ts#L25)*
|
||||
|
||||
**Returns:** `Observable`< `Text` | `undefined`>
|
||||
|
||||
@@ -263,7 +263,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCalls](_calls_.apicalls.md).[chainProperties](_calls_.apicalls.md#chainproperties)*
|
||||
|
||||
*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Calls.ts#L29)*
|
||||
*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Calls.ts#L29)*
|
||||
|
||||
**Returns:** `Observable`<`ChainProperties`>
|
||||
|
||||
@@ -276,7 +276,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyLaunchPeriod](_queries_.apiqueries.md#democracylaunchperiod)*
|
||||
|
||||
*Defined in [Queries.ts:39](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L39)*
|
||||
*Defined in [Queries.ts:39](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L39)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -289,7 +289,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyNextTally](_queries_.apiqueries.md#democracynexttally)*
|
||||
|
||||
*Defined in [Queries.ts:43](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L43)*
|
||||
*Defined in [Queries.ts:43](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L43)*
|
||||
|
||||
**Returns:** `Observable`< `ReferendumIndex` | `undefined`>
|
||||
|
||||
@@ -300,7 +300,7 @@ ___
|
||||
|
||||
▸ **democracyReferendumVoters**(referendumId: * `ReferendumIndex` | `BN` | `number`*): `Observable`<`Array`<[RxReferendumVote](../modules/_types_.md#rxreferendumvote)>>
|
||||
|
||||
*Defined in [Combined.ts:137](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Combined.ts#L137)*
|
||||
*Defined in [Combined.ts:137](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Combined.ts#L137)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -317,7 +317,7 @@ ___
|
||||
|
||||
▸ **democracyVotersBalancesOf**(referendumId: * `ReferendumIndex` | `BN` | `number`*): `Observable`<`Array`<`Balance`>>
|
||||
|
||||
*Defined in [Combined.ts:182](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Combined.ts#L182)*
|
||||
*Defined in [Combined.ts:182](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Combined.ts#L182)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -334,7 +334,7 @@ ___
|
||||
|
||||
▸ **democracyVotersVotesOf**(referendumId: * `ReferendumIndex` | `BN` | `number`*): `Observable`<`Array`<`Bool`>>
|
||||
|
||||
*Defined in [Combined.ts:198](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Combined.ts#L198)*
|
||||
*Defined in [Combined.ts:198](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Combined.ts#L198)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -353,7 +353,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyVotingPeriod](_queries_.apiqueries.md#democracyvotingperiod)*
|
||||
|
||||
*Defined in [Queries.ts:126](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L126)*
|
||||
*Defined in [Queries.ts:126](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L126)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -364,7 +364,7 @@ ___
|
||||
|
||||
▸ **eraBlockLength**(): `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
*Defined in [Combined.ts:209](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Combined.ts#L209)*
|
||||
*Defined in [Combined.ts:209](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Combined.ts#L209)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -375,7 +375,7 @@ ___
|
||||
|
||||
▸ **eraBlockProgress**(): `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
*Defined in [Combined.ts:224](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Combined.ts#L224)*
|
||||
*Defined in [Combined.ts:224](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Combined.ts#L224)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -386,7 +386,7 @@ ___
|
||||
|
||||
▸ **eraBlockRemaining**(): `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
*Defined in [Combined.ts:247](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Combined.ts#L247)*
|
||||
*Defined in [Combined.ts:247](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Combined.ts#L247)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -399,7 +399,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[eraLastLengthChange](_queries_.apiqueries.md#eralastlengthchange)*
|
||||
|
||||
*Defined in [Queries.ts:151](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L151)*
|
||||
*Defined in [Queries.ts:151](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L151)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -412,7 +412,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[fees](_queries_.apiqueries.md#fees)*
|
||||
|
||||
*Defined in [Queries.ts:130](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L130)*
|
||||
*Defined in [Queries.ts:130](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L130)*
|
||||
|
||||
**Returns:** `Observable`<[RxFees](../modules/_types_.md#rxfees)>
|
||||
|
||||
@@ -425,7 +425,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[getAccountEnumSet](_queries_.apiqueries.md#getaccountenumset)*
|
||||
|
||||
*Defined in [Queries.ts:47](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L47)*
|
||||
*Defined in [Queries.ts:47](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L47)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -444,7 +444,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCalls](_calls_.apicalls.md).[getBlock](_calls_.apicalls.md#getblock)*
|
||||
|
||||
*Defined in [Calls.ts:41](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Calls.ts#L41)*
|
||||
*Defined in [Calls.ts:41](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Calls.ts#L41)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -463,7 +463,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[isConnected](_base_.apibase.md#isconnected)*
|
||||
|
||||
*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Base.ts#L91)*
|
||||
*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Base.ts#L91)*
|
||||
|
||||
**Returns:** `Observable`<`boolean`>
|
||||
|
||||
@@ -476,7 +476,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[nextAccountEnumSet](_queries_.apiqueries.md#nextaccountenumset)*
|
||||
|
||||
*Defined in [Queries.ts:58](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L58)*
|
||||
*Defined in [Queries.ts:58](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L58)*
|
||||
|
||||
**Returns:** `Observable`< `AccountIndex` | `undefined`>
|
||||
|
||||
@@ -489,7 +489,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[proposalDeposits](_queries_.apiqueries.md#proposaldeposits)*
|
||||
|
||||
*Defined in [Queries.ts:62](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L62)*
|
||||
*Defined in [Queries.ts:62](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L62)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -506,7 +506,7 @@ ___
|
||||
|
||||
▸ **publicProposalCount**(): `Observable`<`number`>
|
||||
|
||||
*Defined in [Combined.ts:115](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Combined.ts#L115)*
|
||||
*Defined in [Combined.ts:115](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Combined.ts#L115)*
|
||||
|
||||
**Returns:** `Observable`<`number`>
|
||||
|
||||
@@ -519,7 +519,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[publicProposals](_queries_.apiqueries.md#publicproposals)*
|
||||
|
||||
*Defined in [Queries.ts:75](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L75)*
|
||||
*Defined in [Queries.ts:75](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L75)*
|
||||
|
||||
**Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>>
|
||||
|
||||
@@ -532,7 +532,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)*
|
||||
|
||||
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Base.ts#L95)*
|
||||
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Base.ts#L95)*
|
||||
|
||||
**Type parameters:**
|
||||
|
||||
@@ -555,7 +555,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)*
|
||||
|
||||
*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Base.ts#L108)*
|
||||
*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Base.ts#L108)*
|
||||
|
||||
**Type parameters:**
|
||||
|
||||
@@ -578,7 +578,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)*
|
||||
|
||||
*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Base.ts#L123)*
|
||||
*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Base.ts#L123)*
|
||||
|
||||
**Type parameters:**
|
||||
|
||||
@@ -600,7 +600,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumCount](_queries_.apiqueries.md#referendumcount)*
|
||||
|
||||
*Defined in [Queries.ts:94](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L94)*
|
||||
*Defined in [Queries.ts:94](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L94)*
|
||||
|
||||
**Returns:** `Observable`< `ReferendumIndex` | `undefined`>
|
||||
|
||||
@@ -613,7 +613,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumInfo](_queries_.apiqueries.md#referenduminfo)*
|
||||
|
||||
*Defined in [Queries.ts:98](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L98)*
|
||||
*Defined in [Queries.ts:98](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L98)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -632,7 +632,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVote](_queries_.apiqueries.md#referendumvote)*
|
||||
|
||||
*Defined in [Queries.ts:111](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L111)*
|
||||
*Defined in [Queries.ts:111](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L111)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -652,7 +652,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVoters](_queries_.apiqueries.md#referendumvoters)*
|
||||
|
||||
*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L115)*
|
||||
*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L115)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -669,7 +669,7 @@ ___
|
||||
|
||||
▸ **referendumVotes**(index: * `ReferendumIndex` | `BN` | `number`*, addresses: *`Array`< `AccountId` | `string`>*): `Observable`<`boolean`>
|
||||
|
||||
*Defined in [Combined.ts:174](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Combined.ts#L174)*
|
||||
*Defined in [Combined.ts:174](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Combined.ts#L174)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -687,7 +687,7 @@ ___
|
||||
|
||||
▸ **referendums**(): `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>>
|
||||
|
||||
*Defined in [Combined.ts:153](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Combined.ts#L153)*
|
||||
*Defined in [Combined.ts:153](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Combined.ts#L153)*
|
||||
|
||||
**Returns:** `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>>
|
||||
|
||||
@@ -698,7 +698,7 @@ ___
|
||||
|
||||
▸ **referendumsInfo**(referendumIds: *`Array`< `ReferendumIndex` | `BN` | `number`>*): `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>>
|
||||
|
||||
*Defined in [Combined.ts:125](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Combined.ts#L125)*
|
||||
*Defined in [Combined.ts:125](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Combined.ts#L125)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -715,7 +715,7 @@ ___
|
||||
|
||||
▸ **sessionBlockProgress**(): `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
*Defined in [Combined.ts:262](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Combined.ts#L262)*
|
||||
*Defined in [Combined.ts:262](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Combined.ts#L262)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -726,7 +726,7 @@ ___
|
||||
|
||||
▸ **sessionBlockRemaining**(): `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
*Defined in [Combined.ts:282](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Combined.ts#L282)*
|
||||
*Defined in [Combined.ts:282](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Combined.ts#L282)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -737,7 +737,7 @@ ___
|
||||
|
||||
▸ **sessionBrokenValue**(): `Observable`< `Moment` | `undefined`>
|
||||
|
||||
*Defined in [Combined.ts:297](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Combined.ts#L297)*
|
||||
*Defined in [Combined.ts:297](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Combined.ts#L297)*
|
||||
|
||||
**Returns:** `Observable`< `Moment` | `undefined`>
|
||||
|
||||
@@ -750,7 +750,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentIndex](_queries_.apiqueries.md#sessioncurrentindex)*
|
||||
|
||||
*Defined in [Queries.ts:163](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L163)*
|
||||
*Defined in [Queries.ts:163](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L163)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -763,7 +763,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentStart](_queries_.apiqueries.md#sessioncurrentstart)*
|
||||
|
||||
*Defined in [Queries.ts:167](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L167)*
|
||||
*Defined in [Queries.ts:167](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L167)*
|
||||
|
||||
**Returns:** `Observable`< `Moment` | `undefined`>
|
||||
|
||||
@@ -776,7 +776,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLastLengthChange](_queries_.apiqueries.md#sessionlastlengthchange)*
|
||||
|
||||
*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L171)*
|
||||
*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L171)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -789,7 +789,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLength](_queries_.apiqueries.md#sessionlength)*
|
||||
|
||||
*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L175)*
|
||||
*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L175)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -802,7 +802,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionReward](_queries_.apiqueries.md#sessionreward)*
|
||||
|
||||
*Defined in [Queries.ts:155](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L155)*
|
||||
*Defined in [Queries.ts:155](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L155)*
|
||||
|
||||
**Returns:** `Observable`< `Perbill` | `undefined`>
|
||||
|
||||
@@ -815,7 +815,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionRewardCurrent](_queries_.apiqueries.md#sessionrewardcurrent)*
|
||||
|
||||
*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L159)*
|
||||
*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L159)*
|
||||
|
||||
**Returns:** `Observable`< `Balance` | `undefined`>
|
||||
|
||||
@@ -826,7 +826,7 @@ ___
|
||||
|
||||
▸ **sessionTimeExpected**(): `Observable`< `Moment` | `undefined`>
|
||||
|
||||
*Defined in [Combined.ts:316](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Combined.ts#L316)*
|
||||
*Defined in [Combined.ts:316](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Combined.ts#L316)*
|
||||
|
||||
**Returns:** `Observable`< `Moment` | `undefined`>
|
||||
|
||||
@@ -837,7 +837,7 @@ ___
|
||||
|
||||
▸ **sessionTimeRemaining**(): `Observable`< `Moment` | `undefined`>
|
||||
|
||||
*Defined in [Combined.ts:331](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Combined.ts#L331)*
|
||||
*Defined in [Combined.ts:331](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Combined.ts#L331)*
|
||||
|
||||
**Returns:** `Observable`< `Moment` | `undefined`>
|
||||
|
||||
@@ -850,7 +850,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionValidators](_queries_.apiqueries.md#sessionvalidators)*
|
||||
|
||||
*Defined in [Queries.ts:183](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L183)*
|
||||
*Defined in [Queries.ts:183](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L183)*
|
||||
|
||||
**Returns:** `Observable`<`Array`<`AccountId`>>
|
||||
|
||||
@@ -863,7 +863,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionsPerEra](_queries_.apiqueries.md#sessionsperera)*
|
||||
|
||||
*Defined in [Queries.ts:179](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L179)*
|
||||
*Defined in [Queries.ts:179](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L179)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -876,7 +876,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingIntentions](_queries_.apiqueries.md#stakingintentions)*
|
||||
|
||||
*Defined in [Queries.ts:194](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L194)*
|
||||
*Defined in [Queries.ts:194](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L194)*
|
||||
|
||||
**Returns:** `Observable`<`Array`<`AccountId`>>
|
||||
|
||||
@@ -889,7 +889,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominating](_queries_.apiqueries.md#stakingnominating)*
|
||||
|
||||
*Defined in [Queries.ts:216](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L216)*
|
||||
*Defined in [Queries.ts:216](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L216)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -908,7 +908,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominatorsFor](_queries_.apiqueries.md#stakingnominatorsfor)*
|
||||
|
||||
*Defined in [Queries.ts:205](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L205)*
|
||||
*Defined in [Queries.ts:205](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L205)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -927,7 +927,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCalls](_calls_.apicalls.md).[submitAndWatchExtrinsic](_calls_.apicalls.md#submitandwatchextrinsic)*
|
||||
|
||||
*Defined in [Calls.ts:63](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Calls.ts#L63)*
|
||||
*Defined in [Calls.ts:63](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Calls.ts#L63)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -946,7 +946,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCalls](_calls_.apicalls.md).[submitExtrinsic](_calls_.apicalls.md#submitextrinsic)*
|
||||
|
||||
*Defined in [Calls.ts:59](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Calls.ts#L59)*
|
||||
*Defined in [Calls.ts:59](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Calls.ts#L59)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -965,7 +965,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCalls](_calls_.apicalls.md).[subscribeNewHead](_calls_.apicalls.md#subscribenewhead)*
|
||||
|
||||
*Defined in [Calls.ts:45](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Calls.ts#L45)*
|
||||
*Defined in [Calls.ts:45](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Calls.ts#L45)*
|
||||
|
||||
**Returns:** `Observable`< `Header` | `undefined`>
|
||||
|
||||
@@ -978,7 +978,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[systemEvents](_queries_.apiqueries.md#systemevents)*
|
||||
|
||||
*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L220)*
|
||||
*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L220)*
|
||||
|
||||
**Returns:** `Observable`<`Array`<`EventRecord`>>
|
||||
|
||||
@@ -991,7 +991,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCalls](_calls_.apicalls.md).[systemName](_calls_.apicalls.md#systemname)*
|
||||
|
||||
*Defined in [Calls.ts:51](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Calls.ts#L51)*
|
||||
*Defined in [Calls.ts:51](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Calls.ts#L51)*
|
||||
|
||||
**Returns:** `Observable`< `Text` | `undefined`>
|
||||
|
||||
@@ -1004,7 +1004,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCalls](_calls_.apicalls.md).[systemVersion](_calls_.apicalls.md#systemversion)*
|
||||
|
||||
*Defined in [Calls.ts:55](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Calls.ts#L55)*
|
||||
*Defined in [Calls.ts:55](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Calls.ts#L55)*
|
||||
|
||||
**Returns:** `Observable`< `Text` | `undefined`>
|
||||
|
||||
@@ -1015,7 +1015,7 @@ ___
|
||||
|
||||
▸ **validatingBalance**(address: * `AccountId` | `string`*): `Observable`<[RxBalance](../modules/_types_.md#rxbalance)>
|
||||
|
||||
*Defined in [Combined.ts:346](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Combined.ts#L346)*
|
||||
*Defined in [Combined.ts:346](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Combined.ts#L346)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -1032,7 +1032,7 @@ ___
|
||||
|
||||
▸ **validatingBalances**(...addresses: *`Array`< `AccountId` | `string`>*): `Observable`<[RxBalanceMap](../modules/_types_.md#rxbalancemap)>
|
||||
|
||||
*Defined in [Combined.ts:371](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Combined.ts#L371)*
|
||||
*Defined in [Combined.ts:371](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Combined.ts#L371)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -1051,7 +1051,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[validatorCount](_queries_.apiqueries.md#validatorcount)*
|
||||
|
||||
*Defined in [Queries.ts:231](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L231)*
|
||||
*Defined in [Queries.ts:231](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L231)*
|
||||
|
||||
**Returns:** `Observable`< `u32` | `undefined`>
|
||||
|
||||
@@ -1062,7 +1062,7 @@ ___
|
||||
|
||||
▸ **votingBalance**(address: * `AccountIndex` | `AccountId` | `string`*): `Observable`<[RxBalance](../modules/_types_.md#rxbalance)>
|
||||
|
||||
*Defined in [Combined.ts:385](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Combined.ts#L385)*
|
||||
*Defined in [Combined.ts:385](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Combined.ts#L385)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -1079,7 +1079,7 @@ ___
|
||||
|
||||
▸ **votingBalances**(...addresses: *`Array`< `AccountId` | `string`>*): `Observable`<[RxBalance](../modules/_types_.md#rxbalance)[]>
|
||||
|
||||
*Defined in [Combined.ts:425](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Combined.ts#L425)*
|
||||
*Defined in [Combined.ts:425](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Combined.ts#L425)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -1096,7 +1096,7 @@ ___
|
||||
|
||||
▸ **votingBalancesNominatorsFor**(address: * `AccountId` | `string`*): `Observable`<`any`>
|
||||
|
||||
*Defined in [Combined.ts:414](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Combined.ts#L414)*
|
||||
*Defined in [Combined.ts:414](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Combined.ts#L414)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -16,7 +16,7 @@
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
|
||||
|
||||
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Base.ts#L33)*
|
||||
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Base.ts#L33)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -38,7 +38,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[whenReady](_base_.apibase.md#whenready)*
|
||||
|
||||
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Base.ts#L33)*
|
||||
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Base.ts#L33)*
|
||||
|
||||
___
|
||||
<a id="extrinsics"></a>
|
||||
@@ -49,7 +49,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[extrinsics](_base_.apibase.md#extrinsics)*
|
||||
|
||||
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Base.ts#L41)*
|
||||
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Base.ts#L41)*
|
||||
|
||||
___
|
||||
<a id="storage"></a>
|
||||
@@ -60,7 +60,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[storage](_base_.apibase.md#storage)*
|
||||
|
||||
*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Base.ts#L42)*
|
||||
*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Base.ts#L42)*
|
||||
|
||||
___
|
||||
|
||||
@@ -74,7 +74,7 @@ getgenesisHash(): `Hash`
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)*
|
||||
|
||||
*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Base.ts#L87)*
|
||||
*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Base.ts#L87)*
|
||||
|
||||
**Returns:** `Hash`
|
||||
|
||||
@@ -90,7 +90,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCombined](_combined_.apicombined.md).[accountIdAndIndex](_combined_.apicombined.md#accountidandindex)*
|
||||
|
||||
*Defined in [Combined.ts:79](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Combined.ts#L79)*
|
||||
*Defined in [Combined.ts:79](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Combined.ts#L79)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -109,7 +109,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCombined](_combined_.apicombined.md).[accountIdFromIndex](_combined_.apicombined.md#accountidfromindex)*
|
||||
|
||||
*Defined in [Combined.ts:53](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Combined.ts#L53)*
|
||||
*Defined in [Combined.ts:53](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Combined.ts#L53)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -128,7 +128,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCombined](_combined_.apicombined.md).[accountIndexFromId](_combined_.apicombined.md#accountindexfromid)*
|
||||
|
||||
*Defined in [Combined.ts:68](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Combined.ts#L68)*
|
||||
*Defined in [Combined.ts:68](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Combined.ts#L68)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -147,7 +147,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCombined](_combined_.apicombined.md).[accountIndexes](_combined_.apicombined.md#accountindexes)*
|
||||
|
||||
*Defined in [Combined.ts:23](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Combined.ts#L23)*
|
||||
*Defined in [Combined.ts:23](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Combined.ts#L23)*
|
||||
|
||||
**Returns:** `Observable`<`object`>
|
||||
|
||||
@@ -160,7 +160,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[accountNonce](_queries_.apiqueries.md#accountnonce)*
|
||||
|
||||
*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L19)*
|
||||
*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L19)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -179,7 +179,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceFree](_queries_.apiqueries.md#balancefree)*
|
||||
|
||||
*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L23)*
|
||||
*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L23)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -198,7 +198,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceReserved](_queries_.apiqueries.md#balancereserved)*
|
||||
|
||||
*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L27)*
|
||||
*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L27)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -217,7 +217,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCalls](_calls_.apicalls.md).[bestNumber](_calls_.apicalls.md#bestnumber)*
|
||||
|
||||
*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Calls.ts#L13)*
|
||||
*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Calls.ts#L13)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -230,7 +230,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[blockNow](_queries_.apiqueries.md#blocknow)*
|
||||
|
||||
*Defined in [Queries.ts:35](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L35)*
|
||||
*Defined in [Queries.ts:35](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L35)*
|
||||
|
||||
**Returns:** `Observable`< `Moment` | `undefined`>
|
||||
|
||||
@@ -243,7 +243,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[blockPeriod](_queries_.apiqueries.md#blockperiod)*
|
||||
|
||||
*Defined in [Queries.ts:31](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L31)*
|
||||
*Defined in [Queries.ts:31](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L31)*
|
||||
|
||||
**Returns:** `Observable`< `Moment` | `undefined`>
|
||||
|
||||
@@ -256,7 +256,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCalls](_calls_.apicalls.md).[chain](_calls_.apicalls.md#chain)*
|
||||
|
||||
*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Calls.ts#L25)*
|
||||
*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Calls.ts#L25)*
|
||||
|
||||
**Returns:** `Observable`< `Text` | `undefined`>
|
||||
|
||||
@@ -269,7 +269,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCalls](_calls_.apicalls.md).[chainProperties](_calls_.apicalls.md#chainproperties)*
|
||||
|
||||
*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Calls.ts#L29)*
|
||||
*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Calls.ts#L29)*
|
||||
|
||||
**Returns:** `Observable`<`ChainProperties`>
|
||||
|
||||
@@ -282,7 +282,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyLaunchPeriod](_queries_.apiqueries.md#democracylaunchperiod)*
|
||||
|
||||
*Defined in [Queries.ts:39](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L39)*
|
||||
*Defined in [Queries.ts:39](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L39)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -295,7 +295,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyNextTally](_queries_.apiqueries.md#democracynexttally)*
|
||||
|
||||
*Defined in [Queries.ts:43](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L43)*
|
||||
*Defined in [Queries.ts:43](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L43)*
|
||||
|
||||
**Returns:** `Observable`< `ReferendumIndex` | `undefined`>
|
||||
|
||||
@@ -308,7 +308,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCombined](_combined_.apicombined.md).[democracyReferendumVoters](_combined_.apicombined.md#democracyreferendumvoters)*
|
||||
|
||||
*Defined in [Combined.ts:137](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Combined.ts#L137)*
|
||||
*Defined in [Combined.ts:137](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Combined.ts#L137)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -327,7 +327,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCombined](_combined_.apicombined.md).[democracyVotersBalancesOf](_combined_.apicombined.md#democracyvotersbalancesof)*
|
||||
|
||||
*Defined in [Combined.ts:182](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Combined.ts#L182)*
|
||||
*Defined in [Combined.ts:182](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Combined.ts#L182)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -346,7 +346,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCombined](_combined_.apicombined.md).[democracyVotersVotesOf](_combined_.apicombined.md#democracyvotersvotesof)*
|
||||
|
||||
*Defined in [Combined.ts:198](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Combined.ts#L198)*
|
||||
*Defined in [Combined.ts:198](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Combined.ts#L198)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -365,7 +365,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyVotingPeriod](_queries_.apiqueries.md#democracyvotingperiod)*
|
||||
|
||||
*Defined in [Queries.ts:126](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L126)*
|
||||
*Defined in [Queries.ts:126](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L126)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -378,7 +378,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCombined](_combined_.apicombined.md).[eraBlockLength](_combined_.apicombined.md#erablocklength)*
|
||||
|
||||
*Defined in [Combined.ts:209](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Combined.ts#L209)*
|
||||
*Defined in [Combined.ts:209](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Combined.ts#L209)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -391,7 +391,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCombined](_combined_.apicombined.md).[eraBlockProgress](_combined_.apicombined.md#erablockprogress)*
|
||||
|
||||
*Defined in [Combined.ts:224](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Combined.ts#L224)*
|
||||
*Defined in [Combined.ts:224](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Combined.ts#L224)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -404,7 +404,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCombined](_combined_.apicombined.md).[eraBlockRemaining](_combined_.apicombined.md#erablockremaining)*
|
||||
|
||||
*Defined in [Combined.ts:247](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Combined.ts#L247)*
|
||||
*Defined in [Combined.ts:247](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Combined.ts#L247)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -417,7 +417,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[eraLastLengthChange](_queries_.apiqueries.md#eralastlengthchange)*
|
||||
|
||||
*Defined in [Queries.ts:151](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L151)*
|
||||
*Defined in [Queries.ts:151](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L151)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -430,7 +430,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[fees](_queries_.apiqueries.md#fees)*
|
||||
|
||||
*Defined in [Queries.ts:130](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L130)*
|
||||
*Defined in [Queries.ts:130](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L130)*
|
||||
|
||||
**Returns:** `Observable`<[RxFees](../modules/_types_.md#rxfees)>
|
||||
|
||||
@@ -443,7 +443,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[getAccountEnumSet](_queries_.apiqueries.md#getaccountenumset)*
|
||||
|
||||
*Defined in [Queries.ts:47](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L47)*
|
||||
*Defined in [Queries.ts:47](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L47)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -462,7 +462,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCalls](_calls_.apicalls.md).[getBlock](_calls_.apicalls.md#getblock)*
|
||||
|
||||
*Defined in [Calls.ts:41](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Calls.ts#L41)*
|
||||
*Defined in [Calls.ts:41](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Calls.ts#L41)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -481,7 +481,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[isConnected](_base_.apibase.md#isconnected)*
|
||||
|
||||
*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Base.ts#L91)*
|
||||
*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Base.ts#L91)*
|
||||
|
||||
**Returns:** `Observable`<`boolean`>
|
||||
|
||||
@@ -494,7 +494,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[nextAccountEnumSet](_queries_.apiqueries.md#nextaccountenumset)*
|
||||
|
||||
*Defined in [Queries.ts:58](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L58)*
|
||||
*Defined in [Queries.ts:58](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L58)*
|
||||
|
||||
**Returns:** `Observable`< `AccountIndex` | `undefined`>
|
||||
|
||||
@@ -507,7 +507,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[proposalDeposits](_queries_.apiqueries.md#proposaldeposits)*
|
||||
|
||||
*Defined in [Queries.ts:62](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L62)*
|
||||
*Defined in [Queries.ts:62](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L62)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -526,7 +526,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCombined](_combined_.apicombined.md).[publicProposalCount](_combined_.apicombined.md#publicproposalcount)*
|
||||
|
||||
*Defined in [Combined.ts:115](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Combined.ts#L115)*
|
||||
*Defined in [Combined.ts:115](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Combined.ts#L115)*
|
||||
|
||||
**Returns:** `Observable`<`number`>
|
||||
|
||||
@@ -539,7 +539,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[publicProposals](_queries_.apiqueries.md#publicproposals)*
|
||||
|
||||
*Defined in [Queries.ts:75](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L75)*
|
||||
*Defined in [Queries.ts:75](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L75)*
|
||||
|
||||
**Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>>
|
||||
|
||||
@@ -552,7 +552,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)*
|
||||
|
||||
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Base.ts#L95)*
|
||||
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Base.ts#L95)*
|
||||
|
||||
**Type parameters:**
|
||||
|
||||
@@ -575,7 +575,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)*
|
||||
|
||||
*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Base.ts#L108)*
|
||||
*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Base.ts#L108)*
|
||||
|
||||
**Type parameters:**
|
||||
|
||||
@@ -598,7 +598,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)*
|
||||
|
||||
*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Base.ts#L123)*
|
||||
*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Base.ts#L123)*
|
||||
|
||||
**Type parameters:**
|
||||
|
||||
@@ -620,7 +620,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumCount](_queries_.apiqueries.md#referendumcount)*
|
||||
|
||||
*Defined in [Queries.ts:94](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L94)*
|
||||
*Defined in [Queries.ts:94](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L94)*
|
||||
|
||||
**Returns:** `Observable`< `ReferendumIndex` | `undefined`>
|
||||
|
||||
@@ -633,7 +633,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumInfo](_queries_.apiqueries.md#referenduminfo)*
|
||||
|
||||
*Defined in [Queries.ts:98](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L98)*
|
||||
*Defined in [Queries.ts:98](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L98)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -652,7 +652,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVote](_queries_.apiqueries.md#referendumvote)*
|
||||
|
||||
*Defined in [Queries.ts:111](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L111)*
|
||||
*Defined in [Queries.ts:111](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L111)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -672,7 +672,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVoters](_queries_.apiqueries.md#referendumvoters)*
|
||||
|
||||
*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L115)*
|
||||
*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L115)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -691,7 +691,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCombined](_combined_.apicombined.md).[referendumVotes](_combined_.apicombined.md#referendumvotes)*
|
||||
|
||||
*Defined in [Combined.ts:174](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Combined.ts#L174)*
|
||||
*Defined in [Combined.ts:174](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Combined.ts#L174)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -711,7 +711,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCombined](_combined_.apicombined.md).[referendums](_combined_.apicombined.md#referendums)*
|
||||
|
||||
*Defined in [Combined.ts:153](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Combined.ts#L153)*
|
||||
*Defined in [Combined.ts:153](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Combined.ts#L153)*
|
||||
|
||||
**Returns:** `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>>
|
||||
|
||||
@@ -724,7 +724,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCombined](_combined_.apicombined.md).[referendumsInfo](_combined_.apicombined.md#referendumsinfo)*
|
||||
|
||||
*Defined in [Combined.ts:125](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Combined.ts#L125)*
|
||||
*Defined in [Combined.ts:125](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Combined.ts#L125)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -743,7 +743,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCombined](_combined_.apicombined.md).[sessionBlockProgress](_combined_.apicombined.md#sessionblockprogress)*
|
||||
|
||||
*Defined in [Combined.ts:262](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Combined.ts#L262)*
|
||||
*Defined in [Combined.ts:262](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Combined.ts#L262)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -756,7 +756,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCombined](_combined_.apicombined.md).[sessionBlockRemaining](_combined_.apicombined.md#sessionblockremaining)*
|
||||
|
||||
*Defined in [Combined.ts:282](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Combined.ts#L282)*
|
||||
*Defined in [Combined.ts:282](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Combined.ts#L282)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -769,7 +769,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCombined](_combined_.apicombined.md).[sessionBrokenValue](_combined_.apicombined.md#sessionbrokenvalue)*
|
||||
|
||||
*Defined in [Combined.ts:297](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Combined.ts#L297)*
|
||||
*Defined in [Combined.ts:297](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Combined.ts#L297)*
|
||||
|
||||
**Returns:** `Observable`< `Moment` | `undefined`>
|
||||
|
||||
@@ -782,7 +782,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentIndex](_queries_.apiqueries.md#sessioncurrentindex)*
|
||||
|
||||
*Defined in [Queries.ts:163](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L163)*
|
||||
*Defined in [Queries.ts:163](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L163)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -795,7 +795,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentStart](_queries_.apiqueries.md#sessioncurrentstart)*
|
||||
|
||||
*Defined in [Queries.ts:167](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L167)*
|
||||
*Defined in [Queries.ts:167](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L167)*
|
||||
|
||||
**Returns:** `Observable`< `Moment` | `undefined`>
|
||||
|
||||
@@ -808,7 +808,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLastLengthChange](_queries_.apiqueries.md#sessionlastlengthchange)*
|
||||
|
||||
*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L171)*
|
||||
*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L171)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -821,7 +821,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLength](_queries_.apiqueries.md#sessionlength)*
|
||||
|
||||
*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L175)*
|
||||
*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L175)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -834,7 +834,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionReward](_queries_.apiqueries.md#sessionreward)*
|
||||
|
||||
*Defined in [Queries.ts:155](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L155)*
|
||||
*Defined in [Queries.ts:155](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L155)*
|
||||
|
||||
**Returns:** `Observable`< `Perbill` | `undefined`>
|
||||
|
||||
@@ -847,7 +847,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionRewardCurrent](_queries_.apiqueries.md#sessionrewardcurrent)*
|
||||
|
||||
*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L159)*
|
||||
*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L159)*
|
||||
|
||||
**Returns:** `Observable`< `Balance` | `undefined`>
|
||||
|
||||
@@ -860,7 +860,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCombined](_combined_.apicombined.md).[sessionTimeExpected](_combined_.apicombined.md#sessiontimeexpected)*
|
||||
|
||||
*Defined in [Combined.ts:316](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Combined.ts#L316)*
|
||||
*Defined in [Combined.ts:316](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Combined.ts#L316)*
|
||||
|
||||
**Returns:** `Observable`< `Moment` | `undefined`>
|
||||
|
||||
@@ -873,7 +873,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCombined](_combined_.apicombined.md).[sessionTimeRemaining](_combined_.apicombined.md#sessiontimeremaining)*
|
||||
|
||||
*Defined in [Combined.ts:331](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Combined.ts#L331)*
|
||||
*Defined in [Combined.ts:331](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Combined.ts#L331)*
|
||||
|
||||
**Returns:** `Observable`< `Moment` | `undefined`>
|
||||
|
||||
@@ -886,7 +886,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionValidators](_queries_.apiqueries.md#sessionvalidators)*
|
||||
|
||||
*Defined in [Queries.ts:183](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L183)*
|
||||
*Defined in [Queries.ts:183](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L183)*
|
||||
|
||||
**Returns:** `Observable`<`Array`<`AccountId`>>
|
||||
|
||||
@@ -899,7 +899,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionsPerEra](_queries_.apiqueries.md#sessionsperera)*
|
||||
|
||||
*Defined in [Queries.ts:179](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L179)*
|
||||
*Defined in [Queries.ts:179](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L179)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -912,7 +912,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingIntentions](_queries_.apiqueries.md#stakingintentions)*
|
||||
|
||||
*Defined in [Queries.ts:194](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L194)*
|
||||
*Defined in [Queries.ts:194](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L194)*
|
||||
|
||||
**Returns:** `Observable`<`Array`<`AccountId`>>
|
||||
|
||||
@@ -925,7 +925,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominating](_queries_.apiqueries.md#stakingnominating)*
|
||||
|
||||
*Defined in [Queries.ts:216](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L216)*
|
||||
*Defined in [Queries.ts:216](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L216)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -944,7 +944,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominatorsFor](_queries_.apiqueries.md#stakingnominatorsfor)*
|
||||
|
||||
*Defined in [Queries.ts:205](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L205)*
|
||||
*Defined in [Queries.ts:205](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L205)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -963,7 +963,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCalls](_calls_.apicalls.md).[submitAndWatchExtrinsic](_calls_.apicalls.md#submitandwatchextrinsic)*
|
||||
|
||||
*Defined in [Calls.ts:63](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Calls.ts#L63)*
|
||||
*Defined in [Calls.ts:63](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Calls.ts#L63)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -982,7 +982,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCalls](_calls_.apicalls.md).[submitExtrinsic](_calls_.apicalls.md#submitextrinsic)*
|
||||
|
||||
*Defined in [Calls.ts:59](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Calls.ts#L59)*
|
||||
*Defined in [Calls.ts:59](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Calls.ts#L59)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -1001,7 +1001,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCalls](_calls_.apicalls.md).[subscribeNewHead](_calls_.apicalls.md#subscribenewhead)*
|
||||
|
||||
*Defined in [Calls.ts:45](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Calls.ts#L45)*
|
||||
*Defined in [Calls.ts:45](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Calls.ts#L45)*
|
||||
|
||||
**Returns:** `Observable`< `Header` | `undefined`>
|
||||
|
||||
@@ -1014,7 +1014,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[systemEvents](_queries_.apiqueries.md#systemevents)*
|
||||
|
||||
*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L220)*
|
||||
*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L220)*
|
||||
|
||||
**Returns:** `Observable`<`Array`<`EventRecord`>>
|
||||
|
||||
@@ -1027,7 +1027,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCalls](_calls_.apicalls.md).[systemName](_calls_.apicalls.md#systemname)*
|
||||
|
||||
*Defined in [Calls.ts:51](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Calls.ts#L51)*
|
||||
*Defined in [Calls.ts:51](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Calls.ts#L51)*
|
||||
|
||||
**Returns:** `Observable`< `Text` | `undefined`>
|
||||
|
||||
@@ -1040,7 +1040,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCalls](_calls_.apicalls.md).[systemVersion](_calls_.apicalls.md#systemversion)*
|
||||
|
||||
*Defined in [Calls.ts:55](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Calls.ts#L55)*
|
||||
*Defined in [Calls.ts:55](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Calls.ts#L55)*
|
||||
|
||||
**Returns:** `Observable`< `Text` | `undefined`>
|
||||
|
||||
@@ -1053,7 +1053,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCombined](_combined_.apicombined.md).[validatingBalance](_combined_.apicombined.md#validatingbalance)*
|
||||
|
||||
*Defined in [Combined.ts:346](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Combined.ts#L346)*
|
||||
*Defined in [Combined.ts:346](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Combined.ts#L346)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -1072,7 +1072,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCombined](_combined_.apicombined.md).[validatingBalances](_combined_.apicombined.md#validatingbalances)*
|
||||
|
||||
*Defined in [Combined.ts:371](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Combined.ts#L371)*
|
||||
*Defined in [Combined.ts:371](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Combined.ts#L371)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -1091,7 +1091,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[validatorCount](_queries_.apiqueries.md#validatorcount)*
|
||||
|
||||
*Defined in [Queries.ts:231](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L231)*
|
||||
*Defined in [Queries.ts:231](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L231)*
|
||||
|
||||
**Returns:** `Observable`< `u32` | `undefined`>
|
||||
|
||||
@@ -1104,7 +1104,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCombined](_combined_.apicombined.md).[votingBalance](_combined_.apicombined.md#votingbalance)*
|
||||
|
||||
*Defined in [Combined.ts:385](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Combined.ts#L385)*
|
||||
*Defined in [Combined.ts:385](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Combined.ts#L385)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -1123,7 +1123,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCombined](_combined_.apicombined.md).[votingBalances](_combined_.apicombined.md#votingbalances)*
|
||||
|
||||
*Defined in [Combined.ts:425](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Combined.ts#L425)*
|
||||
*Defined in [Combined.ts:425](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Combined.ts#L425)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -1142,7 +1142,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCombined](_combined_.apicombined.md).[votingBalancesNominatorsFor](_combined_.apicombined.md#votingbalancesnominatorsfor)*
|
||||
|
||||
*Defined in [Combined.ts:414](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Combined.ts#L414)*
|
||||
*Defined in [Combined.ts:414](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Combined.ts#L414)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
|
||||
|
||||
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Base.ts#L33)*
|
||||
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Base.ts#L33)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -40,7 +40,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[whenReady](_base_.apibase.md#whenready)*
|
||||
|
||||
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Base.ts#L33)*
|
||||
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Base.ts#L33)*
|
||||
|
||||
___
|
||||
<a id="extrinsics"></a>
|
||||
@@ -51,7 +51,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[extrinsics](_base_.apibase.md#extrinsics)*
|
||||
|
||||
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Base.ts#L41)*
|
||||
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Base.ts#L41)*
|
||||
|
||||
___
|
||||
<a id="storage"></a>
|
||||
@@ -62,7 +62,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[storage](_base_.apibase.md#storage)*
|
||||
|
||||
*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Base.ts#L42)*
|
||||
*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Base.ts#L42)*
|
||||
|
||||
___
|
||||
|
||||
@@ -76,7 +76,7 @@ getgenesisHash(): `Hash`
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)*
|
||||
|
||||
*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Base.ts#L87)*
|
||||
*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Base.ts#L87)*
|
||||
|
||||
**Returns:** `Hash`
|
||||
|
||||
@@ -90,7 +90,7 @@ ___
|
||||
|
||||
▸ **accountNonce**(address: * `AccountId` | `string`*): `Observable`< `Index` | `undefined`>
|
||||
|
||||
*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L19)*
|
||||
*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L19)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -107,7 +107,7 @@ ___
|
||||
|
||||
▸ **balanceFree**(address: * `AccountId` | `string`*): `Observable`< `Balance` | `undefined`>
|
||||
|
||||
*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L23)*
|
||||
*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L23)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -124,7 +124,7 @@ ___
|
||||
|
||||
▸ **balanceReserved**(address: * `AccountId` | `string`*): `Observable`< `Balance` | `undefined`>
|
||||
|
||||
*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L27)*
|
||||
*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L27)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -141,7 +141,7 @@ ___
|
||||
|
||||
▸ **blockNow**(): `Observable`< `Moment` | `undefined`>
|
||||
|
||||
*Defined in [Queries.ts:35](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L35)*
|
||||
*Defined in [Queries.ts:35](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L35)*
|
||||
|
||||
**Returns:** `Observable`< `Moment` | `undefined`>
|
||||
|
||||
@@ -152,7 +152,7 @@ ___
|
||||
|
||||
▸ **blockPeriod**(): `Observable`< `Moment` | `undefined`>
|
||||
|
||||
*Defined in [Queries.ts:31](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L31)*
|
||||
*Defined in [Queries.ts:31](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L31)*
|
||||
|
||||
**Returns:** `Observable`< `Moment` | `undefined`>
|
||||
|
||||
@@ -163,7 +163,7 @@ ___
|
||||
|
||||
▸ **democracyLaunchPeriod**(): `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
*Defined in [Queries.ts:39](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L39)*
|
||||
*Defined in [Queries.ts:39](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L39)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -174,7 +174,7 @@ ___
|
||||
|
||||
▸ **democracyNextTally**(): `Observable`< `ReferendumIndex` | `undefined`>
|
||||
|
||||
*Defined in [Queries.ts:43](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L43)*
|
||||
*Defined in [Queries.ts:43](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L43)*
|
||||
|
||||
**Returns:** `Observable`< `ReferendumIndex` | `undefined`>
|
||||
|
||||
@@ -185,7 +185,7 @@ ___
|
||||
|
||||
▸ **democracyVotingPeriod**(): `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
*Defined in [Queries.ts:126](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L126)*
|
||||
*Defined in [Queries.ts:126](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L126)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -196,7 +196,7 @@ ___
|
||||
|
||||
▸ **eraLastLengthChange**(): `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
*Defined in [Queries.ts:151](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L151)*
|
||||
*Defined in [Queries.ts:151](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L151)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -207,7 +207,7 @@ ___
|
||||
|
||||
▸ **fees**(): `Observable`<[RxFees](../modules/_types_.md#rxfees)>
|
||||
|
||||
*Defined in [Queries.ts:130](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L130)*
|
||||
*Defined in [Queries.ts:130](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L130)*
|
||||
|
||||
**Returns:** `Observable`<[RxFees](../modules/_types_.md#rxfees)>
|
||||
|
||||
@@ -218,7 +218,7 @@ ___
|
||||
|
||||
▸ **getAccountEnumSet**(index: * `AccountIndex` | `BN` | `number`*): `Observable`< `Array`<`AccountId`> | `undefined`>
|
||||
|
||||
*Defined in [Queries.ts:47](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L47)*
|
||||
*Defined in [Queries.ts:47](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L47)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -237,7 +237,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[isConnected](_base_.apibase.md#isconnected)*
|
||||
|
||||
*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Base.ts#L91)*
|
||||
*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Base.ts#L91)*
|
||||
|
||||
**Returns:** `Observable`<`boolean`>
|
||||
|
||||
@@ -248,7 +248,7 @@ ___
|
||||
|
||||
▸ **nextAccountEnumSet**(): `Observable`< `AccountIndex` | `undefined`>
|
||||
|
||||
*Defined in [Queries.ts:58](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L58)*
|
||||
*Defined in [Queries.ts:58](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L58)*
|
||||
|
||||
**Returns:** `Observable`< `AccountIndex` | `undefined`>
|
||||
|
||||
@@ -259,7 +259,7 @@ ___
|
||||
|
||||
▸ **proposalDeposits**(proposalId: * `PropIndex` | `BN` | `number`*): `Observable`< [RxProposalDeposits](_classes_.rxproposaldeposits.md) | `undefined`>
|
||||
|
||||
*Defined in [Queries.ts:62](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L62)*
|
||||
*Defined in [Queries.ts:62](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L62)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -276,7 +276,7 @@ ___
|
||||
|
||||
▸ **publicProposals**(): `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>>
|
||||
|
||||
*Defined in [Queries.ts:75](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L75)*
|
||||
*Defined in [Queries.ts:75](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L75)*
|
||||
|
||||
**Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>>
|
||||
|
||||
@@ -289,7 +289,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)*
|
||||
|
||||
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Base.ts#L95)*
|
||||
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Base.ts#L95)*
|
||||
|
||||
**Type parameters:**
|
||||
|
||||
@@ -312,7 +312,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)*
|
||||
|
||||
*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Base.ts#L108)*
|
||||
*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Base.ts#L108)*
|
||||
|
||||
**Type parameters:**
|
||||
|
||||
@@ -335,7 +335,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)*
|
||||
|
||||
*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Base.ts#L123)*
|
||||
*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Base.ts#L123)*
|
||||
|
||||
**Type parameters:**
|
||||
|
||||
@@ -355,7 +355,7 @@ ___
|
||||
|
||||
▸ **referendumCount**(): `Observable`< `ReferendumIndex` | `undefined`>
|
||||
|
||||
*Defined in [Queries.ts:94](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L94)*
|
||||
*Defined in [Queries.ts:94](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L94)*
|
||||
|
||||
**Returns:** `Observable`< `ReferendumIndex` | `undefined`>
|
||||
|
||||
@@ -366,7 +366,7 @@ ___
|
||||
|
||||
▸ **referendumInfo**(referendumId: * `ReferendumIndex` | `BN` | `number`*): `Observable`< [RxReferendum](_classes_.rxreferendum.md) | `undefined`>
|
||||
|
||||
*Defined in [Queries.ts:98](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L98)*
|
||||
*Defined in [Queries.ts:98](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L98)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -383,7 +383,7 @@ ___
|
||||
|
||||
▸ **referendumVote**(index: * `ReferendumIndex` | `BN` | `number`*, address: * `AccountId` | `string`*): `Observable`< `Bool` | `undefined`>
|
||||
|
||||
*Defined in [Queries.ts:111](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L111)*
|
||||
*Defined in [Queries.ts:111](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L111)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -401,7 +401,7 @@ ___
|
||||
|
||||
▸ **referendumVoters**(index: * `ReferendumIndex` | `BN` | `number`*): `Observable`<`Array`<`AccountId`>>
|
||||
|
||||
*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L115)*
|
||||
*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L115)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -418,7 +418,7 @@ ___
|
||||
|
||||
▸ **sessionCurrentIndex**(): `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
*Defined in [Queries.ts:163](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L163)*
|
||||
*Defined in [Queries.ts:163](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L163)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -429,7 +429,7 @@ ___
|
||||
|
||||
▸ **sessionCurrentStart**(): `Observable`< `Moment` | `undefined`>
|
||||
|
||||
*Defined in [Queries.ts:167](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L167)*
|
||||
*Defined in [Queries.ts:167](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L167)*
|
||||
|
||||
**Returns:** `Observable`< `Moment` | `undefined`>
|
||||
|
||||
@@ -440,7 +440,7 @@ ___
|
||||
|
||||
▸ **sessionLastLengthChange**(): `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L171)*
|
||||
*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L171)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -451,7 +451,7 @@ ___
|
||||
|
||||
▸ **sessionLength**(): `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L175)*
|
||||
*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L175)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -462,7 +462,7 @@ ___
|
||||
|
||||
▸ **sessionReward**(): `Observable`< `Perbill` | `undefined`>
|
||||
|
||||
*Defined in [Queries.ts:155](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L155)*
|
||||
*Defined in [Queries.ts:155](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L155)*
|
||||
|
||||
**Returns:** `Observable`< `Perbill` | `undefined`>
|
||||
|
||||
@@ -473,7 +473,7 @@ ___
|
||||
|
||||
▸ **sessionRewardCurrent**(): `Observable`< `Balance` | `undefined`>
|
||||
|
||||
*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L159)*
|
||||
*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L159)*
|
||||
|
||||
**Returns:** `Observable`< `Balance` | `undefined`>
|
||||
|
||||
@@ -484,7 +484,7 @@ ___
|
||||
|
||||
▸ **sessionValidators**(): `Observable`<`Array`<`AccountId`>>
|
||||
|
||||
*Defined in [Queries.ts:183](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L183)*
|
||||
*Defined in [Queries.ts:183](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L183)*
|
||||
|
||||
**Returns:** `Observable`<`Array`<`AccountId`>>
|
||||
|
||||
@@ -495,7 +495,7 @@ ___
|
||||
|
||||
▸ **sessionsPerEra**(): `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
*Defined in [Queries.ts:179](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L179)*
|
||||
*Defined in [Queries.ts:179](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L179)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -506,7 +506,7 @@ ___
|
||||
|
||||
▸ **stakingIntentions**(): `Observable`<`Array`<`AccountId`>>
|
||||
|
||||
*Defined in [Queries.ts:194](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L194)*
|
||||
*Defined in [Queries.ts:194](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L194)*
|
||||
|
||||
**Returns:** `Observable`<`Array`<`AccountId`>>
|
||||
|
||||
@@ -517,7 +517,7 @@ ___
|
||||
|
||||
▸ **stakingNominating**(address: * `AccountId` | `string`*): `Observable`< `AccountId` | `undefined`>
|
||||
|
||||
*Defined in [Queries.ts:216](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L216)*
|
||||
*Defined in [Queries.ts:216](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L216)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -534,7 +534,7 @@ ___
|
||||
|
||||
▸ **stakingNominatorsFor**(address: * `AccountId` | `string`*): `Observable`<`Array`<`AccountId`>>
|
||||
|
||||
*Defined in [Queries.ts:205](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L205)*
|
||||
*Defined in [Queries.ts:205](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L205)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -551,7 +551,7 @@ ___
|
||||
|
||||
▸ **systemEvents**(): `Observable`<`Array`<`EventRecord`>>
|
||||
|
||||
*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L220)*
|
||||
*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L220)*
|
||||
|
||||
**Returns:** `Observable`<`Array`<`EventRecord`>>
|
||||
|
||||
@@ -562,7 +562,7 @@ ___
|
||||
|
||||
▸ **validatorCount**(): `Observable`< `u32` | `undefined`>
|
||||
|
||||
*Defined in [Queries.ts:231](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/Queries.ts#L231)*
|
||||
*Defined in [Queries.ts:231](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/Queries.ts#L231)*
|
||||
|
||||
**Returns:** `Observable`< `u32` | `undefined`>
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@
|
||||
**Ƭ ApiFunctions**: * `keyof ApiBase` | `keyof ApiCalls` | `keyof ApiCombined` | `keyof ApiQueries`
|
||||
*
|
||||
|
||||
*Defined in [types.ts:12](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/types.ts#L12)*
|
||||
*Defined in [types.ts:12](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/types.ts#L12)*
|
||||
|
||||
___
|
||||
<a id="rxbalance"></a>
|
||||
@@ -18,7 +18,7 @@ ___
|
||||
|
||||
**Ƭ RxBalance**: *`object`*
|
||||
|
||||
*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/types.ts#L14)*
|
||||
*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/types.ts#L14)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
@@ -29,7 +29,7 @@ ___
|
||||
|
||||
**Ƭ RxBalanceMap**: *`object`*
|
||||
|
||||
*Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/types.ts#L38)*
|
||||
*Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/types.ts#L38)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
@@ -42,7 +42,7 @@ ___
|
||||
|
||||
**Ƭ RxFees**: *`object`*
|
||||
|
||||
*Defined in [types.ts:24](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/types.ts#L24)*
|
||||
*Defined in [types.ts:24](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/types.ts#L24)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
@@ -53,7 +53,7 @@ ___
|
||||
|
||||
**Ƭ RxReferendumVote**: *`object`*
|
||||
|
||||
*Defined in [types.ts:32](https://github.com/polkadot-js/api/blob/d11906e/packages/api-observable/src/types.ts#L32)*
|
||||
*Defined in [types.ts:32](https://github.com/polkadot-js/api/blob/5f1178f/packages/api-observable/src/types.ts#L32)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
|
||||
@@ -24,7 +24,7 @@
|
||||
|
||||
⊕ **new ApiBase**(provider?: * [ApiOptions](../interfaces/_types_.apioptions.md) | `ProviderInterface`*): [ApiBase](_base_.apibase.md)
|
||||
|
||||
*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/Base.ts#L40)*
|
||||
*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/Base.ts#L40)*
|
||||
|
||||
*__description__*: Create an instance of the class
|
||||
|
||||
@@ -58,7 +58,7 @@ ___
|
||||
|
||||
getgenesisHash(): `Hash`
|
||||
|
||||
*Defined in [Base.ts:79](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/Base.ts#L79)*
|
||||
*Defined in [Base.ts:79](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/Base.ts#L79)*
|
||||
|
||||
*__description__*: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions.
|
||||
|
||||
@@ -71,7 +71,7 @@ ___
|
||||
|
||||
gethasSubscriptions(): `boolean`
|
||||
|
||||
*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/Base.ts#L88)*
|
||||
*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/Base.ts#L88)*
|
||||
|
||||
*__description__*: `true` when subscriptions are supported
|
||||
|
||||
@@ -84,7 +84,7 @@ ___
|
||||
|
||||
getquery(): `S`
|
||||
|
||||
*Defined in [Base.ts:124](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/Base.ts#L124)*
|
||||
*Defined in [Base.ts:124](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/Base.ts#L124)*
|
||||
|
||||
*__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.
|
||||
|
||||
@@ -107,7 +107,7 @@ ___
|
||||
|
||||
getrpc(): `R`
|
||||
|
||||
*Defined in [Base.ts:144](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/Base.ts#L144)*
|
||||
*Defined in [Base.ts:144](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/Base.ts#L144)*
|
||||
|
||||
*__description__*: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic `api.query` and `api.tx` sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime.
|
||||
|
||||
@@ -130,7 +130,7 @@ ___
|
||||
|
||||
getruntimeMetadata(): `RuntimeMetadata`
|
||||
|
||||
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/Base.ts#L95)*
|
||||
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/Base.ts#L95)*
|
||||
|
||||
*__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.
|
||||
|
||||
@@ -143,7 +143,7 @@ ___
|
||||
|
||||
getruntimeVersion(): `RuntimeVersion`
|
||||
|
||||
*Defined in [Base.ts:104](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/Base.ts#L104)*
|
||||
*Defined in [Base.ts:104](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/Base.ts#L104)*
|
||||
|
||||
*__description__*: Contains the version information for the current runtime.
|
||||
|
||||
@@ -156,7 +156,7 @@ ___
|
||||
|
||||
gettx(): `E`
|
||||
|
||||
*Defined in [Base.ts:163](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/Base.ts#L163)*
|
||||
*Defined in [Base.ts:163](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/Base.ts#L163)*
|
||||
|
||||
*__description__*: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata.
|
||||
|
||||
@@ -183,7 +183,7 @@ ___
|
||||
|
||||
▸ **on**(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this`
|
||||
|
||||
*Defined in [Base.ts:188](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/Base.ts#L188)*
|
||||
*Defined in [Base.ts:188](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/Base.ts#L188)*
|
||||
|
||||
*__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:212](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/Base.ts#L212)*
|
||||
*Defined in [Base.ts:212](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/Base.ts#L212)*
|
||||
|
||||
*__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)>*, callback: *[CombinatorCallback](../modules/_promise_combinator_.md#combinatorcallback)*): [Combinator](_promise_combinator_.combinator.md)
|
||||
|
||||
*Defined in [promise/Combinator.ts:14](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/promise/Combinator.ts#L14)*
|
||||
*Defined in [promise/Combinator.ts:14](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/promise/Combinator.ts#L14)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -2036,7 +2036,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/d11906e/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/5f1178f/packages/api/src/promise/index.ts#L133" target="_blank">promise/index.ts:133</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>
|
||||
@@ -2071,7 +2071,7 @@
|
||||
<h2 id="genesishash">genesisHash</h2>
|
||||
<p>getgenesisHash(): <code>Hash</code></p>
|
||||
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#genesishash">genesisHash</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/Base.ts#L79" target="_blank">Base.ts:79</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/Base.ts#L79" target="_blank">Base.ts:79</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions.</p>
|
||||
<p><strong>Returns:</strong> <code>Hash</code></p>
|
||||
<hr>
|
||||
@@ -2079,14 +2079,14 @@
|
||||
<h2 id="hassubscriptions">hasSubscriptions</h2>
|
||||
<p>gethasSubscriptions(): <code>boolean</code></p>
|
||||
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#hassubscriptions">hasSubscriptions</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/Base.ts#L88" target="_blank">Base.ts:88</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/Base.ts#L88" target="_blank">Base.ts:88</a></em></p>
|
||||
<p><em><strong>description</strong></em>: <code>true</code> when subscriptions are supported</p>
|
||||
<p><strong>Returns:</strong> <code>boolean</code></p>
|
||||
<hr>
|
||||
<p><a id="isready"></a></p>
|
||||
<h2 id="isready">isReady</h2>
|
||||
<p>getisReady(): <code>Promise</code><<a href="_promise_index_.apipromise.html">ApiPromise</a>></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/promise/index.ts#L172" target="_blank">promise/index.ts:172</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/promise/index.ts#L172" target="_blank">promise/index.ts:172</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>
|
||||
@@ -2094,7 +2094,7 @@
|
||||
<h2 id="query">query</h2>
|
||||
<p>getquery(): <a href="../interfaces/_promise_types_.queryablestorage.md">QueryableStorage</a></p>
|
||||
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#query">query</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/Base.ts#L124" target="_blank">Base.ts:124</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/Base.ts#L124" target="_blank">Base.ts:124</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.</p>
|
||||
<p>All calls inside the namespace, is denoted by <code>section</code>.<code>method</code> and may take an optional query parameter. As an example, <code>api.query.timestamp.now()</code> (current block timestamp) does not take parameters, while <code>api.query.system.accountNonce(<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>
|
||||
@@ -2108,7 +2108,7 @@
|
||||
<h2 id="rpc">rpc</h2>
|
||||
<p>getrpc(): <code>Rpc</code></p>
|
||||
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#rpc">rpc</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/Base.ts#L144" target="_blank">Base.ts:144</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/Base.ts#L144" target="_blank">Base.ts:144</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic <code>api.query</code> and <code>api.tx</code> sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime.</p>
|
||||
<p>RPC endpoints available here allow for the query of chain, node and system information, in addition to providing interfaces for the raw queries of state (usine known keys) and the submission of transactions.</p>
|
||||
<p><em><strong>example</strong></em>: </p>
|
||||
@@ -2122,7 +2122,7 @@
|
||||
<h2 id="runtimemetadata">runtimeMetadata</h2>
|
||||
<p>getruntimeMetadata(): <code>RuntimeMetadata</code></p>
|
||||
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#runtimemetadata">runtimeMetadata</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/Base.ts#L95" target="_blank">Base.ts:95</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/Base.ts#L95" target="_blank">Base.ts:95</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.</p>
|
||||
<p><strong>Returns:</strong> <code>RuntimeMetadata</code></p>
|
||||
<hr>
|
||||
@@ -2130,7 +2130,7 @@
|
||||
<h2 id="runtimeversion">runtimeVersion</h2>
|
||||
<p>getruntimeVersion(): <code>RuntimeVersion</code></p>
|
||||
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#runtimeversion">runtimeVersion</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/Base.ts#L104" target="_blank">Base.ts:104</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/Base.ts#L104" target="_blank">Base.ts:104</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Contains the version information for the current runtime.</p>
|
||||
<p><strong>Returns:</strong> <code>RuntimeVersion</code></p>
|
||||
<hr>
|
||||
@@ -2138,7 +2138,7 @@
|
||||
<h2 id="tx">tx</h2>
|
||||
<p>gettx(): <a href="../interfaces/_promise_types_.submittableextrinsics.md">SubmittableExtrinsics</a></p>
|
||||
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#tx">tx</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/Base.ts#L163" target="_blank">Base.ts:163</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/Base.ts#L163" target="_blank">Base.ts:163</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata.</p>
|
||||
<p><em><strong>example</strong></em>: </p>
|
||||
<pre><code class="lang-javascript"><div class="sunlight-container sunlight-theme-gitbook"><div class="sunlight-code-container"><pre class="sunlight-highlight-javascript sunlight-highlighted"><span class="sunlight-javascript"><span class="sunlight-ident">api</span><span class="sunlight-operator">.</span><span class="sunlight-ident">tx</span><span class="sunlight-operator">.</span><span class="sunlight-ident">balances</span>
|
||||
@@ -2154,7 +2154,7 @@
|
||||
<p><a id="combinelatest"></a></p>
|
||||
<h2 id="combinelatest">combineLatest</h2>
|
||||
<p>▸ <strong>combineLatest</strong>(fns: <em><code>Array</code><<a href="../modules/_promise_combinator_.md#combinatorfunction">CombinatorFunction</a>></em>, callback: <em><a href="../modules/_promise_combinator_.md#combinatorcallback">CombinatorCallback</a></em>): <a href="_promise_combinator_.combinator.md">Combinator</a></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/promise/index.ts#L200" target="_blank">promise/index.ts:200</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/promise/index.ts#L200" target="_blank">promise/index.ts:200</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>
|
||||
@@ -2196,7 +2196,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/d11906e/packages/api/src/Base.ts#L188" target="_blank">Base.ts:188</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/Base.ts#L188" target="_blank">Base.ts:188</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Attach an eventemitter handler to listen to a specific event</p>
|
||||
<p><em><strong>example</strong></em>: </p>
|
||||
<pre><code class="lang-javascript"><div class="sunlight-container sunlight-theme-gitbook"><div class="sunlight-code-container"><pre class="sunlight-highlight-javascript sunlight-highlighted"><span class="sunlight-javascript"><span class="sunlight-ident">api</span><span class="sunlight-operator">.</span><span class="sunlight-ident">on</span><span class="sunlight-punctuation">(</span><span class="sunlight-string">'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>
|
||||
@@ -2235,7 +2235,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/d11906e/packages/api/src/Base.ts#L212" target="_blank">Base.ts:212</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/Base.ts#L212" target="_blank">Base.ts:212</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>
|
||||
@@ -2273,7 +2273,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/d11906e/packages/api/src/promise/index.ts#L131" target="_blank">promise/index.ts:131</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/promise/index.ts#L131" target="_blank">promise/index.ts:131</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>
|
||||
@@ -2348,7 +2348,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"ApiPromise","level":"1.2.1","depth":2,"next":{"title":"ApiRx","level":"1.2.2","depth":2,"path":"api/classes/_rx_index_.apirx.md","ref":"api/classes/_rx_index_.apirx.md","articles":[]},"previous":{"title":"api","level":"1.2","depth":1,"path":"api/README.md","ref":"api/README.md","articles":[{"title":"ApiPromise","level":"1.2.1","depth":2,"path":"api/classes/_promise_index_.apipromise.md","ref":"api/classes/_promise_index_.apipromise.md","articles":[]},{"title":"ApiRx","level":"1.2.2","depth":2,"path":"api/classes/_rx_index_.apirx.md","ref":"api/classes/_rx_index_.apirx.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"api/classes/_promise_index_.apipromise.md","mtime":"2018-12-17T11:42:55.706Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T11:44:28.801Z"},"basePath":"../..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"ApiPromise","level":"1.2.1","depth":2,"next":{"title":"ApiRx","level":"1.2.2","depth":2,"path":"api/classes/_rx_index_.apirx.md","ref":"api/classes/_rx_index_.apirx.md","articles":[]},"previous":{"title":"api","level":"1.2","depth":1,"path":"api/README.md","ref":"api/README.md","articles":[{"title":"ApiPromise","level":"1.2.1","depth":2,"path":"api/classes/_promise_index_.apipromise.md","ref":"api/classes/_promise_index_.apipromise.md","articles":[]},{"title":"ApiRx","level":"1.2.2","depth":2,"path":"api/classes/_rx_index_.apirx.md","ref":"api/classes/_rx_index_.apirx.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"api/classes/_promise_index_.apipromise.md","mtime":"2018-12-17T13:58:07.543Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T13:59:36.621Z"},"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:133](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/promise/index.ts#L133)*
|
||||
*Defined in [promise/index.ts:133](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/promise/index.ts#L133)*
|
||||
|
||||
*__description__*: Creates an instance of the ApiPromise class
|
||||
|
||||
@@ -142,7 +142,7 @@ getgenesisHash(): `Hash`
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)*
|
||||
|
||||
*Defined in [Base.ts:79](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/Base.ts#L79)*
|
||||
*Defined in [Base.ts:79](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/Base.ts#L79)*
|
||||
|
||||
*__description__*: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions.
|
||||
|
||||
@@ -157,7 +157,7 @@ gethasSubscriptions(): `boolean`
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[hasSubscriptions](_base_.apibase.md#hassubscriptions)*
|
||||
|
||||
*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/Base.ts#L88)*
|
||||
*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/Base.ts#L88)*
|
||||
|
||||
*__description__*: `true` when subscriptions are supported
|
||||
|
||||
@@ -170,7 +170,7 @@ ___
|
||||
|
||||
getisReady(): `Promise`<[ApiPromise](_promise_index_.apipromise.md)>
|
||||
|
||||
*Defined in [promise/index.ts:172](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/promise/index.ts#L172)*
|
||||
*Defined in [promise/index.ts:172](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/promise/index.ts#L172)*
|
||||
|
||||
*__description__*: Promise that returns the first time we are connected and loaded
|
||||
|
||||
@@ -185,7 +185,7 @@ getquery(): [QueryableStorage](../interfaces/_promise_types_.queryablestorage.md
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[query](_base_.apibase.md#query)*
|
||||
|
||||
*Defined in [Base.ts:124](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/Base.ts#L124)*
|
||||
*Defined in [Base.ts:124](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/Base.ts#L124)*
|
||||
|
||||
*__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.
|
||||
|
||||
@@ -210,7 +210,7 @@ getrpc(): `Rpc`
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[rpc](_base_.apibase.md#rpc)*
|
||||
|
||||
*Defined in [Base.ts:144](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/Base.ts#L144)*
|
||||
*Defined in [Base.ts:144](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/Base.ts#L144)*
|
||||
|
||||
*__description__*: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic `api.query` and `api.tx` sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime.
|
||||
|
||||
@@ -235,7 +235,7 @@ getruntimeMetadata(): `RuntimeMetadata`
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[runtimeMetadata](_base_.apibase.md#runtimemetadata)*
|
||||
|
||||
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/Base.ts#L95)*
|
||||
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/Base.ts#L95)*
|
||||
|
||||
*__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.
|
||||
|
||||
@@ -250,7 +250,7 @@ getruntimeVersion(): `RuntimeVersion`
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[runtimeVersion](_base_.apibase.md#runtimeversion)*
|
||||
|
||||
*Defined in [Base.ts:104](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/Base.ts#L104)*
|
||||
*Defined in [Base.ts:104](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/Base.ts#L104)*
|
||||
|
||||
*__description__*: Contains the version information for the current runtime.
|
||||
|
||||
@@ -265,7 +265,7 @@ gettx(): [SubmittableExtrinsics](../interfaces/_promise_types_.submittableextrin
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[tx](_base_.apibase.md#tx)*
|
||||
|
||||
*Defined in [Base.ts:163](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/Base.ts#L163)*
|
||||
*Defined in [Base.ts:163](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/Base.ts#L163)*
|
||||
|
||||
*__description__*: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata.
|
||||
|
||||
@@ -292,7 +292,7 @@ ___
|
||||
|
||||
▸ **combineLatest**(fns: *`Array`<[CombinatorFunction](../modules/_promise_combinator_.md#combinatorfunction)>*, callback: *[CombinatorCallback](../modules/_promise_combinator_.md#combinatorcallback)*): [Combinator](_promise_combinator_.combinator.md)
|
||||
|
||||
*Defined in [promise/index.ts:200](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/promise/index.ts#L200)*
|
||||
*Defined in [promise/index.ts:200](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/promise/index.ts#L200)*
|
||||
|
||||
*__description__*: Creates a combinator that can be used to combine the latest results from multiple subscriptions
|
||||
|
||||
@@ -329,7 +329,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[on](_base_.apibase.md#on)*
|
||||
|
||||
*Defined in [Base.ts:188](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/Base.ts#L188)*
|
||||
*Defined in [Base.ts:188](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/Base.ts#L188)*
|
||||
|
||||
*__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:212](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/Base.ts#L212)*
|
||||
*Defined in [Base.ts:212](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/Base.ts#L212)*
|
||||
|
||||
*__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:131](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/promise/index.ts#L131)*
|
||||
*Defined in [promise/index.ts:131](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/promise/index.ts#L131)*
|
||||
|
||||
*__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:12](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/promise/SubmittableExtrinsic.ts#L12)*
|
||||
*Defined in [promise/SubmittableExtrinsic.ts:12](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/promise/SubmittableExtrinsic.ts#L12)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -73,7 +73,7 @@ getType(): `E`
|
||||
|
||||
*Inherited from Struct.Type*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L141)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L141)*
|
||||
|
||||
*__description__*: Returns the Type description to sthe structure
|
||||
|
||||
@@ -88,7 +88,7 @@ getargs(): `Array`<`Codec`>
|
||||
|
||||
*Inherited from Extrinsic.args*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:69](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Extrinsic.ts#L69)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:69](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Extrinsic.ts#L69)*
|
||||
|
||||
*__description__*: The arguments passed to for the call, exposes args so it is compatible with \[\[Method\]\]
|
||||
|
||||
@@ -103,7 +103,7 @@ getcallIndex(): `Uint8Array`
|
||||
|
||||
*Inherited from Extrinsic.callIndex*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:76](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Extrinsic.ts#L76)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:76](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Extrinsic.ts#L76)*
|
||||
|
||||
*__description__*: The actual `[sectionIndex, methodIndex]` as used in the Method
|
||||
|
||||
@@ -118,7 +118,7 @@ getdata(): `Uint8Array`
|
||||
|
||||
*Inherited from Extrinsic.data*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:83](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Extrinsic.ts#L83)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:83](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Extrinsic.ts#L83)*
|
||||
|
||||
*__description__*: The actual data for the Method
|
||||
|
||||
@@ -135,7 +135,7 @@ getencodedLength(): `number`
|
||||
|
||||
*Overrides Struct.encodedLength*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:90](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Extrinsic.ts#L90)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:90](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Extrinsic.ts#L90)*
|
||||
|
||||
*__description__*: The length of the value when encoded as a Uint8Array
|
||||
|
||||
@@ -150,7 +150,7 @@ gethash(): `Hash`
|
||||
|
||||
*Inherited from Extrinsic.hash*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:99](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Extrinsic.ts#L99)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:99](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Extrinsic.ts#L99)*
|
||||
|
||||
*__description__*: Convernience function, encodes the extrinsic and returns the actual hash
|
||||
|
||||
@@ -165,7 +165,7 @@ getisSigned(): `boolean`
|
||||
|
||||
*Inherited from Extrinsic.isSigned*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:108](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Extrinsic.ts#L108)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:108](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Extrinsic.ts#L108)*
|
||||
|
||||
*__description__*: `true` id the extrinsic is signed
|
||||
|
||||
@@ -180,7 +180,7 @@ getlength(): `number`
|
||||
|
||||
*Inherited from Extrinsic.length*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:115](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Extrinsic.ts#L115)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:115](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Extrinsic.ts#L115)*
|
||||
|
||||
*__description__*: The length of the encoded value
|
||||
|
||||
@@ -195,7 +195,7 @@ getmeta(): `FunctionMetadata`
|
||||
|
||||
*Inherited from Extrinsic.meta*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:122](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Extrinsic.ts#L122)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:122](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Extrinsic.ts#L122)*
|
||||
|
||||
*__description__*: The \[\[FunctionMetadata\]\] that describes the extrinsic
|
||||
|
||||
@@ -210,7 +210,7 @@ getmethod(): `Method`
|
||||
|
||||
*Inherited from Extrinsic.method*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:129](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Extrinsic.ts#L129)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:129](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Extrinsic.ts#L129)*
|
||||
|
||||
*__description__*: The \[\[Method\]\] this extrinsic wraps
|
||||
|
||||
@@ -225,7 +225,7 @@ getsignature(): `ExtrinsicSignature`
|
||||
|
||||
*Inherited from Extrinsic.signature*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:136](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Extrinsic.ts#L136)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:136](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Extrinsic.ts#L136)*
|
||||
|
||||
*__description__*: The \[\[ExtrinsicSignature\]\]
|
||||
|
||||
@@ -258,7 +258,7 @@ ___
|
||||
|
||||
*Inherited from Extrinsic.addSignature*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:143](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Extrinsic.ts#L143)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:143](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Extrinsic.ts#L143)*
|
||||
|
||||
*__description__*: Add an \[\[ExtrinsicSignature\]\] to the extrinsic (already generated)
|
||||
|
||||
@@ -351,7 +351,7 @@ ___
|
||||
|
||||
*Overrides Map.get*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L158)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L158)*
|
||||
|
||||
*__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:165](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L165)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:165](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L165)*
|
||||
|
||||
*__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`>
|
||||
|
||||
*Defined in [promise/SubmittableExtrinsic.ts:20](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/promise/SubmittableExtrinsic.ts#L20)*
|
||||
*Defined in [promise/SubmittableExtrinsic.ts:20](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/promise/SubmittableExtrinsic.ts#L20)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -464,7 +464,7 @@ ___
|
||||
|
||||
*Overrides Extrinsic.sign*
|
||||
|
||||
*Defined in [promise/SubmittableExtrinsic.ts:28](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/promise/SubmittableExtrinsic.ts#L28)*
|
||||
*Defined in [promise/SubmittableExtrinsic.ts:28](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/promise/SubmittableExtrinsic.ts#L28)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -485,7 +485,7 @@ ___
|
||||
|
||||
*Inherited from Struct.toArray*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:172](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L172)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:172](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L172)*
|
||||
|
||||
*__description__*: Converts the Object to an standard JavaScript Array
|
||||
|
||||
@@ -502,7 +502,7 @@ ___
|
||||
|
||||
*Overrides Struct.toHex*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:161](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Extrinsic.ts#L161)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:161](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Extrinsic.ts#L161)*
|
||||
|
||||
*__description__*: Returns a hex string representation of the value
|
||||
|
||||
@@ -519,7 +519,7 @@ ___
|
||||
|
||||
*Overrides Struct.toJSON*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:168](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Extrinsic.ts#L168)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:168](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Extrinsic.ts#L168)*
|
||||
|
||||
*__description__*: Converts the Object to JSON, typically used for RPC transfers
|
||||
|
||||
@@ -534,7 +534,7 @@ ___
|
||||
|
||||
*Inherited from Struct.toString*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:200](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L200)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:200](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L200)*
|
||||
|
||||
*__description__*: Returns the string representation of the value
|
||||
|
||||
@@ -551,7 +551,7 @@ ___
|
||||
|
||||
*Overrides Struct.toU8a*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:176](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Extrinsic.ts#L176)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:176](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Extrinsic.ts#L176)*
|
||||
|
||||
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
|
||||
|
||||
@@ -587,7 +587,7 @@ ___
|
||||
|
||||
*Inherited from Extrinsic.decodeExtrinsic*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:44](https://github.com/polkadot-js/api/blob/d11906e/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/5f1178f/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:121](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L121)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:121](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L121)*
|
||||
|
||||
**Type parameters:**
|
||||
|
||||
|
||||
@@ -2047,7 +2047,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/d11906e/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/5f1178f/packages/api/src/rx/index.ts#L143" target="_blank">rx/index.ts:143</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Create an instance of the ApiRx class</p>
|
||||
<p><em><strong>example</strong></em>: </p>
|
||||
<pre><code class="lang-javascript"><div class="sunlight-container sunlight-theme-gitbook"><div class="sunlight-code-container"><pre class="sunlight-highlight-javascript sunlight-highlighted"><span class="sunlight-javascript"><span class="sunlight-reservedWord">import</span> <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>
|
||||
@@ -2082,7 +2082,7 @@
|
||||
<h2 id="genesishash">genesisHash</h2>
|
||||
<p>getgenesisHash(): <code>Hash</code></p>
|
||||
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#genesishash">genesisHash</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/Base.ts#L79" target="_blank">Base.ts:79</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/Base.ts#L79" target="_blank">Base.ts:79</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions.</p>
|
||||
<p><strong>Returns:</strong> <code>Hash</code></p>
|
||||
<hr>
|
||||
@@ -2090,21 +2090,21 @@
|
||||
<h2 id="hassubscriptions">hasSubscriptions</h2>
|
||||
<p>gethasSubscriptions(): <code>boolean</code></p>
|
||||
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#hassubscriptions">hasSubscriptions</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/Base.ts#L88" target="_blank">Base.ts:88</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/Base.ts#L88" target="_blank">Base.ts:88</a></em></p>
|
||||
<p><em><strong>description</strong></em>: <code>true</code> when subscriptions are supported</p>
|
||||
<p><strong>Returns:</strong> <code>boolean</code></p>
|
||||
<hr>
|
||||
<p><a id="isconnected"></a></p>
|
||||
<h2 id="isconnected">isConnected</h2>
|
||||
<p>getisConnected(): <code>Observable</code><<code>boolean</code>></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/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/5f1178f/packages/api/src/rx/index.ts#L181" target="_blank">rx/index.ts:181</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/d11906e/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/5f1178f/packages/api/src/rx/index.ts#L188" target="_blank">rx/index.ts:188</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>
|
||||
@@ -2112,7 +2112,7 @@
|
||||
<h2 id="query">query</h2>
|
||||
<p>getquery(): <a href="../interfaces/_rx_types_.queryablestorage.md">QueryableStorage</a></p>
|
||||
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#query">query</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/Base.ts#L124" target="_blank">Base.ts:124</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/Base.ts#L124" target="_blank">Base.ts:124</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.</p>
|
||||
<p>All calls inside the namespace, is denoted by <code>section</code>.<code>method</code> and may take an optional query parameter. As an example, <code>api.query.timestamp.now()</code> (current block timestamp) does not take parameters, while <code>api.query.system.accountNonce(<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>
|
||||
@@ -2126,7 +2126,7 @@
|
||||
<h2 id="rpc">rpc</h2>
|
||||
<p>getrpc(): <code>RpcRx</code></p>
|
||||
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#rpc">rpc</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/Base.ts#L144" target="_blank">Base.ts:144</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/Base.ts#L144" target="_blank">Base.ts:144</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic <code>api.query</code> and <code>api.tx</code> sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime.</p>
|
||||
<p>RPC endpoints available here allow for the query of chain, node and system information, in addition to providing interfaces for the raw queries of state (usine known keys) and the submission of transactions.</p>
|
||||
<p><em><strong>example</strong></em>: </p>
|
||||
@@ -2140,7 +2140,7 @@
|
||||
<h2 id="runtimemetadata">runtimeMetadata</h2>
|
||||
<p>getruntimeMetadata(): <code>RuntimeMetadata</code></p>
|
||||
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#runtimemetadata">runtimeMetadata</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/Base.ts#L95" target="_blank">Base.ts:95</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/Base.ts#L95" target="_blank">Base.ts:95</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.</p>
|
||||
<p><strong>Returns:</strong> <code>RuntimeMetadata</code></p>
|
||||
<hr>
|
||||
@@ -2148,7 +2148,7 @@
|
||||
<h2 id="runtimeversion">runtimeVersion</h2>
|
||||
<p>getruntimeVersion(): <code>RuntimeVersion</code></p>
|
||||
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#runtimeversion">runtimeVersion</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/Base.ts#L104" target="_blank">Base.ts:104</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/Base.ts#L104" target="_blank">Base.ts:104</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Contains the version information for the current runtime.</p>
|
||||
<p><strong>Returns:</strong> <code>RuntimeVersion</code></p>
|
||||
<hr>
|
||||
@@ -2156,7 +2156,7 @@
|
||||
<h2 id="tx">tx</h2>
|
||||
<p>gettx(): <a href="../interfaces/_rx_types_.submittableextrinsics.md">SubmittableExtrinsics</a></p>
|
||||
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#tx">tx</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/Base.ts#L163" target="_blank">Base.ts:163</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/Base.ts#L163" target="_blank">Base.ts:163</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata.</p>
|
||||
<p><em><strong>example</strong></em>: </p>
|
||||
<pre><code class="lang-javascript"><div class="sunlight-container sunlight-theme-gitbook"><div class="sunlight-code-container"><pre class="sunlight-highlight-javascript sunlight-highlighted"><span class="sunlight-javascript"><span class="sunlight-ident">api</span><span class="sunlight-operator">.</span><span class="sunlight-ident">tx</span><span class="sunlight-operator">.</span><span class="sunlight-ident">balances</span>
|
||||
@@ -2173,7 +2173,7 @@
|
||||
<h2 id="on">on</h2>
|
||||
<p>▸ <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/d11906e/packages/api/src/Base.ts#L188" target="_blank">Base.ts:188</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/Base.ts#L188" target="_blank">Base.ts:188</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Attach an eventemitter handler to listen to a specific event</p>
|
||||
<p><em><strong>example</strong></em>: </p>
|
||||
<pre><code class="lang-javascript"><div class="sunlight-container sunlight-theme-gitbook"><div class="sunlight-code-container"><pre class="sunlight-highlight-javascript sunlight-highlighted"><span class="sunlight-javascript"><span class="sunlight-ident">api</span><span class="sunlight-operator">.</span><span class="sunlight-ident">on</span><span class="sunlight-punctuation">(</span><span class="sunlight-string">'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>
|
||||
@@ -2212,7 +2212,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/d11906e/packages/api/src/Base.ts#L212" target="_blank">Base.ts:212</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/Base.ts#L212" target="_blank">Base.ts:212</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>
|
||||
@@ -2250,7 +2250,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/d11906e/packages/api/src/rx/index.ts#L141" target="_blank">rx/index.ts:141</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/rx/index.ts#L141" target="_blank">rx/index.ts:141</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Creates an ApiRx instance using the supplied provider. Returns an Observable containing the actual Api instance.</p>
|
||||
<p><em><strong>example</strong></em>: </p>
|
||||
<pre><code class="lang-javascript"><div class="sunlight-container sunlight-theme-gitbook"><div class="sunlight-code-container"><pre class="sunlight-highlight-javascript sunlight-highlighted"><span class="sunlight-javascript"><span class="sunlight-reservedWord">import</span> <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>
|
||||
@@ -2323,7 +2323,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"ApiRx","level":"1.2.2","depth":2,"next":{"title":"rpc-provider","level":"1.3","depth":1,"path":"rpc-provider/README.md","ref":"rpc-provider/README.md","articles":[{"title":"HttpProvider","level":"1.3.1","depth":2,"path":"rpc-provider/classes/_http_index_.httpprovider.md","ref":"rpc-provider/classes/_http_index_.httpprovider.md","articles":[]},{"title":"WsProvider","level":"1.3.2","depth":2,"path":"rpc-provider/classes/_ws_index_.wsprovider.md","ref":"rpc-provider/classes/_ws_index_.wsprovider.md","articles":[]}]},"previous":{"title":"ApiPromise","level":"1.2.1","depth":2,"path":"api/classes/_promise_index_.apipromise.md","ref":"api/classes/_promise_index_.apipromise.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"api/classes/_rx_index_.apirx.md","mtime":"2018-12-17T11:42:55.898Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T11:44:28.801Z"},"basePath":"../..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"ApiRx","level":"1.2.2","depth":2,"next":{"title":"rpc-provider","level":"1.3","depth":1,"path":"rpc-provider/README.md","ref":"rpc-provider/README.md","articles":[{"title":"HttpProvider","level":"1.3.1","depth":2,"path":"rpc-provider/classes/_http_index_.httpprovider.md","ref":"rpc-provider/classes/_http_index_.httpprovider.md","articles":[]},{"title":"WsProvider","level":"1.3.2","depth":2,"path":"rpc-provider/classes/_ws_index_.wsprovider.md","ref":"rpc-provider/classes/_ws_index_.wsprovider.md","articles":[]}]},"previous":{"title":"ApiPromise","level":"1.2.1","depth":2,"path":"api/classes/_promise_index_.apipromise.md","ref":"api/classes/_promise_index_.apipromise.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"api/classes/_rx_index_.apirx.md","mtime":"2018-12-17T13:58:07.727Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T13:59:36.621Z"},"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:143](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/rx/index.ts#L143)*
|
||||
*Defined in [rx/index.ts:143](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/rx/index.ts#L143)*
|
||||
|
||||
*__description__*: Create an instance of the ApiRx class
|
||||
|
||||
@@ -153,7 +153,7 @@ getgenesisHash(): `Hash`
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)*
|
||||
|
||||
*Defined in [Base.ts:79](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/Base.ts#L79)*
|
||||
*Defined in [Base.ts:79](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/Base.ts#L79)*
|
||||
|
||||
*__description__*: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions.
|
||||
|
||||
@@ -168,7 +168,7 @@ gethasSubscriptions(): `boolean`
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[hasSubscriptions](_base_.apibase.md#hassubscriptions)*
|
||||
|
||||
*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/Base.ts#L88)*
|
||||
*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/Base.ts#L88)*
|
||||
|
||||
*__description__*: `true` when subscriptions are supported
|
||||
|
||||
@@ -181,7 +181,7 @@ ___
|
||||
|
||||
getisConnected(): `Observable`<`boolean`>
|
||||
|
||||
*Defined in [rx/index.ts:181](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/rx/index.ts#L181)*
|
||||
*Defined in [rx/index.ts:181](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/rx/index.ts#L181)*
|
||||
|
||||
*__description__*: Observable that carries the connected state for the provider. Results in a boolean flag that is true/false based on the connectivity.
|
||||
|
||||
@@ -194,7 +194,7 @@ ___
|
||||
|
||||
getisReady(): `Observable`<[ApiRx](_rx_index_.apirx.md)>
|
||||
|
||||
*Defined in [rx/index.ts:188](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/rx/index.ts#L188)*
|
||||
*Defined in [rx/index.ts:188](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/rx/index.ts#L188)*
|
||||
|
||||
*__description__*: Observable that returns the first time we are connected and loaded
|
||||
|
||||
@@ -209,7 +209,7 @@ getquery(): [QueryableStorage](../interfaces/_rx_types_.queryablestorage.md)
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[query](_base_.apibase.md#query)*
|
||||
|
||||
*Defined in [Base.ts:124](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/Base.ts#L124)*
|
||||
*Defined in [Base.ts:124](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/Base.ts#L124)*
|
||||
|
||||
*__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.
|
||||
|
||||
@@ -234,7 +234,7 @@ getrpc(): `RpcRx`
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[rpc](_base_.apibase.md#rpc)*
|
||||
|
||||
*Defined in [Base.ts:144](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/Base.ts#L144)*
|
||||
*Defined in [Base.ts:144](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/Base.ts#L144)*
|
||||
|
||||
*__description__*: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic `api.query` and `api.tx` sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime.
|
||||
|
||||
@@ -259,7 +259,7 @@ getruntimeMetadata(): `RuntimeMetadata`
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[runtimeMetadata](_base_.apibase.md#runtimemetadata)*
|
||||
|
||||
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/Base.ts#L95)*
|
||||
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/Base.ts#L95)*
|
||||
|
||||
*__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.
|
||||
|
||||
@@ -274,7 +274,7 @@ getruntimeVersion(): `RuntimeVersion`
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[runtimeVersion](_base_.apibase.md#runtimeversion)*
|
||||
|
||||
*Defined in [Base.ts:104](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/Base.ts#L104)*
|
||||
*Defined in [Base.ts:104](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/Base.ts#L104)*
|
||||
|
||||
*__description__*: Contains the version information for the current runtime.
|
||||
|
||||
@@ -289,7 +289,7 @@ gettx(): [SubmittableExtrinsics](../interfaces/_rx_types_.submittableextrinsics.
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[tx](_base_.apibase.md#tx)*
|
||||
|
||||
*Defined in [Base.ts:163](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/Base.ts#L163)*
|
||||
*Defined in [Base.ts:163](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/Base.ts#L163)*
|
||||
|
||||
*__description__*: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata.
|
||||
|
||||
@@ -318,7 +318,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[on](_base_.apibase.md#on)*
|
||||
|
||||
*Defined in [Base.ts:188](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/Base.ts#L188)*
|
||||
*Defined in [Base.ts:188](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/Base.ts#L188)*
|
||||
|
||||
*__description__*: Attach an eventemitter handler to listen to a specific event
|
||||
|
||||
@@ -352,7 +352,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[once](_base_.apibase.md#once)*
|
||||
|
||||
*Defined in [Base.ts:212](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/Base.ts#L212)*
|
||||
*Defined in [Base.ts:212](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/Base.ts#L212)*
|
||||
|
||||
*__description__*: Attach an one-time eventemitter handler to listen to a specific event
|
||||
|
||||
@@ -384,7 +384,7 @@ ___
|
||||
|
||||
▸ **create**(options?: * [ApiOptions](../interfaces/_types_.apioptions.md) | `ProviderInterface`*): `Observable`<[ApiRx](_rx_index_.apirx.md)>
|
||||
|
||||
*Defined in [rx/index.ts:141](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/rx/index.ts#L141)*
|
||||
*Defined in [rx/index.ts:141](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/rx/index.ts#L141)*
|
||||
|
||||
*__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:13](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/rx/SubmittableExtrinsic.ts#L13)*
|
||||
*Defined in [rx/SubmittableExtrinsic.ts:13](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/rx/SubmittableExtrinsic.ts#L13)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -73,7 +73,7 @@ getType(): `E`
|
||||
|
||||
*Inherited from Struct.Type*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L141)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L141)*
|
||||
|
||||
*__description__*: Returns the Type description to sthe structure
|
||||
|
||||
@@ -88,7 +88,7 @@ getargs(): `Array`<`Codec`>
|
||||
|
||||
*Inherited from Extrinsic.args*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:69](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Extrinsic.ts#L69)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:69](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Extrinsic.ts#L69)*
|
||||
|
||||
*__description__*: The arguments passed to for the call, exposes args so it is compatible with \[\[Method\]\]
|
||||
|
||||
@@ -103,7 +103,7 @@ getcallIndex(): `Uint8Array`
|
||||
|
||||
*Inherited from Extrinsic.callIndex*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:76](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Extrinsic.ts#L76)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:76](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Extrinsic.ts#L76)*
|
||||
|
||||
*__description__*: The actual `[sectionIndex, methodIndex]` as used in the Method
|
||||
|
||||
@@ -118,7 +118,7 @@ getdata(): `Uint8Array`
|
||||
|
||||
*Inherited from Extrinsic.data*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:83](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Extrinsic.ts#L83)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:83](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Extrinsic.ts#L83)*
|
||||
|
||||
*__description__*: The actual data for the Method
|
||||
|
||||
@@ -135,7 +135,7 @@ getencodedLength(): `number`
|
||||
|
||||
*Overrides Struct.encodedLength*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:90](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Extrinsic.ts#L90)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:90](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Extrinsic.ts#L90)*
|
||||
|
||||
*__description__*: The length of the value when encoded as a Uint8Array
|
||||
|
||||
@@ -150,7 +150,7 @@ gethash(): `Hash`
|
||||
|
||||
*Inherited from Extrinsic.hash*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:99](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Extrinsic.ts#L99)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:99](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Extrinsic.ts#L99)*
|
||||
|
||||
*__description__*: Convernience function, encodes the extrinsic and returns the actual hash
|
||||
|
||||
@@ -165,7 +165,7 @@ getisSigned(): `boolean`
|
||||
|
||||
*Inherited from Extrinsic.isSigned*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:108](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Extrinsic.ts#L108)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:108](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Extrinsic.ts#L108)*
|
||||
|
||||
*__description__*: `true` id the extrinsic is signed
|
||||
|
||||
@@ -180,7 +180,7 @@ getlength(): `number`
|
||||
|
||||
*Inherited from Extrinsic.length*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:115](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Extrinsic.ts#L115)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:115](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Extrinsic.ts#L115)*
|
||||
|
||||
*__description__*: The length of the encoded value
|
||||
|
||||
@@ -195,7 +195,7 @@ getmeta(): `FunctionMetadata`
|
||||
|
||||
*Inherited from Extrinsic.meta*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:122](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Extrinsic.ts#L122)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:122](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Extrinsic.ts#L122)*
|
||||
|
||||
*__description__*: The \[\[FunctionMetadata\]\] that describes the extrinsic
|
||||
|
||||
@@ -210,7 +210,7 @@ getmethod(): `Method`
|
||||
|
||||
*Inherited from Extrinsic.method*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:129](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Extrinsic.ts#L129)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:129](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Extrinsic.ts#L129)*
|
||||
|
||||
*__description__*: The \[\[Method\]\] this extrinsic wraps
|
||||
|
||||
@@ -225,7 +225,7 @@ getsignature(): `ExtrinsicSignature`
|
||||
|
||||
*Inherited from Extrinsic.signature*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:136](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Extrinsic.ts#L136)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:136](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Extrinsic.ts#L136)*
|
||||
|
||||
*__description__*: The \[\[ExtrinsicSignature\]\]
|
||||
|
||||
@@ -258,7 +258,7 @@ ___
|
||||
|
||||
*Inherited from Extrinsic.addSignature*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:143](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Extrinsic.ts#L143)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:143](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Extrinsic.ts#L143)*
|
||||
|
||||
*__description__*: Add an \[\[ExtrinsicSignature\]\] to the extrinsic (already generated)
|
||||
|
||||
@@ -351,7 +351,7 @@ ___
|
||||
|
||||
*Overrides Map.get*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L158)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L158)*
|
||||
|
||||
*__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:165](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L165)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:165](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L165)*
|
||||
|
||||
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
|
||||
|
||||
@@ -425,7 +425,7 @@ ___
|
||||
|
||||
▸ **send**(): `Observable`<`ExtrinsicStatus`>
|
||||
|
||||
*Defined in [rx/SubmittableExtrinsic.ts:21](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/rx/SubmittableExtrinsic.ts#L21)*
|
||||
*Defined in [rx/SubmittableExtrinsic.ts:21](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/rx/SubmittableExtrinsic.ts#L21)*
|
||||
|
||||
**Returns:** `Observable`<`ExtrinsicStatus`>
|
||||
|
||||
@@ -458,7 +458,7 @@ ___
|
||||
|
||||
*Overrides Extrinsic.sign*
|
||||
|
||||
*Defined in [rx/SubmittableExtrinsic.ts:25](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/rx/SubmittableExtrinsic.ts#L25)*
|
||||
*Defined in [rx/SubmittableExtrinsic.ts:25](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/rx/SubmittableExtrinsic.ts#L25)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -479,7 +479,7 @@ ___
|
||||
|
||||
*Inherited from Struct.toArray*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:172](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L172)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:172](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L172)*
|
||||
|
||||
*__description__*: Converts the Object to an standard JavaScript Array
|
||||
|
||||
@@ -496,7 +496,7 @@ ___
|
||||
|
||||
*Overrides Struct.toHex*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:161](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Extrinsic.ts#L161)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:161](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Extrinsic.ts#L161)*
|
||||
|
||||
*__description__*: Returns a hex string representation of the value
|
||||
|
||||
@@ -513,7 +513,7 @@ ___
|
||||
|
||||
*Overrides Struct.toJSON*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:168](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Extrinsic.ts#L168)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:168](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Extrinsic.ts#L168)*
|
||||
|
||||
*__description__*: Converts the Object to JSON, typically used for RPC transfers
|
||||
|
||||
@@ -528,7 +528,7 @@ ___
|
||||
|
||||
*Inherited from Struct.toString*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:200](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L200)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:200](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L200)*
|
||||
|
||||
*__description__*: Returns the string representation of the value
|
||||
|
||||
@@ -545,7 +545,7 @@ ___
|
||||
|
||||
*Overrides Struct.toU8a*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:176](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Extrinsic.ts#L176)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:176](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Extrinsic.ts#L176)*
|
||||
|
||||
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
|
||||
|
||||
@@ -581,7 +581,7 @@ ___
|
||||
|
||||
*Inherited from Extrinsic.decodeExtrinsic*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:44](https://github.com/polkadot-js/api/blob/d11906e/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/5f1178f/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:121](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L121)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:121](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L121)*
|
||||
|
||||
**Type parameters:**
|
||||
|
||||
|
||||
+1
-1
@@ -2062,7 +2062,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"api","level":"1.2","depth":1,"next":{"title":"ApiPromise","level":"1.2.1","depth":2,"path":"api/classes/_promise_index_.apipromise.md","ref":"api/classes/_promise_index_.apipromise.md","articles":[]},"previous":{"title":"Introduction","level":"1.1","depth":1,"path":"README.md","ref":"README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"api/README.md","mtime":"2018-12-17T11:42:55.267Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T11:44:28.801Z"},"basePath":"..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"api","level":"1.2","depth":1,"next":{"title":"ApiPromise","level":"1.2.1","depth":2,"path":"api/classes/_promise_index_.apipromise.md","ref":"api/classes/_promise_index_.apipromise.md","articles":[]},"previous":{"title":"Introduction","level":"1.1","depth":1,"path":"README.md","ref":"README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"api/README.md","mtime":"2018-12-17T13:58:07.103Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T13:59:36.621Z"},"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/d11906e/packages/api/src/types.ts#L13)*
|
||||
*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/api/src/types.ts#L14)*
|
||||
*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/5f1178f/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:41](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/promise/types.ts#L41)*
|
||||
*Defined in [promise/types.ts:41](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/promise/types.ts#L41)*
|
||||
|
||||
___
|
||||
<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/d11906e/packages/api/src/types.ts#L21)*
|
||||
*Defined in [types.ts:21](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/types.ts#L21)*
|
||||
|
||||
#### Type declaration
|
||||
▸(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `void`
|
||||
@@ -74,7 +74,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[query](_types_.apibaseinterface.md#query)*
|
||||
|
||||
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/types.ts#L17)*
|
||||
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/types.ts#L17)*
|
||||
|
||||
___
|
||||
<a id="rpc"></a>
|
||||
@@ -85,7 +85,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[rpc](_types_.apibaseinterface.md#rpc)*
|
||||
|
||||
*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/types.ts#L18)*
|
||||
*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/types.ts#L18)*
|
||||
|
||||
___
|
||||
<a id="runtimemetadata"></a>
|
||||
@@ -96,7 +96,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[runtimeMetadata](_types_.apibaseinterface.md#runtimemetadata)*
|
||||
|
||||
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/types.ts#L15)*
|
||||
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/types.ts#L15)*
|
||||
|
||||
___
|
||||
<a id="runtimeversion"></a>
|
||||
@@ -107,7 +107,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[runtimeVersion](_types_.apibaseinterface.md#runtimeversion)*
|
||||
|
||||
*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/types.ts#L16)*
|
||||
*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/types.ts#L16)*
|
||||
|
||||
___
|
||||
<a id="tx"></a>
|
||||
@@ -118,7 +118,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[tx](_types_.apibaseinterface.md#tx)*
|
||||
|
||||
*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/types.ts#L19)*
|
||||
*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/types.ts#L19)*
|
||||
|
||||
___
|
||||
|
||||
|
||||
@@ -11,7 +11,7 @@
|
||||
|
||||
▸ **__call**(arg?: *`any`*): `Uint8Array`
|
||||
|
||||
*Defined in [promise/types.ts:15](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/promise/types.ts#L15)*
|
||||
*Defined in [promise/types.ts:15](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/promise/types.ts#L15)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -21,7 +21,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/d11906e/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/5f1178f/packages/types/src/StorageKey.ts#L12)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -39,7 +39,7 @@
|
||||
|
||||
**● at**: *`function`*
|
||||
|
||||
*Defined in [promise/types.ts:17](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/promise/types.ts#L17)*
|
||||
*Defined in [promise/types.ts:17](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/promise/types.ts#L17)*
|
||||
|
||||
#### Type declaration
|
||||
▸(hash: *`Hash`*, arg?: *`any`*): `Promise`< `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/d11906e/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/5f1178f/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/d11906e/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/5f1178f/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/d11906e/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/5f1178f/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/d11906e/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/5f1178f/packages/types/src/StorageKey.ts#L17)*
|
||||
|
||||
#### Type declaration
|
||||
▸(): `any`
|
||||
|
||||
@@ -11,7 +11,7 @@
|
||||
|
||||
▸ **__call**(...args: *`any`[]*): `Extrinsic`
|
||||
|
||||
*Defined in [promise/types.ts:28](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/promise/types.ts#L28)*
|
||||
*Defined in [promise/types.ts:28](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/promise/types.ts#L28)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -21,7 +21,7 @@
|
||||
|
||||
**Returns:** [SubmittableExtrinsic](../classes/_promise_submittableextrinsic_.submittableextrinsic.md)
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:34](https://github.com/polkadot-js/api/blob/d11906e/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/5f1178f/packages/types/src/Method.ts#L34)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -41,7 +41,7 @@
|
||||
|
||||
*Inherited from ExtrinsicFunction.callIndex*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:36](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Method.ts#L36)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:36](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Method.ts#L36)*
|
||||
|
||||
___
|
||||
<a id="meta"></a>
|
||||
@@ -52,7 +52,7 @@ ___
|
||||
|
||||
*Inherited from ExtrinsicFunction.meta*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:37](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Method.ts#L37)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:37](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Method.ts#L37)*
|
||||
|
||||
___
|
||||
<a id="method"></a>
|
||||
@@ -63,7 +63,7 @@ ___
|
||||
|
||||
*Inherited from ExtrinsicFunction.method*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:38](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Method.ts#L38)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:38](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Method.ts#L38)*
|
||||
|
||||
___
|
||||
<a id="section"></a>
|
||||
@@ -74,7 +74,7 @@ ___
|
||||
|
||||
*Inherited from ExtrinsicFunction.section*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:39](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Method.ts#L39)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:39](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Method.ts#L39)*
|
||||
|
||||
___
|
||||
<a id="tojson"></a>
|
||||
@@ -85,7 +85,7 @@ ___
|
||||
|
||||
*Inherited from ExtrinsicFunction.toJSON*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:40](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Method.ts#L40)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:40](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Method.ts#L40)*
|
||||
|
||||
#### 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/d11906e/packages/api/src/types.ts#L13)*
|
||||
*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/api/src/types.ts#L14)*
|
||||
*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/api/src/rx/types.ts#L42)*
|
||||
*Defined in [rx/types.ts:42](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/api/src/rx/types.ts#L43)*
|
||||
*Defined in [rx/types.ts:43](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/api/src/types.ts#L21)*
|
||||
*Defined in [types.ts:21](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/types.ts#L21)*
|
||||
|
||||
#### Type declaration
|
||||
▸(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `void`
|
||||
@@ -83,7 +83,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[query](_types_.apibaseinterface.md#query)*
|
||||
|
||||
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/types.ts#L17)*
|
||||
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/types.ts#L17)*
|
||||
|
||||
___
|
||||
<a id="rpc"></a>
|
||||
@@ -94,7 +94,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[rpc](_types_.apibaseinterface.md#rpc)*
|
||||
|
||||
*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/types.ts#L18)*
|
||||
*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/types.ts#L18)*
|
||||
|
||||
___
|
||||
<a id="runtimemetadata"></a>
|
||||
@@ -105,7 +105,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[runtimeMetadata](_types_.apibaseinterface.md#runtimemetadata)*
|
||||
|
||||
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/types.ts#L15)*
|
||||
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/types.ts#L15)*
|
||||
|
||||
___
|
||||
<a id="runtimeversion"></a>
|
||||
@@ -116,7 +116,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[runtimeVersion](_types_.apibaseinterface.md#runtimeversion)*
|
||||
|
||||
*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/types.ts#L16)*
|
||||
*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/types.ts#L16)*
|
||||
|
||||
___
|
||||
<a id="tx"></a>
|
||||
@@ -127,7 +127,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[tx](_types_.apibaseinterface.md#tx)*
|
||||
|
||||
*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/types.ts#L19)*
|
||||
*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/api/src/rx/types.ts#L16)*
|
||||
*Defined in [rx/types.ts:16](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/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/5f1178f/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/d11906e/packages/api/src/rx/types.ts#L18)*
|
||||
*Defined in [rx/types.ts:18](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/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/5f1178f/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/d11906e/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/5f1178f/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/d11906e/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/5f1178f/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/d11906e/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/5f1178f/packages/types/src/StorageKey.ts#L17)*
|
||||
|
||||
#### Type declaration
|
||||
▸(): `any`
|
||||
|
||||
@@ -11,7 +11,7 @@
|
||||
|
||||
▸ **__call**(...args: *`any`[]*): `Extrinsic`
|
||||
|
||||
*Defined in [rx/types.ts:29](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/rx/types.ts#L29)*
|
||||
*Defined in [rx/types.ts:29](https://github.com/polkadot-js/api/blob/5f1178f/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:34](https://github.com/polkadot-js/api/blob/d11906e/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/5f1178f/packages/types/src/Method.ts#L34)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -41,7 +41,7 @@
|
||||
|
||||
*Inherited from ExtrinsicFunction.callIndex*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:36](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Method.ts#L36)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:36](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Method.ts#L36)*
|
||||
|
||||
___
|
||||
<a id="meta"></a>
|
||||
@@ -52,7 +52,7 @@ ___
|
||||
|
||||
*Inherited from ExtrinsicFunction.meta*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:37](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Method.ts#L37)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:37](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Method.ts#L37)*
|
||||
|
||||
___
|
||||
<a id="method"></a>
|
||||
@@ -63,7 +63,7 @@ ___
|
||||
|
||||
*Inherited from ExtrinsicFunction.method*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:38](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Method.ts#L38)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:38](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Method.ts#L38)*
|
||||
|
||||
___
|
||||
<a id="section"></a>
|
||||
@@ -74,7 +74,7 @@ ___
|
||||
|
||||
*Inherited from ExtrinsicFunction.section*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:39](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Method.ts#L39)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:39](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Method.ts#L39)*
|
||||
|
||||
___
|
||||
<a id="tojson"></a>
|
||||
@@ -85,7 +85,7 @@ ___
|
||||
|
||||
*Inherited from ExtrinsicFunction.toJSON*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:40](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Method.ts#L40)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:40](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Method.ts#L40)*
|
||||
|
||||
#### Type declaration
|
||||
▸(): `any`
|
||||
|
||||
@@ -26,7 +26,7 @@
|
||||
|
||||
**● genesisHash**: *`Hash`*
|
||||
|
||||
*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/types.ts#L13)*
|
||||
*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/api/src/types.ts#L14)*
|
||||
*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/api/src/types.ts#L21)*
|
||||
*Defined in [types.ts:21](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/types.ts#L21)*
|
||||
|
||||
#### Type declaration
|
||||
▸(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `void`
|
||||
@@ -65,7 +65,7 @@ ___
|
||||
|
||||
**● query**: *`S`*
|
||||
|
||||
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/types.ts#L17)*
|
||||
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/types.ts#L17)*
|
||||
|
||||
___
|
||||
<a id="rpc"></a>
|
||||
@@ -74,7 +74,7 @@ ___
|
||||
|
||||
**● rpc**: *`R`*
|
||||
|
||||
*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/types.ts#L18)*
|
||||
*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/types.ts#L18)*
|
||||
|
||||
___
|
||||
<a id="runtimemetadata"></a>
|
||||
@@ -83,7 +83,7 @@ ___
|
||||
|
||||
**● runtimeMetadata**: *`Metadata`*
|
||||
|
||||
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/types.ts#L15)*
|
||||
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/types.ts#L15)*
|
||||
|
||||
___
|
||||
<a id="runtimeversion"></a>
|
||||
@@ -92,7 +92,7 @@ ___
|
||||
|
||||
**● runtimeVersion**: *`RuntimeVersion`*
|
||||
|
||||
*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/types.ts#L16)*
|
||||
*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/types.ts#L16)*
|
||||
|
||||
___
|
||||
<a id="tx"></a>
|
||||
@@ -101,7 +101,7 @@ ___
|
||||
|
||||
**● tx**: *`E`*
|
||||
|
||||
*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/types.ts#L19)*
|
||||
*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/types.ts#L19)*
|
||||
|
||||
___
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@
|
||||
|
||||
**● provider**: *`ProviderInterface`*
|
||||
|
||||
*Defined in [types.ts:29](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/types.ts#L29)*
|
||||
*Defined in [types.ts:29](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/types.ts#L29)*
|
||||
|
||||
*__description__*: Transport Provider from rpc-provider. If not specified, it will default to connecting to a WsProvider connecting localhost with the default port, i.e. `ws://127.0.0.1:9944`
|
||||
|
||||
@@ -24,7 +24,7 @@ ___
|
||||
**● types**: * `undefined` | `object`
|
||||
*
|
||||
|
||||
*Defined in [types.ts:34](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/types.ts#L34)*
|
||||
*Defined in [types.ts:34](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/types.ts#L34)*
|
||||
|
||||
*__description__*: Additional types used by runtime modules. This is nessusary if the runtime modules uses types not available in the base Substrate runtime.
|
||||
|
||||
|
||||
@@ -21,7 +21,7 @@
|
||||
|
||||
**Ƭ CombinatorCallback**: *`function`*
|
||||
|
||||
*Defined in [promise/Combinator.ts:7](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/promise/Combinator.ts#L7)*
|
||||
*Defined in [promise/Combinator.ts:7](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/promise/Combinator.ts#L7)*
|
||||
|
||||
#### Type declaration
|
||||
▸(value: *`Array`<`any`>*): `any`
|
||||
@@ -41,7 +41,7 @@ ___
|
||||
|
||||
**Ƭ CombinatorFunction**: *`function`*
|
||||
|
||||
*Defined in [promise/Combinator.ts:8](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/promise/Combinator.ts#L8)*
|
||||
*Defined in [promise/Combinator.ts:8](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/promise/Combinator.ts#L8)*
|
||||
|
||||
#### Type declaration
|
||||
▸(cb: *`function`*): `any`
|
||||
|
||||
@@ -22,7 +22,7 @@
|
||||
**Ƭ ApiInterface$Events**: * `RpcRxInterface$Events` | "ready"
|
||||
*
|
||||
|
||||
*Defined in [types.ts:10](https://github.com/polkadot-js/api/blob/d11906e/packages/api/src/types.ts#L10)*
|
||||
*Defined in [types.ts:10](https://github.com/polkadot-js/api/blob/5f1178f/packages/api/src/types.ts#L10)*
|
||||
|
||||
___
|
||||
|
||||
|
||||
@@ -2028,7 +2028,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"Simple connect","level":"3.1.1","depth":2,"next":{"title":"Listen to blocks","level":"3.1.2","depth":2,"path":"examples/promise/02_listen_to_blocks/README.md","ref":"examples/promise/02_listen_to_blocks/README.md","articles":[]},"previous":{"title":"ApiPromise","level":"3.1","depth":1,"path":"examples/promise/README.md","ref":"examples/promise/README.md","articles":[{"title":"Simple connect","level":"3.1.1","depth":2,"path":"examples/promise/01_simple_connect/README.md","ref":"examples/promise/01_simple_connect/README.md","articles":[]},{"title":"Listen to blocks","level":"3.1.2","depth":2,"path":"examples/promise/02_listen_to_blocks/README.md","ref":"examples/promise/02_listen_to_blocks/README.md","articles":[]},{"title":"Listen to balance change","level":"3.1.3","depth":2,"path":"examples/promise/03_listen_to_balance_change/README.md","ref":"examples/promise/03_listen_to_balance_change/README.md","articles":[]},{"title":"Read chain state","level":"3.1.4","depth":2,"path":"examples/promise/05_read_storage/README.md","ref":"examples/promise/05_read_storage/README.md","articles":[]},{"title":"Make a transfer","level":"3.1.5","depth":2,"path":"examples/promise/07_transfer_dots/README.md","ref":"examples/promise/07_transfer_dots/README.md","articles":[]},{"title":"Display system events","level":"3.1.6","depth":2,"path":"examples/promise/08_system_events/README.md","ref":"examples/promise/08_system_events/README.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/01_simple_connect/README.md","mtime":"2018-12-17T11:40:36.810Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T11:44:28.801Z"},"basePath":"../../..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"Simple connect","level":"3.1.1","depth":2,"next":{"title":"Listen to blocks","level":"3.1.2","depth":2,"path":"examples/promise/02_listen_to_blocks/README.md","ref":"examples/promise/02_listen_to_blocks/README.md","articles":[]},"previous":{"title":"ApiPromise","level":"3.1","depth":1,"path":"examples/promise/README.md","ref":"examples/promise/README.md","articles":[{"title":"Simple connect","level":"3.1.1","depth":2,"path":"examples/promise/01_simple_connect/README.md","ref":"examples/promise/01_simple_connect/README.md","articles":[]},{"title":"Listen to blocks","level":"3.1.2","depth":2,"path":"examples/promise/02_listen_to_blocks/README.md","ref":"examples/promise/02_listen_to_blocks/README.md","articles":[]},{"title":"Listen to balance change","level":"3.1.3","depth":2,"path":"examples/promise/03_listen_to_balance_change/README.md","ref":"examples/promise/03_listen_to_balance_change/README.md","articles":[]},{"title":"Read chain state","level":"3.1.4","depth":2,"path":"examples/promise/05_read_storage/README.md","ref":"examples/promise/05_read_storage/README.md","articles":[]},{"title":"Make a transfer","level":"3.1.5","depth":2,"path":"examples/promise/07_transfer_dots/README.md","ref":"examples/promise/07_transfer_dots/README.md","articles":[]},{"title":"Display system events","level":"3.1.6","depth":2,"path":"examples/promise/08_system_events/README.md","ref":"examples/promise/08_system_events/README.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/01_simple_connect/README.md","mtime":"2018-12-17T13:55:52.030Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T13:59:36.621Z"},"basePath":"../../..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -2030,7 +2030,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"Listen to blocks","level":"3.1.2","depth":2,"next":{"title":"Listen to balance change","level":"3.1.3","depth":2,"path":"examples/promise/03_listen_to_balance_change/README.md","ref":"examples/promise/03_listen_to_balance_change/README.md","articles":[]},"previous":{"title":"Simple connect","level":"3.1.1","depth":2,"path":"examples/promise/01_simple_connect/README.md","ref":"examples/promise/01_simple_connect/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/02_listen_to_blocks/README.md","mtime":"2018-12-17T11:40:36.810Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T11:44:28.801Z"},"basePath":"../../..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"Listen to blocks","level":"3.1.2","depth":2,"next":{"title":"Listen to balance change","level":"3.1.3","depth":2,"path":"examples/promise/03_listen_to_balance_change/README.md","ref":"examples/promise/03_listen_to_balance_change/README.md","articles":[]},"previous":{"title":"Simple connect","level":"3.1.1","depth":2,"path":"examples/promise/01_simple_connect/README.md","ref":"examples/promise/01_simple_connect/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/02_listen_to_blocks/README.md","mtime":"2018-12-17T13:55:52.030Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T13:59:36.621Z"},"basePath":"../../..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -2041,7 +2041,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"Listen to balance change","level":"3.1.3","depth":2,"next":{"title":"Read chain state","level":"3.1.4","depth":2,"path":"examples/promise/05_read_storage/README.md","ref":"examples/promise/05_read_storage/README.md","articles":[]},"previous":{"title":"Listen to blocks","level":"3.1.2","depth":2,"path":"examples/promise/02_listen_to_blocks/README.md","ref":"examples/promise/02_listen_to_blocks/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/03_listen_to_balance_change/README.md","mtime":"2018-12-17T11:40:36.810Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T11:44:28.801Z"},"basePath":"../../..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"Listen to balance change","level":"3.1.3","depth":2,"next":{"title":"Read chain state","level":"3.1.4","depth":2,"path":"examples/promise/05_read_storage/README.md","ref":"examples/promise/05_read_storage/README.md","articles":[]},"previous":{"title":"Listen to blocks","level":"3.1.2","depth":2,"path":"examples/promise/02_listen_to_blocks/README.md","ref":"examples/promise/02_listen_to_blocks/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/03_listen_to_balance_change/README.md","mtime":"2018-12-17T13:55:52.030Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T13:59:36.621Z"},"basePath":"../../..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -2040,7 +2040,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"Read chain state","level":"3.1.4","depth":2,"next":{"title":"Make a transfer","level":"3.1.5","depth":2,"path":"examples/promise/07_transfer_dots/README.md","ref":"examples/promise/07_transfer_dots/README.md","articles":[]},"previous":{"title":"Listen to balance change","level":"3.1.3","depth":2,"path":"examples/promise/03_listen_to_balance_change/README.md","ref":"examples/promise/03_listen_to_balance_change/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/05_read_storage/README.md","mtime":"2018-12-17T11:40:36.810Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T11:44:28.801Z"},"basePath":"../../..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"Read chain state","level":"3.1.4","depth":2,"next":{"title":"Make a transfer","level":"3.1.5","depth":2,"path":"examples/promise/07_transfer_dots/README.md","ref":"examples/promise/07_transfer_dots/README.md","articles":[]},"previous":{"title":"Listen to balance change","level":"3.1.3","depth":2,"path":"examples/promise/03_listen_to_balance_change/README.md","ref":"examples/promise/03_listen_to_balance_change/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/05_read_storage/README.md","mtime":"2018-12-17T13:55:52.030Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T13:59:36.621Z"},"basePath":"../../..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -2042,7 +2042,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"Make a transfer","level":"3.1.5","depth":2,"next":{"title":"Display system events","level":"3.1.6","depth":2,"path":"examples/promise/08_system_events/README.md","ref":"examples/promise/08_system_events/README.md","articles":[]},"previous":{"title":"Read chain state","level":"3.1.4","depth":2,"path":"examples/promise/05_read_storage/README.md","ref":"examples/promise/05_read_storage/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/07_transfer_dots/README.md","mtime":"2018-12-17T11:40:36.810Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T11:44:28.801Z"},"basePath":"../../..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"Make a transfer","level":"3.1.5","depth":2,"next":{"title":"Display system events","level":"3.1.6","depth":2,"path":"examples/promise/08_system_events/README.md","ref":"examples/promise/08_system_events/README.md","articles":[]},"previous":{"title":"Read chain state","level":"3.1.4","depth":2,"path":"examples/promise/05_read_storage/README.md","ref":"examples/promise/05_read_storage/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/07_transfer_dots/README.md","mtime":"2018-12-17T13:55:52.030Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T13:59:36.621Z"},"basePath":"../../..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -2039,7 +2039,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"Display system events","level":"3.1.6","depth":2,"next":{"title":"hidden","level":"4.1","depth":1,"path":"types/classes/_accountid_.accountid.md","ref":"types/classes/_accountid_.accountid.md","articles":[]},"previous":{"title":"Make a transfer","level":"3.1.5","depth":2,"path":"examples/promise/07_transfer_dots/README.md","ref":"examples/promise/07_transfer_dots/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/08_system_events/README.md","mtime":"2018-12-17T11:40:36.810Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T11:44:28.801Z"},"basePath":"../../..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"Display system events","level":"3.1.6","depth":2,"next":{"title":"hidden","level":"4.1","depth":1,"path":"types/classes/_accountid_.accountid.md","ref":"types/classes/_accountid_.accountid.md","articles":[]},"previous":{"title":"Make a transfer","level":"3.1.5","depth":2,"path":"examples/promise/07_transfer_dots/README.md","ref":"examples/promise/07_transfer_dots/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/08_system_events/README.md","mtime":"2018-12-17T13:55:52.030Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T13:59:36.621Z"},"basePath":"../../..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -2018,7 +2018,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"ApiPromise","level":"3.1","depth":1,"next":{"title":"Simple connect","level":"3.1.1","depth":2,"path":"examples/promise/01_simple_connect/README.md","ref":"examples/promise/01_simple_connect/README.md","articles":[]},"previous":{"title":"Events (runtime)","level":"2.4","depth":1,"path":"METHODS_EVENTS.md","ref":"METHODS_EVENTS.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/README.md","mtime":"2018-12-17T11:40:36.810Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T11:44:28.801Z"},"basePath":"../..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"ApiPromise","level":"3.1","depth":1,"next":{"title":"Simple connect","level":"3.1.1","depth":2,"path":"examples/promise/01_simple_connect/README.md","ref":"examples/promise/01_simple_connect/README.md","articles":[]},"previous":{"title":"Events (runtime)","level":"2.4","depth":1,"path":"METHODS_EVENTS.md","ref":"METHODS_EVENTS.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/README.md","mtime":"2018-12-17T13:55:52.030Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T13:59:36.621Z"},"basePath":"../..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
+1
-1
@@ -2011,7 +2011,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"Introduction","level":"1.1","depth":1,"next":{"title":"api","level":"1.2","depth":1,"path":"api/README.md","ref":"api/README.md","articles":[{"title":"ApiPromise","level":"1.2.1","depth":2,"path":"api/classes/_promise_index_.apipromise.md","ref":"api/classes/_promise_index_.apipromise.md","articles":[]},{"title":"ApiRx","level":"1.2.2","depth":2,"path":"api/classes/_rx_index_.apirx.md","ref":"api/classes/_rx_index_.apirx.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"README.md","mtime":"2018-12-17T11:40:36.802Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T11:44:28.801Z"},"basePath":".","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"Introduction","level":"1.1","depth":1,"next":{"title":"api","level":"1.2","depth":1,"path":"api/README.md","ref":"api/README.md","articles":[{"title":"ApiPromise","level":"1.2.1","depth":2,"path":"api/classes/_promise_index_.apipromise.md","ref":"api/classes/_promise_index_.apipromise.md","articles":[]},{"title":"ApiRx","level":"1.2.2","depth":2,"path":"api/classes/_rx_index_.apirx.md","ref":"api/classes/_rx_index_.apirx.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"README.md","mtime":"2018-12-17T13:55:52.022Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T13:59:36.621Z"},"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/d11906e/packages/rpc-core/src/index.ts#L46)*
|
||||
*Defined in [index.ts:46](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-core/src/index.ts#L42)*
|
||||
*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-core/src/index.ts#L43)*
|
||||
*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-core/src/index.ts#L44)*
|
||||
*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-core/src/index.ts#L45)*
|
||||
*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-core/src/index.ts#L46)*
|
||||
*Defined in [index.ts:46](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-core/src/index.ts#L79)*
|
||||
*Defined in [index.ts:79](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-core/src/types.ts#L17)*
|
||||
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-core/src/types.ts#L18)*
|
||||
*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-core/src/types.ts#L19)*
|
||||
*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-core/src/types.ts#L20)*
|
||||
*Defined in [types.ts:20](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-core/src/types.ts#L5)*
|
||||
*Defined in [types.ts:5](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-core/src/types.ts#L8)*
|
||||
*Defined in [types.ts:8](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-core/src/types.ts#L9)*
|
||||
*Defined in [types.ts:9](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-core/src/types.ts#L12)*
|
||||
*Defined in [types.ts:12](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-provider/src/coder/index.ts#L12)*
|
||||
*Defined in [coder/index.ts:12](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-provider/src/coder/index.ts#L33)*
|
||||
*Defined in [coder/index.ts:33](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-provider/src/coder/index.ts#L39)*
|
||||
*Defined in [coder/index.ts:39](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-provider/src/coder/index.ts#L48)*
|
||||
*Defined in [coder/index.ts:48](https://github.com/polkadot-js/api/blob/5f1178f/packages/rpc-provider/src/coder/index.ts#L48)*
|
||||
|
||||
**Returns:** `number`
|
||||
|
||||
|
||||
@@ -1981,7 +1981,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/d11906e/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/5f1178f/packages/rpc-provider/src/http/index.ts#L40" target="_blank">http/index.ts:40</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -2007,7 +2007,7 @@
|
||||
<p><a id="hassubscriptions"></a></p>
|
||||
<h2 id="hassubscriptions">hasSubscriptions</h2>
|
||||
<p>gethasSubscriptions(): <code>boolean</code></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/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/5f1178f/packages/rpc-provider/src/http/index.ts#L55" target="_blank">http/index.ts:55</a></em></p>
|
||||
<p><em><strong>summary</strong></em>: <code>true</code> when this provider supports subscriptions</p>
|
||||
<p><strong>Returns:</strong> <code>boolean</code></p>
|
||||
<hr>
|
||||
@@ -2016,7 +2016,7 @@
|
||||
<h2 id="isconnected">isConnected</h2>
|
||||
<p>▸ <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/d11906e/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/5f1178f/packages/rpc-provider/src/http/index.ts#L63" target="_blank">http/index.ts:63</a></em></p>
|
||||
<p><em><strong>summary</strong></em>: Whether the node is connected or not.</p>
|
||||
<p><strong>Returns:</strong> <code>boolean</code>
|
||||
true if connected</p>
|
||||
@@ -2025,7 +2025,7 @@ true if connected</p>
|
||||
<h2 id="on">on</h2>
|
||||
<p>▸ <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/d11906e/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/5f1178f/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>
|
||||
@@ -2053,7 +2053,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/d11906e/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/5f1178f/packages/rpc-provider/src/http/index.ts#L78" target="_blank">http/index.ts:78</a></em></p>
|
||||
<p><em><strong>summary</strong></em>: Send HTTP POST Request with Body to configured HTTP Endpoint.</p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
@@ -2080,7 +2080,7 @@ true if connected</p>
|
||||
<h2 id="subscribe">subscribe</h2>
|
||||
<p>▸ <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/d11906e/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/5f1178f/packages/rpc-provider/src/http/index.ts#L100" target="_blank">http/index.ts:100</a></em></p>
|
||||
<p><em><strong>summary</strong></em>: Subscriptions are not supported with the HttpProvider, see <a href="_ws_index_.wsprovider.html">WsProvider</a>.</p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
@@ -2115,7 +2115,7 @@ true if connected</p>
|
||||
<h2 id="unsubscribe">unsubscribe</h2>
|
||||
<p>▸ <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/d11906e/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/5f1178f/packages/rpc-provider/src/http/index.ts#L109" target="_blank">http/index.ts:109</a></em></p>
|
||||
<p><em><strong>summary</strong></em>: Subscriptions are not supported with the HttpProvider, see <a href="_ws_index_.wsprovider.html">WsProvider</a>.</p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
@@ -2185,7 +2185,7 @@ true if connected</p>
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"HttpProvider","level":"1.3.1","depth":2,"next":{"title":"WsProvider","level":"1.3.2","depth":2,"path":"rpc-provider/classes/_ws_index_.wsprovider.md","ref":"rpc-provider/classes/_ws_index_.wsprovider.md","articles":[]},"previous":{"title":"rpc-provider","level":"1.3","depth":1,"path":"rpc-provider/README.md","ref":"rpc-provider/README.md","articles":[{"title":"HttpProvider","level":"1.3.1","depth":2,"path":"rpc-provider/classes/_http_index_.httpprovider.md","ref":"rpc-provider/classes/_http_index_.httpprovider.md","articles":[]},{"title":"WsProvider","level":"1.3.2","depth":2,"path":"rpc-provider/classes/_ws_index_.wsprovider.md","ref":"rpc-provider/classes/_ws_index_.wsprovider.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"rpc-provider/classes/_http_index_.httpprovider.md","mtime":"2018-12-17T11:43:13.974Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T11:44:28.801Z"},"basePath":"../..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"HttpProvider","level":"1.3.1","depth":2,"next":{"title":"WsProvider","level":"1.3.2","depth":2,"path":"rpc-provider/classes/_ws_index_.wsprovider.md","ref":"rpc-provider/classes/_ws_index_.wsprovider.md","articles":[]},"previous":{"title":"rpc-provider","level":"1.3","depth":1,"path":"rpc-provider/README.md","ref":"rpc-provider/README.md","articles":[{"title":"HttpProvider","level":"1.3.1","depth":2,"path":"rpc-provider/classes/_http_index_.httpprovider.md","ref":"rpc-provider/classes/_http_index_.httpprovider.md","articles":[]},{"title":"WsProvider","level":"1.3.2","depth":2,"path":"rpc-provider/classes/_ws_index_.wsprovider.md","ref":"rpc-provider/classes/_ws_index_.wsprovider.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"rpc-provider/classes/_http_index_.httpprovider.md","mtime":"2018-12-17T13:58:25.296Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T13:59:36.621Z"},"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/d11906e/packages/rpc-provider/src/http/index.ts#L40)*
|
||||
*Defined in [http/index.ts:40](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-provider/src/http/index.ts#L55)*
|
||||
*Defined in [http/index.ts:55](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-provider/src/http/index.ts#L63)*
|
||||
*Defined in [http/index.ts:63](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-provider/src/http/index.ts#L71)*
|
||||
*Defined in [http/index.ts:71](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-provider/src/http/index.ts#L78)*
|
||||
*Defined in [http/index.ts:78](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-provider/src/http/index.ts#L100)*
|
||||
*Defined in [http/index.ts:100](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-provider/src/http/index.ts#L109)*
|
||||
*Defined in [http/index.ts:109](https://github.com/polkadot-js/api/blob/5f1178f/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:64](https://github.com/polkadot-js/api/blob/d11906e/packages/rpc-provider/src/mock/index.ts#L64)*
|
||||
*Defined in [mock/index.ts:64](https://github.com/polkadot-js/api/blob/5f1178f/packages/rpc-provider/src/mock/index.ts#L64)*
|
||||
|
||||
**Returns:** [Mock](_mock_index_.mock.md)
|
||||
|
||||
@@ -33,7 +33,7 @@ ___
|
||||
|
||||
**● isUpdating**: *`boolean`* = true
|
||||
|
||||
*Defined in [mock/index.ts:42](https://github.com/polkadot-js/api/blob/d11906e/packages/rpc-provider/src/mock/index.ts#L42)*
|
||||
*Defined in [mock/index.ts:42](https://github.com/polkadot-js/api/blob/5f1178f/packages/rpc-provider/src/mock/index.ts#L42)*
|
||||
|
||||
___
|
||||
<a id="subscriptions"></a>
|
||||
@@ -49,7 +49,7 @@ ___
|
||||
return subs;
|
||||
}, ({} as MockState$Subscriptions))
|
||||
|
||||
*Defined in [mock/index.ts:53](https://github.com/polkadot-js/api/blob/d11906e/packages/rpc-provider/src/mock/index.ts#L53)*
|
||||
*Defined in [mock/index.ts:53](https://github.com/polkadot-js/api/blob/5f1178f/packages/rpc-provider/src/mock/index.ts#L53)*
|
||||
|
||||
___
|
||||
|
||||
@@ -61,7 +61,7 @@ ___
|
||||
|
||||
gethasSubscriptions(): `boolean`
|
||||
|
||||
*Defined in [mock/index.ts:70](https://github.com/polkadot-js/api/blob/d11906e/packages/rpc-provider/src/mock/index.ts#L70)*
|
||||
*Defined in [mock/index.ts:70](https://github.com/polkadot-js/api/blob/5f1178f/packages/rpc-provider/src/mock/index.ts#L70)*
|
||||
|
||||
**Returns:** `boolean`
|
||||
|
||||
@@ -77,7 +77,7 @@ ___
|
||||
|
||||
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[isConnected](../interfaces/_types_.providerinterface.md#isconnected)*
|
||||
|
||||
*Defined in [mock/index.ts:74](https://github.com/polkadot-js/api/blob/d11906e/packages/rpc-provider/src/mock/index.ts#L74)*
|
||||
*Defined in [mock/index.ts:74](https://github.com/polkadot-js/api/blob/5f1178f/packages/rpc-provider/src/mock/index.ts#L74)*
|
||||
|
||||
**Returns:** `boolean`
|
||||
|
||||
@@ -90,7 +90,7 @@ ___
|
||||
|
||||
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[on](../interfaces/_types_.providerinterface.md#on)*
|
||||
|
||||
*Defined in [mock/index.ts:78](https://github.com/polkadot-js/api/blob/d11906e/packages/rpc-provider/src/mock/index.ts#L78)*
|
||||
*Defined in [mock/index.ts:78](https://github.com/polkadot-js/api/blob/5f1178f/packages/rpc-provider/src/mock/index.ts#L78)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -110,7 +110,7 @@ ___
|
||||
|
||||
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[send](../interfaces/_types_.providerinterface.md#send)*
|
||||
|
||||
*Defined in [mock/index.ts:82](https://github.com/polkadot-js/api/blob/d11906e/packages/rpc-provider/src/mock/index.ts#L82)*
|
||||
*Defined in [mock/index.ts:82](https://github.com/polkadot-js/api/blob/5f1178f/packages/rpc-provider/src/mock/index.ts#L82)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -128,7 +128,7 @@ ___
|
||||
|
||||
▸ **subscribe**(type: *`string`*, method: *`string`*, ...params: *`Array`<`any`>*): `Promise`<`number`>
|
||||
|
||||
*Defined in [mock/index.ts:90](https://github.com/polkadot-js/api/blob/d11906e/packages/rpc-provider/src/mock/index.ts#L90)*
|
||||
*Defined in [mock/index.ts:90](https://github.com/polkadot-js/api/blob/5f1178f/packages/rpc-provider/src/mock/index.ts#L90)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -149,7 +149,7 @@ ___
|
||||
|
||||
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[unsubscribe](../interfaces/_types_.providerinterface.md#unsubscribe)*
|
||||
|
||||
*Defined in [mock/index.ts:110](https://github.com/polkadot-js/api/blob/d11906e/packages/rpc-provider/src/mock/index.ts#L110)*
|
||||
*Defined in [mock/index.ts:110](https://github.com/polkadot-js/api/blob/5f1178f/packages/rpc-provider/src/mock/index.ts#L110)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -1981,7 +1981,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/d11906e/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/5f1178f/packages/rpc-provider/src/ws/index.ts#L75" target="_blank">ws/index.ts:75</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -2013,7 +2013,7 @@
|
||||
<p><a id="hassubscriptions"></a></p>
|
||||
<h2 id="hassubscriptions">hasSubscriptions</h2>
|
||||
<p>gethasSubscriptions(): <code>boolean</code></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/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/5f1178f/packages/rpc-provider/src/ws/index.ts#L101" target="_blank">ws/index.ts:101</a></em></p>
|
||||
<p><em><strong>summary</strong></em>: <code>true</code> when this provider supports subscriptions</p>
|
||||
<p><strong>Returns:</strong> <code>boolean</code></p>
|
||||
<hr>
|
||||
@@ -2021,7 +2021,7 @@
|
||||
<p><a id="connect"></a></p>
|
||||
<h2 id="connect">connect</h2>
|
||||
<p>▸ <strong>connect</strong>(): <code>void</code></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/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/5f1178f/packages/rpc-provider/src/ws/index.ts#L110" target="_blank">ws/index.ts:110</a></em></p>
|
||||
<p><em><strong>summary</strong></em>: Manually connect</p>
|
||||
<p><em><strong>description</strong></em>: The <a href="_ws_index_.wsprovider.html">WsProvider</a> connects automatically by default, however if you decided otherwise, you may connect manually using this method.</p>
|
||||
<p><strong>Returns:</strong> <code>void</code></p>
|
||||
@@ -2029,7 +2029,7 @@
|
||||
<p><a id="isconnected"></a></p>
|
||||
<h2 id="isconnected">isConnected</h2>
|
||||
<p>▸ <strong>isConnected</strong>(): <code>boolean</code></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/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/5f1178f/packages/rpc-provider/src/ws/index.ts#L127" target="_blank">ws/index.ts:127</a></em></p>
|
||||
<p><em><strong>summary</strong></em>: Whether the node is connected or not.</p>
|
||||
<p><strong>Returns:</strong> <code>boolean</code>
|
||||
true if connected</p>
|
||||
@@ -2037,7 +2037,7 @@ true if connected</p>
|
||||
<p><a id="on"></a></p>
|
||||
<h2 id="on">on</h2>
|
||||
<p>▸ <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/d11906e/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/5f1178f/packages/rpc-provider/src/ws/index.ts#L136" target="_blank">ws/index.ts:136</a></em></p>
|
||||
<p><em><strong>summary</strong></em>: Listens on events after having subscribed using the <a href="_ws_index_.wsprovider.html#subscribe">subscribe</a> function.</p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
@@ -2066,7 +2066,7 @@ true if connected</p>
|
||||
<p><a id="send"></a></p>
|
||||
<h2 id="send">send</h2>
|
||||
<p>▸ <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/d11906e/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/5f1178f/packages/rpc-provider/src/ws/index.ts#L146" target="_blank">ws/index.ts:146</a></em></p>
|
||||
<p><em><strong>summary</strong></em>: Send JSON data using WebSockets to configured HTTP Endpoint or queue.</p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
@@ -2100,7 +2100,7 @@ true if connected</p>
|
||||
<p><a id="subscribe"></a></p>
|
||||
<h2 id="subscribe">subscribe</h2>
|
||||
<p>▸ <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/d11906e/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/5f1178f/packages/rpc-provider/src/ws/index.ts#L200" target="_blank">ws/index.ts:200</a></em></p>
|
||||
<p><em><strong>name</strong></em>: subscribe</p>
|
||||
<p><em><strong>summary</strong></em>: Allows subscribing to a specific event.</p>
|
||||
<p><em><strong>example</strong></em>: </p>
|
||||
@@ -2151,7 +2151,7 @@ Promise resolving to the dd of the subscription you can use with [[unsubscribe]]
|
||||
<p><a id="unsubscribe"></a></p>
|
||||
<h2 id="unsubscribe">unsubscribe</h2>
|
||||
<p>▸ <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/d11906e/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/5f1178f/packages/rpc-provider/src/ws/index.ts#L209" target="_blank">ws/index.ts:209</a></em></p>
|
||||
<p><em><strong>summary</strong></em>: Allows unsubscribing to subscriptions made with <a href="_ws_index_.wsprovider.html#subscribe">subscribe</a>.</p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
@@ -2221,7 +2221,7 @@ Promise resolving to the dd of the subscription you can use with [[unsubscribe]]
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"WsProvider","level":"1.3.2","depth":2,"next":{"title":"types (codec implementation)","level":"1.4","depth":1,"path":"types/README.md","ref":"types/README.md","articles":[]},"previous":{"title":"HttpProvider","level":"1.3.1","depth":2,"path":"rpc-provider/classes/_http_index_.httpprovider.md","ref":"rpc-provider/classes/_http_index_.httpprovider.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"rpc-provider/classes/_ws_index_.wsprovider.md","mtime":"2018-12-17T11:43:14.074Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T11:44:28.801Z"},"basePath":"../..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"WsProvider","level":"1.3.2","depth":2,"next":{"title":"types (codec implementation)","level":"1.4","depth":1,"path":"types/README.md","ref":"types/README.md","articles":[]},"previous":{"title":"HttpProvider","level":"1.3.1","depth":2,"path":"rpc-provider/classes/_http_index_.httpprovider.md","ref":"rpc-provider/classes/_http_index_.httpprovider.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"rpc-provider/classes/_ws_index_.wsprovider.md","mtime":"2018-12-17T13:58:25.396Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T13:59:36.621Z"},"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/d11906e/packages/rpc-provider/src/ws/index.ts#L75)*
|
||||
*Defined in [ws/index.ts:75](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-provider/src/ws/index.ts#L101)*
|
||||
*Defined in [ws/index.ts:101](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-provider/src/ws/index.ts#L110)*
|
||||
*Defined in [ws/index.ts:110](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-provider/src/ws/index.ts#L127)*
|
||||
*Defined in [ws/index.ts:127](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-provider/src/ws/index.ts#L136)*
|
||||
*Defined in [ws/index.ts:136](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-provider/src/ws/index.ts#L146)*
|
||||
*Defined in [ws/index.ts:146](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-provider/src/ws/index.ts#L200)*
|
||||
*Defined in [ws/index.ts:200](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-provider/src/ws/index.ts#L209)*
|
||||
*Defined in [ws/index.ts:209](https://github.com/polkadot-js/api/blob/5f1178f/packages/rpc-provider/src/ws/index.ts#L209)*
|
||||
|
||||
*__summary__*: Allows unsubscribing to subscriptions made with [subscribe](_ws_index_.wsprovider.md#subscribe).
|
||||
|
||||
|
||||
@@ -2029,7 +2029,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"rpc-provider","level":"1.3","depth":1,"next":{"title":"HttpProvider","level":"1.3.1","depth":2,"path":"rpc-provider/classes/_http_index_.httpprovider.md","ref":"rpc-provider/classes/_http_index_.httpprovider.md","articles":[]},"previous":{"title":"ApiRx","level":"1.2.2","depth":2,"path":"api/classes/_rx_index_.apirx.md","ref":"api/classes/_rx_index_.apirx.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"rpc-provider/README.md","mtime":"2018-12-17T11:43:13.782Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T11:44:28.801Z"},"basePath":"..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"rpc-provider","level":"1.3","depth":1,"next":{"title":"HttpProvider","level":"1.3.1","depth":2,"path":"rpc-provider/classes/_http_index_.httpprovider.md","ref":"rpc-provider/classes/_http_index_.httpprovider.md","articles":[]},"previous":{"title":"ApiRx","level":"1.2.2","depth":2,"path":"api/classes/_rx_index_.apirx.md","ref":"api/classes/_rx_index_.apirx.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"rpc-provider/README.md","mtime":"2018-12-17T13:58:25.128Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T13:59:36.621Z"},"basePath":"..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -17,7 +17,7 @@
|
||||
|
||||
**● hasSubscriptions**: *`boolean`*
|
||||
|
||||
*Defined in [types.ts:45](https://github.com/polkadot-js/api/blob/d11906e/packages/rpc-provider/src/types.ts#L45)*
|
||||
*Defined in [types.ts:45](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-provider/src/types.ts#L46)*
|
||||
*Defined in [types.ts:46](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-provider/src/types.ts#L47)*
|
||||
*Defined in [types.ts:47](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-provider/src/types.ts#L48)*
|
||||
*Defined in [types.ts:48](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-provider/src/types.ts#L49)*
|
||||
*Defined in [types.ts:49](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-provider/src/types.ts#L50)*
|
||||
*Defined in [types.ts:50](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-provider/src/http/types.ts#L9)*
|
||||
*Defined in [http/types.ts:9](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-provider/src/mock/types.ts#L16)*
|
||||
*Defined in [mock/types.ts:16](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-provider/src/mock/types.ts#L20)*
|
||||
*Defined in [mock/types.ts:20](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-provider/src/mock/types.ts#L5)*
|
||||
*Defined in [mock/types.ts:5](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-provider/src/mock/types.ts#L7)*
|
||||
*Defined in [mock/types.ts:7](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-provider/src/types.ts#L5)*
|
||||
*Defined in [types.ts:5](https://github.com/polkadot-js/api/blob/5f1178f/packages/rpc-provider/src/types.ts#L5)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
@@ -39,7 +39,7 @@ ___
|
||||
**Ƭ JsonRpcRequest**: * [JsonRpcObject](_types_.md#jsonrpcobject) & `object`
|
||||
*
|
||||
|
||||
*Defined in [types.ts:10](https://github.com/polkadot-js/api/blob/d11906e/packages/rpc-provider/src/types.ts#L10)*
|
||||
*Defined in [types.ts:10](https://github.com/polkadot-js/api/blob/5f1178f/packages/rpc-provider/src/types.ts#L10)*
|
||||
|
||||
___
|
||||
<a id="jsonrpcresponse"></a>
|
||||
@@ -49,7 +49,7 @@ ___
|
||||
**Ƭ JsonRpcResponse**: * [JsonRpcObject](_types_.md#jsonrpcobject) & [JsonRpcResponseBase](_types_.md#jsonrpcresponsebase)
|
||||
*
|
||||
|
||||
*Defined in [types.ts:36](https://github.com/polkadot-js/api/blob/d11906e/packages/rpc-provider/src/types.ts#L36)*
|
||||
*Defined in [types.ts:36](https://github.com/polkadot-js/api/blob/5f1178f/packages/rpc-provider/src/types.ts#L36)*
|
||||
|
||||
___
|
||||
<a id="jsonrpcresponsebase"></a>
|
||||
@@ -59,7 +59,7 @@ ___
|
||||
**Ƭ JsonRpcResponseBase**: * `JsonRpcResponse$Single` & `JsonRpcResponse$Subscription`
|
||||
*
|
||||
|
||||
*Defined in [types.ts:34](https://github.com/polkadot-js/api/blob/d11906e/packages/rpc-provider/src/types.ts#L34)*
|
||||
*Defined in [types.ts:34](https://github.com/polkadot-js/api/blob/5f1178f/packages/rpc-provider/src/types.ts#L34)*
|
||||
|
||||
___
|
||||
<a id="jsonrpcresponsebase_error"></a>
|
||||
@@ -68,7 +68,7 @@ ___
|
||||
|
||||
**Ƭ JsonRpcResponseBase$Error**: *`object`*
|
||||
|
||||
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/d11906e/packages/rpc-provider/src/types.ts#L15)*
|
||||
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/5f1178f/packages/rpc-provider/src/types.ts#L15)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
@@ -79,7 +79,7 @@ ___
|
||||
|
||||
**Ƭ ProviderInterface$Callback**: *`function`*
|
||||
|
||||
*Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/d11906e/packages/rpc-provider/src/types.ts#L38)*
|
||||
*Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/5f1178f/packages/rpc-provider/src/types.ts#L38)*
|
||||
|
||||
#### Type declaration
|
||||
▸(result: *`any`*): `void`
|
||||
@@ -99,7 +99,7 @@ ___
|
||||
|
||||
**Ƭ ProviderInterface$EmitCb**: *`function`*
|
||||
|
||||
*Defined in [types.ts:42](https://github.com/polkadot-js/api/blob/d11906e/packages/rpc-provider/src/types.ts#L42)*
|
||||
*Defined in [types.ts:42](https://github.com/polkadot-js/api/blob/5f1178f/packages/rpc-provider/src/types.ts#L42)*
|
||||
|
||||
#### Type declaration
|
||||
▸(value?: *`any`*): `any`
|
||||
@@ -120,7 +120,7 @@ ___
|
||||
**Ƭ ProviderInterface$Emitted**: * "connected" | "disconnected" | "error"
|
||||
*
|
||||
|
||||
*Defined in [types.ts:40](https://github.com/polkadot-js/api/blob/d11906e/packages/rpc-provider/src/types.ts#L40)*
|
||||
*Defined in [types.ts:40](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-rx/src/index.ts#L45)*
|
||||
*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-rx/src/index.ts#L42)*
|
||||
*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-rx/src/index.ts#L43)*
|
||||
*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-rx/src/index.ts#L44)*
|
||||
*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-rx/src/index.ts#L45)*
|
||||
*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-rx/src/index.ts#L66)*
|
||||
*Defined in [index.ts:66](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-rx/src/index.ts#L70)*
|
||||
*Defined in [index.ts:70](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-rx/src/types.ts#L16)*
|
||||
*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-rx/src/types.ts#L14)*
|
||||
*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-rx/src/types.ts#L8)*
|
||||
*Defined in [types.ts:8](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/rpc-rx/src/types.ts#L10)*
|
||||
*Defined in [types.ts:10](https://github.com/polkadot-js/api/blob/5f1178f/packages/rpc-rx/src/types.ts#L10)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
▸ **fromMetadata**(metadata: *`Metadata`*): `Extrinsics`
|
||||
|
||||
*Defined in [fromMetadata.ts:21](https://github.com/polkadot-js/api/blob/d11906e/packages/type-extrinsics/src/fromMetadata.ts#L21)*
|
||||
*Defined in [fromMetadata.ts:21](https://github.com/polkadot-js/api/blob/5f1178f/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`*): `ExtrinsicFunction`
|
||||
|
||||
*Defined in [utils/createUnchecked.ts:16](https://github.com/polkadot-js/api/blob/d11906e/packages/type-extrinsics/src/utils/createUnchecked.ts#L16)*
|
||||
*Defined in [utils/createUnchecked.ts:16](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/type-jsonrpc/src/create/method.ts#L9)*
|
||||
*Defined in [create/method.ts:9](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/type-jsonrpc/src/create/param.ts#L12)*
|
||||
*Defined in [create/param.ts:12](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/type-jsonrpc/src/types.ts#L24)*
|
||||
*Defined in [types.ts:24](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/type-jsonrpc/src/types.ts#L13)*
|
||||
*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/type-jsonrpc/src/types.ts#L7)*
|
||||
*Defined in [types.ts:7](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/type-jsonrpc/src/types.ts#L38)*
|
||||
*Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/type-storage/src/types.ts#L17)*
|
||||
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/5f1178f/packages/type-storage/src/types.ts#L17)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
|
||||
@@ -13,7 +13,7 @@
|
||||
**● isUnhashed**: * `undefined` | `false` | `true`
|
||||
*
|
||||
|
||||
*Defined in [utils/createFunction.ts:14](https://github.com/polkadot-js/api/blob/d11906e/packages/type-storage/src/utils/createFunction.ts#L14)*
|
||||
*Defined in [utils/createFunction.ts:14](https://github.com/polkadot-js/api/blob/5f1178f/packages/type-storage/src/utils/createFunction.ts#L14)*
|
||||
|
||||
___
|
||||
<a id="key"></a>
|
||||
@@ -23,7 +23,7 @@ ___
|
||||
**● key**: * `undefined` | `string`
|
||||
*
|
||||
|
||||
*Defined in [utils/createFunction.ts:15](https://github.com/polkadot-js/api/blob/d11906e/packages/type-storage/src/utils/createFunction.ts#L15)*
|
||||
*Defined in [utils/createFunction.ts:15](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/type-storage/src/fromMetadata.ts#L20)*
|
||||
*Defined in [fromMetadata.ts:20](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/type-storage/src/storage.ts#L8)*
|
||||
*Defined in [storage.ts:8](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/type-storage/src/storage.ts#L9)*
|
||||
*Defined in [storage.ts:9](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/type-storage/src/substrate.ts#L45)*
|
||||
*Defined in [substrate.ts:45](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/type-storage/src/substrate.ts#L50)*
|
||||
*Defined in [substrate.ts:50](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/type-storage/src/substrate.ts#L60)*
|
||||
*Defined in [substrate.ts:60](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/type-storage/src/substrate.ts#L35)*
|
||||
*Defined in [substrate.ts:35](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/type-storage/src/substrate.ts#L55)*
|
||||
*Defined in [substrate.ts:55](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/type-storage/src/substrate.ts#L40)*
|
||||
*Defined in [substrate.ts:40](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/type-storage/src/utils/createFunction.ts#L28)*
|
||||
*Defined in [utils/createFunction.ts:28](https://github.com/polkadot-js/api/blob/5f1178f/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.
|
||||
|
||||
|
||||
@@ -1977,7 +1977,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/d11906e/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/5f1178f/packages/types/src/AccountId.ts#L19" target="_blank">AccountId.ts:19</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -2037,7 +2037,7 @@
|
||||
<h2 id="encodedlength">encodedLength</h2>
|
||||
<p>getencodedLength(): <code>number</code></p>
|
||||
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#encodedlength">encodedLength</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/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/5f1178f/packages/types/src/codec/U8a.ts#L36" target="_blank">codec/U8a.ts:36</a></em></p>
|
||||
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
|
||||
<p><strong>Returns:</strong> <code>number</code></p>
|
||||
<hr>
|
||||
@@ -2046,7 +2046,7 @@
|
||||
<p>getlength(): <code>number</code></p>
|
||||
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#length">length</a></em></p>
|
||||
<p><em>Overrides Uint8Array.length</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/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/5f1178f/packages/types/src/codec/U8a.ts#L43" target="_blank">codec/U8a.ts:43</a></em></p>
|
||||
<p><em><strong>description</strong></em>: The length of the value</p>
|
||||
<p><strong>Returns:</strong> <code>number</code></p>
|
||||
<hr>
|
||||
@@ -2062,7 +2062,7 @@
|
||||
<h2 id="bitlength">bitLength</h2>
|
||||
<p>▸ <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/d11906e/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/5f1178f/packages/types/src/codec/U8aFixed.ts#L39" target="_blank">codec/U8aFixed.ts:39</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Returns the number of bits in the value</p>
|
||||
<p><strong>Returns:</strong> <code>number</code></p>
|
||||
<hr>
|
||||
@@ -2729,7 +2729,7 @@
|
||||
<p>▸ <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/d11906e/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/5f1178f/packages/types/src/codec/U8a.ts#L53" target="_blank">codec/U8a.ts:53</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here</p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
@@ -2760,7 +2760,7 @@
|
||||
<p>▸ <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/d11906e/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/5f1178f/packages/types/src/codec/U8a.ts#L60" target="_blank">codec/U8a.ts:60</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
|
||||
<p><strong>Returns:</strong> <code>string</code></p>
|
||||
<hr>
|
||||
@@ -2769,7 +2769,7 @@
|
||||
<p>▸ <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/d11906e/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/5f1178f/packages/types/src/AccountId.ts#L46" target="_blank">AccountId.ts:46</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
|
||||
<p><strong>Returns:</strong> <code>any</code></p>
|
||||
<hr>
|
||||
@@ -2786,7 +2786,7 @@
|
||||
<p>▸ <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/d11906e/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/5f1178f/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>
|
||||
@@ -2794,7 +2794,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/d11906e/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/5f1178f/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>
|
||||
@@ -2826,7 +2826,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/d11906e/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/5f1178f/packages/types/src/AccountId.ts#L27" target="_blank">AccountId.ts:27</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -2887,7 +2887,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.1","depth":1,"next":{"title":"hidden","level":"4.2","depth":1,"path":"types/classes/_accountindex_.accountindex.md","ref":"types/classes/_accountindex_.accountindex.md","articles":[]},"previous":{"title":"Display system events","level":"3.1.6","depth":2,"path":"examples/promise/08_system_events/README.md","ref":"examples/promise/08_system_events/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"types/classes/_accountid_.accountid.md","mtime":"2018-12-17T11:43:40.373Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T11:44:28.801Z"},"basePath":"../..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.1","depth":1,"next":{"title":"hidden","level":"4.2","depth":1,"path":"types/classes/_accountindex_.accountindex.md","ref":"types/classes/_accountindex_.accountindex.md","articles":[]},"previous":{"title":"Display system events","level":"3.1.6","depth":2,"path":"examples/promise/08_system_events/README.md","ref":"examples/promise/08_system_events/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"types/classes/_accountid_.accountid.md","mtime":"2018-12-17T13:58:50.141Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T13:59:36.621Z"},"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/d11906e/packages/types/src/AccountId.ts#L19)*
|
||||
*Defined in [AccountId.ts:19](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/AccountId.ts#L19)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -117,7 +117,7 @@ getencodedLength(): `number`
|
||||
|
||||
*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)*
|
||||
|
||||
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/U8a.ts#L36)*
|
||||
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/U8a.ts#L36)*
|
||||
|
||||
*__description__*: The length of the value when encoded as a Uint8Array
|
||||
|
||||
@@ -134,7 +134,7 @@ getlength(): `number`
|
||||
|
||||
*Overrides Uint8Array.length*
|
||||
|
||||
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/U8a.ts#L43)*
|
||||
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/U8a.ts#L43)*
|
||||
|
||||
*__description__*: The length of the value
|
||||
|
||||
@@ -165,7 +165,7 @@ ___
|
||||
|
||||
*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)*
|
||||
|
||||
*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/U8aFixed.ts#L39)*
|
||||
*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/U8aFixed.ts#L39)*
|
||||
|
||||
*__description__*: Returns the number of bits in the value
|
||||
|
||||
@@ -691,7 +691,7 @@ ___
|
||||
|
||||
*Overrides Uint8Array.subarray*
|
||||
|
||||
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/U8a.ts#L53)*
|
||||
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/U8a.ts#L53)*
|
||||
|
||||
*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here
|
||||
|
||||
@@ -715,7 +715,7 @@ ___
|
||||
|
||||
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
|
||||
|
||||
*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/U8a.ts#L60)*
|
||||
*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/U8a.ts#L60)*
|
||||
|
||||
*__description__*: Returns a hex string representation of the value
|
||||
|
||||
@@ -732,7 +732,7 @@ ___
|
||||
|
||||
*Overrides [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
|
||||
|
||||
*Defined in [AccountId.ts:46](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/AccountId.ts#L46)*
|
||||
*Defined in [AccountId.ts:46](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/AccountId.ts#L46)*
|
||||
|
||||
*__description__*: Converts the Object to JSON, typically used for RPC transfers
|
||||
|
||||
@@ -764,7 +764,7 @@ ___
|
||||
|
||||
*Overrides [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)*
|
||||
|
||||
*Defined in [AccountId.ts:53](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/AccountId.ts#L53)*
|
||||
*Defined in [AccountId.ts:53](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/AccountId.ts#L53)*
|
||||
|
||||
*__description__*: Returns the string representation of the value
|
||||
|
||||
@@ -779,7 +779,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/d11906e/packages/types/src/codec/U8a.ts#L82)*
|
||||
*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/U8a.ts#L82)*
|
||||
|
||||
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
|
||||
|
||||
@@ -813,7 +813,7 @@ ___
|
||||
|
||||
▸ **encode**(value: *`Uint8Array`*): `string`
|
||||
|
||||
*Defined in [AccountId.ts:27](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/AccountId.ts#L27)*
|
||||
*Defined in [AccountId.ts:27](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/AccountId.ts#L27)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -1974,7 +1974,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/d11906e/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/5f1178f/packages/types/src/AccountIndex.ts#L29" target="_blank">AccountIndex.ts:29</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -1999,7 +1999,7 @@
|
||||
<h2 id="encodedlength">encodedLength</h2>
|
||||
<p>getencodedLength(): <code>number</code></p>
|
||||
<p><em>Inherited from <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#encodedlength">encodedLength</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/UInt.ts#L57" target="_blank">codec/UInt.ts:57</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/UInt.ts#L57" target="_blank">codec/UInt.ts:57</a></em></p>
|
||||
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
|
||||
<p><strong>Returns:</strong> <code>number</code></p>
|
||||
<hr>
|
||||
@@ -2132,7 +2132,7 @@
|
||||
<p>▸ <strong>bitLength</strong>(): <a href="../modules/_codec_uint_.md#uintbitlength">UIntBitLength</a></p>
|
||||
<p><em>Inherited from <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#bitlength">bitLength</a></em></p>
|
||||
<p><em>Overrides BN.bitLength</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/UInt.ts#L64" target="_blank">codec/UInt.ts:64</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/UInt.ts#L64" target="_blank">codec/UInt.ts:64</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Returns the number of bits in the value</p>
|
||||
<p><strong>Returns:</strong> <a href="../modules/_codec_uint_.md#uintbitlength">UIntBitLength</a></p>
|
||||
<hr>
|
||||
@@ -3510,7 +3510,7 @@
|
||||
<h2 id="tobn">toBn</h2>
|
||||
<p>▸ <strong>toBn</strong>(): <code>BN</code></p>
|
||||
<p><em>Overrides <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#tobn">toBn</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/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/5f1178f/packages/types/src/AccountIndex.ts#L92" target="_blank">AccountIndex.ts:92</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Returns the BN representation of the AccountIndex</p>
|
||||
<p><strong>Returns:</strong> <code>BN</code></p>
|
||||
<hr>
|
||||
@@ -3546,7 +3546,7 @@
|
||||
<p>▸ <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/d11906e/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/5f1178f/packages/types/src/AccountIndex.ts#L99" target="_blank">AccountIndex.ts:99</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
|
||||
<p><strong>Returns:</strong> <code>string</code></p>
|
||||
<hr>
|
||||
@@ -3555,7 +3555,7 @@
|
||||
<p>▸ <strong>toJSON</strong>(): <code>any</code></p>
|
||||
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
|
||||
<p><em>Overrides <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#tojson">toJSON</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/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/5f1178f/packages/types/src/AccountIndex.ts#L108" target="_blank">AccountIndex.ts:108</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
|
||||
<p><strong>Returns:</strong> <code>any</code></p>
|
||||
<hr>
|
||||
@@ -3595,7 +3595,7 @@
|
||||
<p>▸ <strong>toString</strong>(): <code>string</code></p>
|
||||
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
|
||||
<p><em>Overrides <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#tostring">toString</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/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/5f1178f/packages/types/src/AccountIndex.ts#L115" target="_blank">AccountIndex.ts:115</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
|
||||
<p><strong>Returns:</strong> <code>string</code></p>
|
||||
<hr>
|
||||
@@ -3627,7 +3627,7 @@
|
||||
<p>▸ <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/d11906e/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/5f1178f/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>
|
||||
@@ -3848,7 +3848,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/d11906e/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/5f1178f/packages/types/src/AccountIndex.ts#L52" target="_blank">AccountIndex.ts:52</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -3869,7 +3869,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/d11906e/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/5f1178f/packages/types/src/AccountIndex.ts#L36" target="_blank">AccountIndex.ts:36</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -3891,7 +3891,7 @@
|
||||
<h2 id="static-decodeuint"><code><Static></code> decodeUInt</h2>
|
||||
<p>▸ <strong>decodeUInt</strong>(value: <em><a href="../modules/_types_.md#anynumber">AnyNumber</a></em>, bitLength: <em><a href="../modules/_codec_uint_.md#uintbitlength">UIntBitLength</a></em>): <code>string</code></p>
|
||||
<p><em>Inherited from <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#decodeuint">decodeUInt</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/UInt.ts#L38" target="_blank">codec/UInt.ts:38</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/UInt.ts#L38" target="_blank">codec/UInt.ts:38</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -4016,7 +4016,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/d11906e/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/5f1178f/packages/types/src/AccountIndex.ts#L66" target="_blank">AccountIndex.ts:66</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -4060,7 +4060,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/d11906e/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/5f1178f/packages/types/src/AccountIndex.ts#L80" target="_blank">AccountIndex.ts:80</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -4121,7 +4121,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.2","depth":1,"next":{"title":"hidden","level":"4.3","depth":1,"path":"types/classes/_address_.address.md","ref":"types/classes/_address_.address.md","articles":[]},"previous":{"title":"hidden","level":"4.1","depth":1,"path":"types/classes/_accountid_.accountid.md","ref":"types/classes/_accountid_.accountid.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"types/classes/_accountindex_.accountindex.md","mtime":"2018-12-17T11:43:40.837Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T11:44:28.801Z"},"basePath":"../..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.2","depth":1,"next":{"title":"hidden","level":"4.3","depth":1,"path":"types/classes/_address_.address.md","ref":"types/classes/_address_.address.md","articles":[]},"previous":{"title":"hidden","level":"4.1","depth":1,"path":"types/classes/_accountid_.accountid.md","ref":"types/classes/_accountid_.accountid.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"types/classes/_accountindex_.accountindex.md","mtime":"2018-12-17T13:58:50.601Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T13:59:36.621Z"},"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/d11906e/packages/types/src/AccountIndex.ts#L29)*
|
||||
*Defined in [AccountIndex.ts:29](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/AccountIndex.ts#L29)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -46,7 +46,7 @@ getencodedLength(): `number`
|
||||
|
||||
*Inherited from [UInt](_codec_uint_.uint.md).[encodedLength](_codec_uint_.uint.md#encodedlength)*
|
||||
|
||||
*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/UInt.ts#L57)*
|
||||
*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/UInt.ts#L57)*
|
||||
|
||||
*__description__*: The length of the value when encoded as a Uint8Array
|
||||
|
||||
@@ -186,7 +186,7 @@ ___
|
||||
|
||||
*Overrides BN.bitLength*
|
||||
|
||||
*Defined in [codec/UInt.ts:64](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/UInt.ts#L64)*
|
||||
*Defined in [codec/UInt.ts:64](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/UInt.ts#L64)*
|
||||
|
||||
*__description__*: Returns the number of bits in the value
|
||||
|
||||
@@ -1521,7 +1521,7 @@ ___
|
||||
|
||||
*Overrides [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)*
|
||||
|
||||
*Defined in [AccountIndex.ts:92](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/AccountIndex.ts#L92)*
|
||||
*Defined in [AccountIndex.ts:92](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/AccountIndex.ts#L92)*
|
||||
|
||||
*__description__*: Returns the BN representation of the AccountIndex
|
||||
|
||||
@@ -1560,7 +1560,7 @@ ___
|
||||
|
||||
*Overrides [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)*
|
||||
|
||||
*Defined in [AccountIndex.ts:99](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/AccountIndex.ts#L99)*
|
||||
*Defined in [AccountIndex.ts:99](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/AccountIndex.ts#L99)*
|
||||
|
||||
*__description__*: Returns a hex string representation of the value
|
||||
|
||||
@@ -1577,7 +1577,7 @@ ___
|
||||
|
||||
*Overrides [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)*
|
||||
|
||||
*Defined in [AccountIndex.ts:108](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/AccountIndex.ts#L108)*
|
||||
*Defined in [AccountIndex.ts:108](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/AccountIndex.ts#L108)*
|
||||
|
||||
*__description__*: Converts the Object to JSON, typically used for RPC transfers
|
||||
|
||||
@@ -1630,7 +1630,7 @@ ___
|
||||
|
||||
*Overrides [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)*
|
||||
|
||||
*Defined in [AccountIndex.ts:115](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/AccountIndex.ts#L115)*
|
||||
*Defined in [AccountIndex.ts:115](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/AccountIndex.ts#L115)*
|
||||
|
||||
*__description__*: Returns the string representation of the value
|
||||
|
||||
@@ -1668,7 +1668,7 @@ ___
|
||||
|
||||
*Overrides [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)*
|
||||
|
||||
*Defined in [AccountIndex.ts:126](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/AccountIndex.ts#L126)*
|
||||
*Defined in [AccountIndex.ts:126](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/AccountIndex.ts#L126)*
|
||||
|
||||
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
|
||||
|
||||
@@ -1871,7 +1871,7 @@ ___
|
||||
|
||||
▸ **calcLength**(_value: * `BN` | `number`*): `number`
|
||||
|
||||
*Defined in [AccountIndex.ts:52](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/AccountIndex.ts#L52)*
|
||||
*Defined in [AccountIndex.ts:52](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/AccountIndex.ts#L52)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -1888,7 +1888,7 @@ ___
|
||||
|
||||
▸ **decodeAccountIndex**(value: *[AnyNumber](../modules/_types_.md#anynumber)*): `BN` | `Uint8Array` | `number` | `string`
|
||||
|
||||
*Defined in [AccountIndex.ts:36](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/AccountIndex.ts#L36)*
|
||||
*Defined in [AccountIndex.ts:36](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/AccountIndex.ts#L36)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -1907,7 +1907,7 @@ ___
|
||||
|
||||
*Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)*
|
||||
|
||||
*Defined in [codec/UInt.ts:38](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/UInt.ts#L38)*
|
||||
*Defined in [codec/UInt.ts:38](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/UInt.ts#L38)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -2011,7 +2011,7 @@ ___
|
||||
|
||||
▸ **readLength**(input: *`Uint8Array`*): [`number`, `number`]
|
||||
|
||||
*Defined in [AccountIndex.ts:66](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/AccountIndex.ts#L66)*
|
||||
*Defined in [AccountIndex.ts:66](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/AccountIndex.ts#L66)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -2049,7 +2049,7 @@ ___
|
||||
|
||||
▸ **writeLength**(input: *`Uint8Array`*): `Uint8Array`
|
||||
|
||||
*Defined in [AccountIndex.ts:80](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/AccountIndex.ts#L80)*
|
||||
*Defined in [AccountIndex.ts:80](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/AccountIndex.ts#L80)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -1970,7 +1970,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/d11906e/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/5f1178f/packages/types/src/Address.ts#L25" target="_blank">Address.ts:25</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -1994,14 +1994,14 @@
|
||||
<p><a id="encodedlength"></a></p>
|
||||
<h2 id="encodedlength">encodedLength</h2>
|
||||
<p>getencodedLength(): <code>number</code></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/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/5f1178f/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/d11906e/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/5f1178f/packages/types/src/Address.ts#L81" target="_blank">Address.ts:81</a></em></p>
|
||||
<p><em><strong>description</strong></em>: The length of the raw value, either AccountIndex or AccountId</p>
|
||||
<p><strong>Returns:</strong> <code>number</code></p>
|
||||
<hr>
|
||||
@@ -2009,28 +2009,28 @@
|
||||
<p><a id="tohex"></a></p>
|
||||
<h2 id="tohex">toHex</h2>
|
||||
<p>▸ <strong>toHex</strong>(): <code>string</code></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/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/5f1178f/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/d11906e/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/5f1178f/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/d11906e/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/5f1178f/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/d11906e/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/5f1178f/packages/types/src/Address.ts#L112" target="_blank">Address.ts:112</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
@@ -2054,7 +2054,7 @@
|
||||
<p><a id="decodeaddress"></a></p>
|
||||
<h2 id="static-decodeaddress"><code><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/d11906e/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/5f1178f/packages/types/src/Address.ts#L32" target="_blank">Address.ts:32</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -2115,7 +2115,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.3","depth":1,"next":{"title":"hidden","level":"4.4","depth":1,"path":"types/classes/_authorityid_.authorityid.md","ref":"types/classes/_authorityid_.authorityid.md","articles":[]},"previous":{"title":"hidden","level":"4.2","depth":1,"path":"types/classes/_accountindex_.accountindex.md","ref":"types/classes/_accountindex_.accountindex.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"types/classes/_address_.address.md","mtime":"2018-12-17T11:43:40.857Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T11:44:28.801Z"},"basePath":"../..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.3","depth":1,"next":{"title":"hidden","level":"4.4","depth":1,"path":"types/classes/_authorityid_.authorityid.md","ref":"types/classes/_authorityid_.authorityid.md","articles":[]},"previous":{"title":"hidden","level":"4.2","depth":1,"path":"types/classes/_accountindex_.accountindex.md","ref":"types/classes/_accountindex_.accountindex.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"types/classes/_address_.address.md","mtime":"2018-12-17T13:58:50.625Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T13:59:36.621Z"},"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/d11906e/packages/types/src/Address.ts#L25)*
|
||||
*Defined in [Address.ts:25](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/types/src/Address.ts#L67)*
|
||||
*Defined in [Address.ts:67](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/types/src/Address.ts#L81)*
|
||||
*Defined in [Address.ts:81](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/types/src/Address.ts#L90)*
|
||||
*Defined in [Address.ts:90](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/types/src/Address.ts#L97)*
|
||||
*Defined in [Address.ts:97](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/types/src/Address.ts#L104)*
|
||||
*Defined in [Address.ts:104](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/types/src/Address.ts#L112)*
|
||||
*Defined in [Address.ts:112](https://github.com/polkadot-js/api/blob/5f1178f/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/d11906e/packages/types/src/Address.ts#L32)*
|
||||
*Defined in [Address.ts:32](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Address.ts#L32)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -1976,7 +1976,7 @@
|
||||
<p>⊕ <strong>new AuthorityId</strong>(value?: <em><a href="../modules/_types_.md#anyu8a">AnyU8a</a></em>): <a href="_authorityid_.authorityid.html">AuthorityId</a></p>
|
||||
<p><em>Inherited from <a href="_accountid_.accountid.html">AccountId</a>.<a href="_accountid_.accountid.html#constructor">constructor</a></em></p>
|
||||
<p><em>Overrides <a href="_codec_u8afixed_.u8afixed.html">U8aFixed</a>.<a href="_codec_u8afixed_.u8afixed.html#constructor">constructor</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/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/5f1178f/packages/types/src/AccountId.ts#L19" target="_blank">AccountId.ts:19</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -2036,7 +2036,7 @@
|
||||
<h2 id="encodedlength">encodedLength</h2>
|
||||
<p>getencodedLength(): <code>number</code></p>
|
||||
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#encodedlength">encodedLength</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/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/5f1178f/packages/types/src/codec/U8a.ts#L36" target="_blank">codec/U8a.ts:36</a></em></p>
|
||||
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
|
||||
<p><strong>Returns:</strong> <code>number</code></p>
|
||||
<hr>
|
||||
@@ -2045,7 +2045,7 @@
|
||||
<p>getlength(): <code>number</code></p>
|
||||
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#length">length</a></em></p>
|
||||
<p><em>Overrides Uint8Array.length</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/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/5f1178f/packages/types/src/codec/U8a.ts#L43" target="_blank">codec/U8a.ts:43</a></em></p>
|
||||
<p><em><strong>description</strong></em>: The length of the value</p>
|
||||
<p><strong>Returns:</strong> <code>number</code></p>
|
||||
<hr>
|
||||
@@ -2061,7 +2061,7 @@
|
||||
<h2 id="bitlength">bitLength</h2>
|
||||
<p>▸ <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/d11906e/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/5f1178f/packages/types/src/codec/U8aFixed.ts#L39" target="_blank">codec/U8aFixed.ts:39</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Returns the number of bits in the value</p>
|
||||
<p><strong>Returns:</strong> <code>number</code></p>
|
||||
<hr>
|
||||
@@ -2728,7 +2728,7 @@
|
||||
<p>▸ <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/d11906e/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/5f1178f/packages/types/src/codec/U8a.ts#L53" target="_blank">codec/U8a.ts:53</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here</p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
@@ -2759,7 +2759,7 @@
|
||||
<p>▸ <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/d11906e/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/5f1178f/packages/types/src/codec/U8a.ts#L60" target="_blank">codec/U8a.ts:60</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
|
||||
<p><strong>Returns:</strong> <code>string</code></p>
|
||||
<hr>
|
||||
@@ -2769,7 +2769,7 @@
|
||||
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
|
||||
<p><em>Inherited from <a href="_accountid_.accountid.html">AccountId</a>.<a href="_accountid_.accountid.html#tojson">toJSON</a></em></p>
|
||||
<p><em>Overrides <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#tojson">toJSON</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/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/5f1178f/packages/types/src/AccountId.ts#L46" target="_blank">AccountId.ts:46</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
|
||||
<p><strong>Returns:</strong> <code>any</code></p>
|
||||
<hr>
|
||||
@@ -2787,7 +2787,7 @@
|
||||
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
|
||||
<p><em>Inherited from <a href="_accountid_.accountid.html">AccountId</a>.<a href="_accountid_.accountid.html#tostring">toString</a></em></p>
|
||||
<p><em>Overrides <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#tostring">toString</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/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/5f1178f/packages/types/src/AccountId.ts#L53" target="_blank">AccountId.ts:53</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
|
||||
<p><strong>Returns:</strong> <code>string</code></p>
|
||||
<hr>
|
||||
@@ -2795,7 +2795,7 @@
|
||||
<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/d11906e/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/5f1178f/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>
|
||||
@@ -2828,7 +2828,7 @@
|
||||
<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>Inherited from <a href="_accountid_.accountid.html">AccountId</a>.<a href="_accountid_.accountid.html#encode">encode</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/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/5f1178f/packages/types/src/AccountId.ts#L27" target="_blank">AccountId.ts:27</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -2889,7 +2889,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.4","depth":1,"next":{"title":"hidden","level":"4.5","depth":1,"path":"types/classes/_balance_.balance.md","ref":"types/classes/_balance_.balance.md","articles":[]},"previous":{"title":"hidden","level":"4.3","depth":1,"path":"types/classes/_address_.address.md","ref":"types/classes/_address_.address.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"types/classes/_authorityid_.authorityid.md","mtime":"2018-12-17T11:43:41.041Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T11:44:28.801Z"},"basePath":"../..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.4","depth":1,"next":{"title":"hidden","level":"4.5","depth":1,"path":"types/classes/_balance_.balance.md","ref":"types/classes/_balance_.balance.md","articles":[]},"previous":{"title":"hidden","level":"4.3","depth":1,"path":"types/classes/_address_.address.md","ref":"types/classes/_address_.address.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"types/classes/_authorityid_.authorityid.md","mtime":"2018-12-17T13:58:50.797Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T13:59:36.621Z"},"basePath":"../..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -27,7 +27,7 @@
|
||||
|
||||
*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)*
|
||||
|
||||
*Defined in [AccountId.ts:19](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/AccountId.ts#L19)*
|
||||
*Defined in [AccountId.ts:19](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/AccountId.ts#L19)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -115,7 +115,7 @@ getencodedLength(): `number`
|
||||
|
||||
*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)*
|
||||
|
||||
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/U8a.ts#L36)*
|
||||
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/U8a.ts#L36)*
|
||||
|
||||
*__description__*: The length of the value when encoded as a Uint8Array
|
||||
|
||||
@@ -132,7 +132,7 @@ getlength(): `number`
|
||||
|
||||
*Overrides Uint8Array.length*
|
||||
|
||||
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/U8a.ts#L43)*
|
||||
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/U8a.ts#L43)*
|
||||
|
||||
*__description__*: The length of the value
|
||||
|
||||
@@ -163,7 +163,7 @@ ___
|
||||
|
||||
*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)*
|
||||
|
||||
*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/U8aFixed.ts#L39)*
|
||||
*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/U8aFixed.ts#L39)*
|
||||
|
||||
*__description__*: Returns the number of bits in the value
|
||||
|
||||
@@ -689,7 +689,7 @@ ___
|
||||
|
||||
*Overrides Uint8Array.subarray*
|
||||
|
||||
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/U8a.ts#L53)*
|
||||
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/U8a.ts#L53)*
|
||||
|
||||
*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here
|
||||
|
||||
@@ -713,7 +713,7 @@ ___
|
||||
|
||||
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
|
||||
|
||||
*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/U8a.ts#L60)*
|
||||
*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/U8a.ts#L60)*
|
||||
|
||||
*__description__*: Returns a hex string representation of the value
|
||||
|
||||
@@ -732,7 +732,7 @@ ___
|
||||
|
||||
*Overrides [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
|
||||
|
||||
*Defined in [AccountId.ts:46](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/AccountId.ts#L46)*
|
||||
*Defined in [AccountId.ts:46](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/AccountId.ts#L46)*
|
||||
|
||||
*__description__*: Converts the Object to JSON, typically used for RPC transfers
|
||||
|
||||
@@ -766,7 +766,7 @@ ___
|
||||
|
||||
*Overrides [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)*
|
||||
|
||||
*Defined in [AccountId.ts:53](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/AccountId.ts#L53)*
|
||||
*Defined in [AccountId.ts:53](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/AccountId.ts#L53)*
|
||||
|
||||
*__description__*: Returns the string representation of the value
|
||||
|
||||
@@ -781,7 +781,7 @@ ___
|
||||
|
||||
*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
|
||||
|
||||
*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/U8a.ts#L82)*
|
||||
*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/U8a.ts#L82)*
|
||||
|
||||
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
|
||||
|
||||
@@ -817,7 +817,7 @@ ___
|
||||
|
||||
*Inherited from [AccountId](_accountid_.accountid.md).[encode](_accountid_.accountid.md#encode)*
|
||||
|
||||
*Defined in [AccountId.ts:27](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/AccountId.ts#L27)*
|
||||
*Defined in [AccountId.ts:27](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/AccountId.ts#L27)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -1975,7 +1975,7 @@
|
||||
<p>⊕ <strong>new Balance</strong>(value?: <em><a href="../modules/_types_.md#anynumber">AnyNumber</a></em>): <a href="_balance_.balance.html">Balance</a></p>
|
||||
<p><em>Inherited from <a href="_u128_.u128.html">U128</a>.<a href="_u128_.u128.html#constructor">constructor</a></em></p>
|
||||
<p><em>Overrides <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#constructor">constructor</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/U128.ts#L14" target="_blank">U128.ts:14</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/U128.ts#L14" target="_blank">U128.ts:14</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -1998,7 +1998,7 @@
|
||||
<h2 id="encodedlength">encodedLength</h2>
|
||||
<p>getencodedLength(): <code>number</code></p>
|
||||
<p><em>Inherited from <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#encodedlength">encodedLength</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/UInt.ts#L57" target="_blank">codec/UInt.ts:57</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/UInt.ts#L57" target="_blank">codec/UInt.ts:57</a></em></p>
|
||||
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
|
||||
<p><strong>Returns:</strong> <code>number</code></p>
|
||||
<hr>
|
||||
@@ -2131,7 +2131,7 @@
|
||||
<p>▸ <strong>bitLength</strong>(): <a href="../modules/_codec_uint_.md#uintbitlength">UIntBitLength</a></p>
|
||||
<p><em>Inherited from <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#bitlength">bitLength</a></em></p>
|
||||
<p><em>Overrides BN.bitLength</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/UInt.ts#L64" target="_blank">codec/UInt.ts:64</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/UInt.ts#L64" target="_blank">codec/UInt.ts:64</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Returns the number of bits in the value</p>
|
||||
<p><strong>Returns:</strong> <a href="../modules/_codec_uint_.md#uintbitlength">UIntBitLength</a></p>
|
||||
<hr>
|
||||
@@ -3509,7 +3509,7 @@
|
||||
<h2 id="tobn">toBn</h2>
|
||||
<p>▸ <strong>toBn</strong>(): <code>BN</code></p>
|
||||
<p><em>Inherited from <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#tobn">toBn</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/UInt.ts#L71" target="_blank">codec/UInt.ts:71</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/UInt.ts#L71" target="_blank">codec/UInt.ts:71</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Returns the BN representation of the number. (Compatibility)</p>
|
||||
<p><strong>Returns:</strong> <code>BN</code></p>
|
||||
<hr>
|
||||
@@ -3545,7 +3545,7 @@
|
||||
<p>▸ <strong>toHex</strong>(): <code>string</code></p>
|
||||
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
|
||||
<p><em>Inherited from <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#tohex">toHex</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/UInt.ts#L78" target="_blank">codec/UInt.ts:78</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/UInt.ts#L78" target="_blank">codec/UInt.ts:78</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
|
||||
<p><strong>Returns:</strong> <code>string</code></p>
|
||||
<hr>
|
||||
@@ -3555,7 +3555,7 @@
|
||||
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
|
||||
<p><em>Inherited from <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#tojson">toJSON</a></em></p>
|
||||
<p><em>Overrides BN.toJSON</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/UInt.ts#L85" target="_blank">codec/UInt.ts:85</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/UInt.ts#L85" target="_blank">codec/UInt.ts:85</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
|
||||
<p><strong>Returns:</strong> <code>any</code></p>
|
||||
<hr>
|
||||
@@ -3595,7 +3595,7 @@
|
||||
<p>▸ <strong>toString</strong>(base?: <em> <code>undefined</code> | <code>number</code></em>): <code>string</code></p>
|
||||
<p><em>Inherited from <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#tostring">toString</a></em></p>
|
||||
<p><em>Overrides BN.toString</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/UInt.ts#L95" target="_blank">codec/UInt.ts:95</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/UInt.ts#L95" target="_blank">codec/UInt.ts:95</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
@@ -3643,7 +3643,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_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/d11906e/packages/types/src/codec/UInt.ts#L104" target="_blank">codec/UInt.ts:104</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/UInt.ts#L104" target="_blank">codec/UInt.ts:104</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
@@ -3860,7 +3860,7 @@
|
||||
<h2 id="static-decodeuint"><code><Static></code> decodeUInt</h2>
|
||||
<p>▸ <strong>decodeUInt</strong>(value: <em><a href="../modules/_types_.md#anynumber">AnyNumber</a></em>, bitLength: <em><a href="../modules/_codec_uint_.md#uintbitlength">UIntBitLength</a></em>): <code>string</code></p>
|
||||
<p><em>Inherited from <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#decodeuint">decodeUInt</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/UInt.ts#L38" target="_blank">codec/UInt.ts:38</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/UInt.ts#L38" target="_blank">codec/UInt.ts:38</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -4048,7 +4048,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.5","depth":1,"next":{"title":"hidden","level":"4.6","depth":1,"path":"types/classes/_bft_.bftauthoritysignature.md","ref":"types/classes/_bft_.bftauthoritysignature.md","articles":[]},"previous":{"title":"hidden","level":"4.4","depth":1,"path":"types/classes/_authorityid_.authorityid.md","ref":"types/classes/_authorityid_.authorityid.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"types/classes/_balance_.balance.md","mtime":"2018-12-17T11:43:41.277Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T11:44:28.801Z"},"basePath":"../..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.5","depth":1,"next":{"title":"hidden","level":"4.6","depth":1,"path":"types/classes/_bft_.bftauthoritysignature.md","ref":"types/classes/_bft_.bftauthoritysignature.md","articles":[]},"previous":{"title":"hidden","level":"4.4","depth":1,"path":"types/classes/_authorityid_.authorityid.md","ref":"types/classes/_authorityid_.authorityid.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"types/classes/_balance_.balance.md","mtime":"2018-12-17T13:58:51.037Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T13:59:36.621Z"},"basePath":"../..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -26,7 +26,7 @@
|
||||
|
||||
*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)*
|
||||
|
||||
*Defined in [U128.ts:14](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/U128.ts#L14)*
|
||||
*Defined in [U128.ts:14](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/U128.ts#L14)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -48,7 +48,7 @@ getencodedLength(): `number`
|
||||
|
||||
*Inherited from [UInt](_codec_uint_.uint.md).[encodedLength](_codec_uint_.uint.md#encodedlength)*
|
||||
|
||||
*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/UInt.ts#L57)*
|
||||
*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/UInt.ts#L57)*
|
||||
|
||||
*__description__*: The length of the value when encoded as a Uint8Array
|
||||
|
||||
@@ -188,7 +188,7 @@ ___
|
||||
|
||||
*Overrides BN.bitLength*
|
||||
|
||||
*Defined in [codec/UInt.ts:64](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/UInt.ts#L64)*
|
||||
*Defined in [codec/UInt.ts:64](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/UInt.ts#L64)*
|
||||
|
||||
*__description__*: Returns the number of bits in the value
|
||||
|
||||
@@ -1523,7 +1523,7 @@ ___
|
||||
|
||||
*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)*
|
||||
|
||||
*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/UInt.ts#L71)*
|
||||
*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/UInt.ts#L71)*
|
||||
|
||||
*__description__*: Returns the BN representation of the number. (Compatibility)
|
||||
|
||||
@@ -1562,7 +1562,7 @@ ___
|
||||
|
||||
*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)*
|
||||
|
||||
*Defined in [codec/UInt.ts:78](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/UInt.ts#L78)*
|
||||
*Defined in [codec/UInt.ts:78](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/UInt.ts#L78)*
|
||||
|
||||
*__description__*: Returns a hex string representation of the value
|
||||
|
||||
@@ -1581,7 +1581,7 @@ ___
|
||||
|
||||
*Overrides BN.toJSON*
|
||||
|
||||
*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/UInt.ts#L85)*
|
||||
*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/UInt.ts#L85)*
|
||||
|
||||
*__description__*: Converts the Object to JSON, typically used for RPC transfers
|
||||
|
||||
@@ -1634,7 +1634,7 @@ ___
|
||||
|
||||
*Overrides BN.toString*
|
||||
|
||||
*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/UInt.ts#L95)*
|
||||
*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/UInt.ts#L95)*
|
||||
|
||||
*__description__*: Returns the string representation of the value
|
||||
|
||||
@@ -1676,7 +1676,7 @@ ___
|
||||
|
||||
*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)*
|
||||
|
||||
*Defined in [codec/UInt.ts:104](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/UInt.ts#L104)*
|
||||
*Defined in [codec/UInt.ts:104](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/UInt.ts#L104)*
|
||||
|
||||
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
|
||||
|
||||
@@ -1880,7 +1880,7 @@ ___
|
||||
|
||||
*Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)*
|
||||
|
||||
*Defined in [codec/UInt.ts:38](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/UInt.ts#L38)*
|
||||
*Defined in [codec/UInt.ts:38](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/UInt.ts#L38)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -1978,7 +1978,7 @@
|
||||
<h2 id="constructor">constructor</h2>
|
||||
<p>⊕ <strong>new BftAuthoritySignature</strong>(value?: <em> <a href="../modules/_bft_.md#bftauthoritysignaturevalue">BftAuthoritySignatureValue</a> | <code>Uint8Array</code></em>): <a href="_bft_.bftauthoritysignature.html">BftAuthoritySignature</a></p>
|
||||
<p><em>Overrides <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#constructor">constructor</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Bft.ts#L20" target="_blank">Bft.ts:20</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Bft.ts#L20" target="_blank">Bft.ts:20</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -2009,14 +2009,14 @@
|
||||
<h2 id="types">Types</h2>
|
||||
<p>getTypes(): <code>Array</code><<code>string</code>></p>
|
||||
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#types">Types</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Tuple.ts#L75" target="_blank">codec/Tuple.ts:75</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Tuple.ts#L75" target="_blank">codec/Tuple.ts:75</a></em></p>
|
||||
<p><em><strong>description</strong></em>: The types definition of the tuple</p>
|
||||
<p><strong>Returns:</strong> <code>Array</code><<code>string</code>></p>
|
||||
<hr>
|
||||
<p><a id="authorityid"></a></p>
|
||||
<h2 id="authorityid">authorityId</h2>
|
||||
<p>getauthorityId(): <a href="_authorityid_.authorityid.html">AuthorityId</a></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Bft.ts#L31" target="_blank">Bft.ts:31</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Bft.ts#L31" target="_blank">Bft.ts:31</a></em></p>
|
||||
<p><em><strong>description</strong></em>: The wrapped [[AuthoriyId]]</p>
|
||||
<p><strong>Returns:</strong> <a href="_authorityid_.authorityid.html">AuthorityId</a></p>
|
||||
<hr>
|
||||
@@ -2024,14 +2024,14 @@
|
||||
<h2 id="encodedlength">encodedLength</h2>
|
||||
<p>getencodedLength(): <code>number</code></p>
|
||||
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#encodedlength">encodedLength</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Tuple.ts#L66" target="_blank">codec/Tuple.ts:66</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Tuple.ts#L66" target="_blank">codec/Tuple.ts:66</a></em></p>
|
||||
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
|
||||
<p><strong>Returns:</strong> <code>number</code></p>
|
||||
<hr>
|
||||
<p><a id="signature"></a></p>
|
||||
<h2 id="signature">signature</h2>
|
||||
<p>getsignature(): <a href="_signature_.signature.html">Signature</a></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Bft.ts#L38" target="_blank">Bft.ts:38</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Bft.ts#L38" target="_blank">Bft.ts:38</a></em></p>
|
||||
<p><em><strong>description</strong></em>: The wrapped <a href="_signature_.signature.html">Signature</a> value</p>
|
||||
<p><strong>Returns:</strong> <a href="_signature_.signature.html">Signature</a></p>
|
||||
<hr>
|
||||
@@ -2212,7 +2212,7 @@
|
||||
<p>▸ <strong>filter</strong>(callbackfn: <em><code>function</code></em>, thisArg?: <em><code>any</code></em>): <code>Array</code><<a href="../interfaces/_types_.codec.md">Codec</a>></p>
|
||||
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#filter">filter</a></em></p>
|
||||
<p><em>Overrides Array.filter</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Tuple.ts#L131" target="_blank">codec/Tuple.ts:131</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Tuple.ts#L131" target="_blank">codec/Tuple.ts:131</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Filters the array with the callback</p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
@@ -2765,7 +2765,7 @@
|
||||
<p>▸ <strong>map</strong><<code>U</code>>(callbackfn: <em><code>function</code></em>, thisArg?: <em><code>any</code></em>): <code>Array</code><<code>U</code>></p>
|
||||
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#map">map</a></em></p>
|
||||
<p><em>Overrides Array.map</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Tuple.ts#L140" target="_blank">codec/Tuple.ts:140</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Tuple.ts#L140" target="_blank">codec/Tuple.ts:140</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Maps the array with the callback</p>
|
||||
<p><strong>Type parameters:</strong></p>
|
||||
<h4 id="u">U</h4>
|
||||
@@ -3147,7 +3147,7 @@
|
||||
<h2 id="toarray">toArray</h2>
|
||||
<p>▸ <strong>toArray</strong>(): <code>Array</code><<a href="../interfaces/_types_.codec.md">Codec</a>></p>
|
||||
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#toarray">toArray</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Tuple.ts#L82" target="_blank">codec/Tuple.ts:82</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Tuple.ts#L82" target="_blank">codec/Tuple.ts:82</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Converts the Object to an standard JavaScript Array</p>
|
||||
<p><strong>Returns:</strong> <code>Array</code><<a href="../interfaces/_types_.codec.md">Codec</a>></p>
|
||||
<hr>
|
||||
@@ -3156,7 +3156,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_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#tohex">toHex</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Tuple.ts#L89" target="_blank">codec/Tuple.ts:89</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Tuple.ts#L89" target="_blank">codec/Tuple.ts:89</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
|
||||
<p><strong>Returns:</strong> <code>string</code></p>
|
||||
<hr>
|
||||
@@ -3165,7 +3165,7 @@
|
||||
<p>▸ <strong>toJSON</strong>(): <code>any</code></p>
|
||||
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
|
||||
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#tojson">toJSON</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Tuple.ts#L96" target="_blank">codec/Tuple.ts:96</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Tuple.ts#L96" target="_blank">codec/Tuple.ts:96</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
|
||||
<p><strong>Returns:</strong> <code>any</code></p>
|
||||
<hr>
|
||||
@@ -3183,7 +3183,7 @@
|
||||
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
|
||||
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#tostring">toString</a></em></p>
|
||||
<p><em>Overrides Array.toString</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Tuple.ts#L105" target="_blank">codec/Tuple.ts:105</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Tuple.ts#L105" target="_blank">codec/Tuple.ts:105</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
|
||||
<p><strong>Returns:</strong> <code>string</code></p>
|
||||
<hr>
|
||||
@@ -3191,7 +3191,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_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#tou8a">toU8a</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Tuple.ts#L114" target="_blank">codec/Tuple.ts:114</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Tuple.ts#L114" target="_blank">codec/Tuple.ts:114</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
@@ -3249,7 +3249,7 @@
|
||||
<h2 id="static-with"><code><Static></code> with</h2>
|
||||
<p>▸ <strong>with</strong><<code>S</code>>(Types: <em><code>S</code></em>): <a href="../modules/_types_.md#constructor">Constructor</a><<a href="_codec_tuple_.tuple.html">Tuple</a><<code>S</code>>></p>
|
||||
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#with">with</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Tuple.ts#L53" target="_blank">codec/Tuple.ts:53</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Tuple.ts#L53" target="_blank">codec/Tuple.ts:53</a></em></p>
|
||||
<p><strong>Type parameters:</strong></p>
|
||||
<h4 id="s---arrayconstructor">S : <code>Array</code><<a href="../modules/_types_.md#constructor">Constructor</a>></h4>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
@@ -3312,7 +3312,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.6","depth":1,"next":{"title":"hidden","level":"4.7","depth":1,"path":"types/classes/_bft_.bfthashsignature.md","ref":"types/classes/_bft_.bfthashsignature.md","articles":[]},"previous":{"title":"hidden","level":"4.5","depth":1,"path":"types/classes/_balance_.balance.md","ref":"types/classes/_balance_.balance.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"types/classes/_bft_.bftauthoritysignature.md","mtime":"2018-12-17T11:43:41.533Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T11:44:28.801Z"},"basePath":"../..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.6","depth":1,"next":{"title":"hidden","level":"4.7","depth":1,"path":"types/classes/_bft_.bfthashsignature.md","ref":"types/classes/_bft_.bfthashsignature.md","articles":[]},"previous":{"title":"hidden","level":"4.5","depth":1,"path":"types/classes/_balance_.balance.md","ref":"types/classes/_balance_.balance.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"types/classes/_bft_.bftauthoritysignature.md","mtime":"2018-12-17T13:58:51.297Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T13:59:36.621Z"},"basePath":"../..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -29,7 +29,7 @@
|
||||
|
||||
*Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)*
|
||||
|
||||
*Defined in [Bft.ts:20](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Bft.ts#L20)*
|
||||
*Defined in [Bft.ts:20](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Bft.ts#L20)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -67,7 +67,7 @@ getTypes(): `Array`<`string`>
|
||||
|
||||
*Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)*
|
||||
|
||||
*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Tuple.ts#L75)*
|
||||
*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Tuple.ts#L75)*
|
||||
|
||||
*__description__*: The types definition of the tuple
|
||||
|
||||
@@ -80,7 +80,7 @@ ___
|
||||
|
||||
getauthorityId(): [AuthorityId](_authorityid_.authorityid.md)
|
||||
|
||||
*Defined in [Bft.ts:31](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Bft.ts#L31)*
|
||||
*Defined in [Bft.ts:31](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Bft.ts#L31)*
|
||||
|
||||
*__description__*: The wrapped \[\[AuthoriyId\]\]
|
||||
|
||||
@@ -95,7 +95,7 @@ getencodedLength(): `number`
|
||||
|
||||
*Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)*
|
||||
|
||||
*Defined in [codec/Tuple.ts:66](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Tuple.ts#L66)*
|
||||
*Defined in [codec/Tuple.ts:66](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Tuple.ts#L66)*
|
||||
|
||||
*__description__*: The length of the value when encoded as a Uint8Array
|
||||
|
||||
@@ -108,7 +108,7 @@ ___
|
||||
|
||||
getsignature(): [Signature](_signature_.signature.md)
|
||||
|
||||
*Defined in [Bft.ts:38](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Bft.ts#L38)*
|
||||
*Defined in [Bft.ts:38](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Bft.ts#L38)*
|
||||
|
||||
*__description__*: The wrapped [Signature](_signature_.signature.md) value
|
||||
|
||||
@@ -278,7 +278,7 @@ ___
|
||||
|
||||
*Overrides Array.filter*
|
||||
|
||||
*Defined in [codec/Tuple.ts:131](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Tuple.ts#L131)*
|
||||
*Defined in [codec/Tuple.ts:131](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Tuple.ts#L131)*
|
||||
|
||||
*__description__*: Filters the array with the callback
|
||||
|
||||
@@ -698,7 +698,7 @@ ___
|
||||
|
||||
*Overrides Array.map*
|
||||
|
||||
*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Tuple.ts#L140)*
|
||||
*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Tuple.ts#L140)*
|
||||
|
||||
*__description__*: Maps the array with the callback
|
||||
|
||||
@@ -1006,7 +1006,7 @@ ___
|
||||
|
||||
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)*
|
||||
|
||||
*Defined in [codec/Tuple.ts:82](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Tuple.ts#L82)*
|
||||
*Defined in [codec/Tuple.ts:82](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Tuple.ts#L82)*
|
||||
|
||||
*__description__*: Converts the Object to an standard JavaScript Array
|
||||
|
||||
@@ -1023,7 +1023,7 @@ ___
|
||||
|
||||
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)*
|
||||
|
||||
*Defined in [codec/Tuple.ts:89](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Tuple.ts#L89)*
|
||||
*Defined in [codec/Tuple.ts:89](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Tuple.ts#L89)*
|
||||
|
||||
*__description__*: Returns a hex string representation of the value
|
||||
|
||||
@@ -1040,7 +1040,7 @@ ___
|
||||
|
||||
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)*
|
||||
|
||||
*Defined in [codec/Tuple.ts:96](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Tuple.ts#L96)*
|
||||
*Defined in [codec/Tuple.ts:96](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Tuple.ts#L96)*
|
||||
|
||||
*__description__*: Converts the Object to JSON, typically used for RPC transfers
|
||||
|
||||
@@ -1074,7 +1074,7 @@ ___
|
||||
|
||||
*Overrides Array.toString*
|
||||
|
||||
*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Tuple.ts#L105)*
|
||||
*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Tuple.ts#L105)*
|
||||
|
||||
*__description__*: Returns the string representation of the value
|
||||
|
||||
@@ -1089,7 +1089,7 @@ ___
|
||||
|
||||
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)*
|
||||
|
||||
*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Tuple.ts#L114)*
|
||||
*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Tuple.ts#L114)*
|
||||
|
||||
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
|
||||
|
||||
@@ -1146,7 +1146,7 @@ ___
|
||||
|
||||
*Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)*
|
||||
|
||||
*Defined in [codec/Tuple.ts:53](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Tuple.ts#L53)*
|
||||
*Defined in [codec/Tuple.ts:53](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Tuple.ts#L53)*
|
||||
|
||||
**Type parameters:**
|
||||
|
||||
|
||||
@@ -1978,7 +1978,7 @@
|
||||
<h2 id="constructor">constructor</h2>
|
||||
<p>⊕ <strong>new BftHashSignature</strong>(value?: <em> <a href="../modules/_bft_.md#bfthashsignaturevalue">BftHashSignatureValue</a> | <code>Uint8Array</code></em>): <a href="_bft_.bfthashsignature.html">BftHashSignature</a></p>
|
||||
<p><em>Overrides <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#constructor">constructor</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Bft.ts#L51" target="_blank">Bft.ts:51</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Bft.ts#L51" target="_blank">Bft.ts:51</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -2009,7 +2009,7 @@
|
||||
<h2 id="types">Types</h2>
|
||||
<p>getTypes(): <code>Array</code><<code>string</code>></p>
|
||||
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#types">Types</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Tuple.ts#L75" target="_blank">codec/Tuple.ts:75</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Tuple.ts#L75" target="_blank">codec/Tuple.ts:75</a></em></p>
|
||||
<p><em><strong>description</strong></em>: The types definition of the tuple</p>
|
||||
<p><strong>Returns:</strong> <code>Array</code><<code>string</code>></p>
|
||||
<hr>
|
||||
@@ -2017,21 +2017,21 @@
|
||||
<h2 id="encodedlength">encodedLength</h2>
|
||||
<p>getencodedLength(): <code>number</code></p>
|
||||
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#encodedlength">encodedLength</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Tuple.ts#L66" target="_blank">codec/Tuple.ts:66</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Tuple.ts#L66" target="_blank">codec/Tuple.ts:66</a></em></p>
|
||||
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
|
||||
<p><strong>Returns:</strong> <code>number</code></p>
|
||||
<hr>
|
||||
<p><a id="hash"></a></p>
|
||||
<h2 id="hash">hash</h2>
|
||||
<p>gethash(): <a href="_hash_.hash.html">Hash</a></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Bft.ts#L62" target="_blank">Bft.ts:62</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Bft.ts#L62" target="_blank">Bft.ts:62</a></em></p>
|
||||
<p><em><strong>description</strong></em>: The wrapped <a href="_hash_.hash.html">Hash</a></p>
|
||||
<p><strong>Returns:</strong> <a href="_hash_.hash.html">Hash</a></p>
|
||||
<hr>
|
||||
<p><a id="signature"></a></p>
|
||||
<h2 id="signature">signature</h2>
|
||||
<p>getsignature(): <a href="_signature_.signature.html">Signature</a></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Bft.ts#L69" target="_blank">Bft.ts:69</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Bft.ts#L69" target="_blank">Bft.ts:69</a></em></p>
|
||||
<p><em><strong>description</strong></em>: The wrapped <a href="_signature_.signature.html">Signature</a></p>
|
||||
<p><strong>Returns:</strong> <a href="_signature_.signature.html">Signature</a></p>
|
||||
<hr>
|
||||
@@ -2212,7 +2212,7 @@
|
||||
<p>▸ <strong>filter</strong>(callbackfn: <em><code>function</code></em>, thisArg?: <em><code>any</code></em>): <code>Array</code><<a href="../interfaces/_types_.codec.md">Codec</a>></p>
|
||||
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#filter">filter</a></em></p>
|
||||
<p><em>Overrides Array.filter</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Tuple.ts#L131" target="_blank">codec/Tuple.ts:131</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Tuple.ts#L131" target="_blank">codec/Tuple.ts:131</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Filters the array with the callback</p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
@@ -2765,7 +2765,7 @@
|
||||
<p>▸ <strong>map</strong><<code>U</code>>(callbackfn: <em><code>function</code></em>, thisArg?: <em><code>any</code></em>): <code>Array</code><<code>U</code>></p>
|
||||
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#map">map</a></em></p>
|
||||
<p><em>Overrides Array.map</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Tuple.ts#L140" target="_blank">codec/Tuple.ts:140</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Tuple.ts#L140" target="_blank">codec/Tuple.ts:140</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Maps the array with the callback</p>
|
||||
<p><strong>Type parameters:</strong></p>
|
||||
<h4 id="u">U</h4>
|
||||
@@ -3147,7 +3147,7 @@
|
||||
<h2 id="toarray">toArray</h2>
|
||||
<p>▸ <strong>toArray</strong>(): <code>Array</code><<a href="../interfaces/_types_.codec.md">Codec</a>></p>
|
||||
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#toarray">toArray</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Tuple.ts#L82" target="_blank">codec/Tuple.ts:82</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Tuple.ts#L82" target="_blank">codec/Tuple.ts:82</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Converts the Object to an standard JavaScript Array</p>
|
||||
<p><strong>Returns:</strong> <code>Array</code><<a href="../interfaces/_types_.codec.md">Codec</a>></p>
|
||||
<hr>
|
||||
@@ -3156,7 +3156,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_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#tohex">toHex</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Tuple.ts#L89" target="_blank">codec/Tuple.ts:89</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Tuple.ts#L89" target="_blank">codec/Tuple.ts:89</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
|
||||
<p><strong>Returns:</strong> <code>string</code></p>
|
||||
<hr>
|
||||
@@ -3165,7 +3165,7 @@
|
||||
<p>▸ <strong>toJSON</strong>(): <code>any</code></p>
|
||||
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
|
||||
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#tojson">toJSON</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Tuple.ts#L96" target="_blank">codec/Tuple.ts:96</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Tuple.ts#L96" target="_blank">codec/Tuple.ts:96</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
|
||||
<p><strong>Returns:</strong> <code>any</code></p>
|
||||
<hr>
|
||||
@@ -3183,7 +3183,7 @@
|
||||
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
|
||||
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#tostring">toString</a></em></p>
|
||||
<p><em>Overrides Array.toString</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Tuple.ts#L105" target="_blank">codec/Tuple.ts:105</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Tuple.ts#L105" target="_blank">codec/Tuple.ts:105</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
|
||||
<p><strong>Returns:</strong> <code>string</code></p>
|
||||
<hr>
|
||||
@@ -3191,7 +3191,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_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#tou8a">toU8a</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Tuple.ts#L114" target="_blank">codec/Tuple.ts:114</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Tuple.ts#L114" target="_blank">codec/Tuple.ts:114</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
@@ -3249,7 +3249,7 @@
|
||||
<h2 id="static-with"><code><Static></code> with</h2>
|
||||
<p>▸ <strong>with</strong><<code>S</code>>(Types: <em><code>S</code></em>): <a href="../modules/_types_.md#constructor">Constructor</a><<a href="_codec_tuple_.tuple.html">Tuple</a><<code>S</code>>></p>
|
||||
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#with">with</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Tuple.ts#L53" target="_blank">codec/Tuple.ts:53</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Tuple.ts#L53" target="_blank">codec/Tuple.ts:53</a></em></p>
|
||||
<p><strong>Type parameters:</strong></p>
|
||||
<h4 id="s---arrayconstructor">S : <code>Array</code><<a href="../modules/_types_.md#constructor">Constructor</a>></h4>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
@@ -3312,7 +3312,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.7","depth":1,"next":{"title":"hidden","level":"4.8","depth":1,"path":"types/classes/_block_.block.md","ref":"types/classes/_block_.block.md","articles":[]},"previous":{"title":"hidden","level":"4.6","depth":1,"path":"types/classes/_bft_.bftauthoritysignature.md","ref":"types/classes/_bft_.bftauthoritysignature.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"types/classes/_bft_.bfthashsignature.md","mtime":"2018-12-17T11:43:41.797Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T11:44:28.801Z"},"basePath":"../..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.7","depth":1,"next":{"title":"hidden","level":"4.8","depth":1,"path":"types/classes/_block_.block.md","ref":"types/classes/_block_.block.md","articles":[]},"previous":{"title":"hidden","level":"4.6","depth":1,"path":"types/classes/_bft_.bftauthoritysignature.md","ref":"types/classes/_bft_.bftauthoritysignature.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"types/classes/_bft_.bfthashsignature.md","mtime":"2018-12-17T13:58:51.553Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T13:59:36.621Z"},"basePath":"../..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -29,7 +29,7 @@
|
||||
|
||||
*Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)*
|
||||
|
||||
*Defined in [Bft.ts:51](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Bft.ts#L51)*
|
||||
*Defined in [Bft.ts:51](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Bft.ts#L51)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -67,7 +67,7 @@ getTypes(): `Array`<`string`>
|
||||
|
||||
*Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)*
|
||||
|
||||
*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Tuple.ts#L75)*
|
||||
*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Tuple.ts#L75)*
|
||||
|
||||
*__description__*: The types definition of the tuple
|
||||
|
||||
@@ -82,7 +82,7 @@ getencodedLength(): `number`
|
||||
|
||||
*Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)*
|
||||
|
||||
*Defined in [codec/Tuple.ts:66](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Tuple.ts#L66)*
|
||||
*Defined in [codec/Tuple.ts:66](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Tuple.ts#L66)*
|
||||
|
||||
*__description__*: The length of the value when encoded as a Uint8Array
|
||||
|
||||
@@ -95,7 +95,7 @@ ___
|
||||
|
||||
gethash(): [Hash](_hash_.hash.md)
|
||||
|
||||
*Defined in [Bft.ts:62](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Bft.ts#L62)*
|
||||
*Defined in [Bft.ts:62](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Bft.ts#L62)*
|
||||
|
||||
*__description__*: The wrapped [Hash](_hash_.hash.md)
|
||||
|
||||
@@ -108,7 +108,7 @@ ___
|
||||
|
||||
getsignature(): [Signature](_signature_.signature.md)
|
||||
|
||||
*Defined in [Bft.ts:69](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Bft.ts#L69)*
|
||||
*Defined in [Bft.ts:69](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Bft.ts#L69)*
|
||||
|
||||
*__description__*: The wrapped [Signature](_signature_.signature.md)
|
||||
|
||||
@@ -278,7 +278,7 @@ ___
|
||||
|
||||
*Overrides Array.filter*
|
||||
|
||||
*Defined in [codec/Tuple.ts:131](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Tuple.ts#L131)*
|
||||
*Defined in [codec/Tuple.ts:131](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Tuple.ts#L131)*
|
||||
|
||||
*__description__*: Filters the array with the callback
|
||||
|
||||
@@ -698,7 +698,7 @@ ___
|
||||
|
||||
*Overrides Array.map*
|
||||
|
||||
*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Tuple.ts#L140)*
|
||||
*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Tuple.ts#L140)*
|
||||
|
||||
*__description__*: Maps the array with the callback
|
||||
|
||||
@@ -1006,7 +1006,7 @@ ___
|
||||
|
||||
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)*
|
||||
|
||||
*Defined in [codec/Tuple.ts:82](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Tuple.ts#L82)*
|
||||
*Defined in [codec/Tuple.ts:82](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Tuple.ts#L82)*
|
||||
|
||||
*__description__*: Converts the Object to an standard JavaScript Array
|
||||
|
||||
@@ -1023,7 +1023,7 @@ ___
|
||||
|
||||
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)*
|
||||
|
||||
*Defined in [codec/Tuple.ts:89](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Tuple.ts#L89)*
|
||||
*Defined in [codec/Tuple.ts:89](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Tuple.ts#L89)*
|
||||
|
||||
*__description__*: Returns a hex string representation of the value
|
||||
|
||||
@@ -1040,7 +1040,7 @@ ___
|
||||
|
||||
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)*
|
||||
|
||||
*Defined in [codec/Tuple.ts:96](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Tuple.ts#L96)*
|
||||
*Defined in [codec/Tuple.ts:96](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Tuple.ts#L96)*
|
||||
|
||||
*__description__*: Converts the Object to JSON, typically used for RPC transfers
|
||||
|
||||
@@ -1074,7 +1074,7 @@ ___
|
||||
|
||||
*Overrides Array.toString*
|
||||
|
||||
*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Tuple.ts#L105)*
|
||||
*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Tuple.ts#L105)*
|
||||
|
||||
*__description__*: Returns the string representation of the value
|
||||
|
||||
@@ -1089,7 +1089,7 @@ ___
|
||||
|
||||
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)*
|
||||
|
||||
*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Tuple.ts#L114)*
|
||||
*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Tuple.ts#L114)*
|
||||
|
||||
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
|
||||
|
||||
@@ -1146,7 +1146,7 @@ ___
|
||||
|
||||
*Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)*
|
||||
|
||||
*Defined in [codec/Tuple.ts:53](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Tuple.ts#L53)*
|
||||
*Defined in [codec/Tuple.ts:53](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Tuple.ts#L53)*
|
||||
|
||||
**Type parameters:**
|
||||
|
||||
|
||||
@@ -1979,7 +1979,7 @@
|
||||
<h2 id="constructor">constructor</h2>
|
||||
<p>⊕ <strong>new Block</strong>(value?: <em> <a href="../modules/_block_.md#blockvalue">BlockValue</a> | <code>Uint8Array</code></em>): <a href="_block_.block.html">Block</a></p>
|
||||
<p><em>Overrides <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#constructor">constructor</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Block.ts#L24" target="_blank">Block.ts:24</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Block.ts#L24" target="_blank">Block.ts:24</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -2015,7 +2015,7 @@
|
||||
<h2 id="type">Type</h2>
|
||||
<p>getType(): <code>E</code></p>
|
||||
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#type">Type</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L141" target="_blank">codec/Struct.ts:141</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L141" target="_blank">codec/Struct.ts:141</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Returns the Type description to sthe structure</p>
|
||||
<p><strong>Returns:</strong> <code>E</code></p>
|
||||
<hr>
|
||||
@@ -2023,28 +2023,28 @@
|
||||
<h2 id="encodedlength">encodedLength</h2>
|
||||
<p>getencodedLength(): <code>number</code></p>
|
||||
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#encodedlength">encodedLength</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L148" target="_blank">codec/Struct.ts:148</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L148" target="_blank">codec/Struct.ts:148</a></em></p>
|
||||
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
|
||||
<p><strong>Returns:</strong> <code>number</code></p>
|
||||
<hr>
|
||||
<p><a id="extrinsics"></a></p>
|
||||
<h2 id="extrinsics">extrinsics</h2>
|
||||
<p>getextrinsics(): <a href="_extrinsics_.extrinsics.html">Extrinsics</a></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Block.ts#L35" target="_blank">Block.ts:35</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Block.ts#L35" target="_blank">Block.ts:35</a></em></p>
|
||||
<p><em><strong>description</strong></em>: The <a href="../interfaces/_method_.extrinsics.md">Extrinsics</a> conatined in the block</p>
|
||||
<p><strong>Returns:</strong> <a href="_extrinsics_.extrinsics.html">Extrinsics</a></p>
|
||||
<hr>
|
||||
<p><a id="hash"></a></p>
|
||||
<h2 id="hash">hash</h2>
|
||||
<p>gethash(): <a href="_hash_.hash.html">Hash</a></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Block.ts#L42" target="_blank">Block.ts:42</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Block.ts#L42" target="_blank">Block.ts:42</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Coinvenience getter, encoded the <a href="_hash_.hash.html">Hash</a> for the block</p>
|
||||
<p><strong>Returns:</strong> <a href="_hash_.hash.html">Hash</a></p>
|
||||
<hr>
|
||||
<p><a id="header"></a></p>
|
||||
<h2 id="header">header</h2>
|
||||
<p>getheader(): <a href="_header_.header.html">Header</a></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Block.ts#L51" target="_blank">Block.ts:51</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Block.ts#L51" target="_blank">Block.ts:51</a></em></p>
|
||||
<p><em><strong>description</strong></em>: The <a href="_header_.header.html">Header</a> in the block</p>
|
||||
<p><strong>Returns:</strong> <a href="_header_.header.html">Header</a></p>
|
||||
<hr>
|
||||
@@ -2125,7 +2125,7 @@
|
||||
<p>▸ <strong>get</strong>(name: <em><code>keyof S</code></em>): <a href="../interfaces/_types_.codec.md">Codec</a> | <code>undefined</code></p>
|
||||
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#get">get</a></em></p>
|
||||
<p><em>Overrides Map.get</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L158" target="_blank">codec/Struct.ts:158</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L158" target="_blank">codec/Struct.ts:158</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Returns a specific names entry in the structure</p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
@@ -2150,7 +2150,7 @@
|
||||
<h2 id="getatindex">getAtIndex</h2>
|
||||
<p>▸ <strong>getAtIndex</strong>(index: <em><code>number</code></em>): <a href="../interfaces/_types_.codec.md">Codec</a></p>
|
||||
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#getatindex">getAtIndex</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L165" target="_blank">codec/Struct.ts:165</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L165" target="_blank">codec/Struct.ts:165</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Returns the values of a member at a specific index (Rather use get(name) for performance)</p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
@@ -2229,7 +2229,7 @@
|
||||
<h2 id="toarray">toArray</h2>
|
||||
<p>▸ <strong>toArray</strong>(): <code>Array</code><<a href="../interfaces/_types_.codec.md">Codec</a>></p>
|
||||
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#toarray">toArray</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L172" target="_blank">codec/Struct.ts:172</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L172" target="_blank">codec/Struct.ts:172</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Converts the Object to an standard JavaScript Array</p>
|
||||
<p><strong>Returns:</strong> <code>Array</code><<a href="../interfaces/_types_.codec.md">Codec</a>></p>
|
||||
<hr>
|
||||
@@ -2238,7 +2238,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_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#tohex">toHex</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L179" target="_blank">codec/Struct.ts:179</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L179" target="_blank">codec/Struct.ts:179</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
|
||||
<p><strong>Returns:</strong> <code>string</code></p>
|
||||
<hr>
|
||||
@@ -2247,7 +2247,7 @@
|
||||
<p>▸ <strong>toJSON</strong>(): <code>any</code></p>
|
||||
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
|
||||
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#tojson">toJSON</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L186" target="_blank">codec/Struct.ts:186</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L186" target="_blank">codec/Struct.ts:186</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
|
||||
<p><strong>Returns:</strong> <code>any</code></p>
|
||||
<hr>
|
||||
@@ -2256,7 +2256,7 @@
|
||||
<p>▸ <strong>toString</strong>(): <code>string</code></p>
|
||||
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
|
||||
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#tostring">toString</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L200" target="_blank">codec/Struct.ts:200</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L200" target="_blank">codec/Struct.ts:200</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>
|
||||
@@ -2264,7 +2264,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_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#tou8a">toU8a</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L208" target="_blank">codec/Struct.ts:208</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L208" target="_blank">codec/Struct.ts:208</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>
|
||||
@@ -2297,7 +2297,7 @@
|
||||
<h2 id="static-with"><code><Static></code> with</h2>
|
||||
<p>▸ <strong>with</strong><<code>S</code>>(Types: <em><code>S</code></em>): <a href="../modules/_types_.md#constructor">Constructor</a><<a href="_codec_struct_.struct.html">Struct</a><<code>S</code>>></p>
|
||||
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#with">with</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L121" target="_blank">codec/Struct.ts:121</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L121" target="_blank">codec/Struct.ts:121</a></em></p>
|
||||
<p><strong>Type parameters:</strong></p>
|
||||
<h4 id="s---constructordef">S : <a href="../modules/_types_.md#constructordef">ConstructorDef</a></h4>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
@@ -2360,7 +2360,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.8","depth":1,"next":{"title":"hidden","level":"4.9","depth":1,"path":"types/classes/_blocknumber_.blocknumber.md","ref":"types/classes/_blocknumber_.blocknumber.md","articles":[]},"previous":{"title":"hidden","level":"4.7","depth":1,"path":"types/classes/_bft_.bfthashsignature.md","ref":"types/classes/_bft_.bfthashsignature.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"types/classes/_block_.block.md","mtime":"2018-12-17T11:43:41.860Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T11:44:28.801Z"},"basePath":"../..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.8","depth":1,"next":{"title":"hidden","level":"4.9","depth":1,"path":"types/classes/_blocknumber_.blocknumber.md","ref":"types/classes/_blocknumber_.blocknumber.md","articles":[]},"previous":{"title":"hidden","level":"4.7","depth":1,"path":"types/classes/_bft_.bfthashsignature.md","ref":"types/classes/_bft_.bfthashsignature.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"types/classes/_block_.block.md","mtime":"2018-12-17T13:58:51.617Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T13:59:36.621Z"},"basePath":"../..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -29,7 +29,7 @@
|
||||
|
||||
*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)*
|
||||
|
||||
*Defined in [Block.ts:24](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Block.ts#L24)*
|
||||
*Defined in [Block.ts:24](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Block.ts#L24)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -76,7 +76,7 @@ getType(): `E`
|
||||
|
||||
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
|
||||
|
||||
*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L141)*
|
||||
*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L141)*
|
||||
|
||||
*__description__*: Returns the Type description to sthe structure
|
||||
|
||||
@@ -91,7 +91,7 @@ getencodedLength(): `number`
|
||||
|
||||
*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)*
|
||||
|
||||
*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L148)*
|
||||
*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L148)*
|
||||
|
||||
*__description__*: The length of the value when encoded as a Uint8Array
|
||||
|
||||
@@ -104,7 +104,7 @@ ___
|
||||
|
||||
getextrinsics(): [Extrinsics](_extrinsics_.extrinsics.md)
|
||||
|
||||
*Defined in [Block.ts:35](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Block.ts#L35)*
|
||||
*Defined in [Block.ts:35](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Block.ts#L35)*
|
||||
|
||||
*__description__*: The [Extrinsics](../interfaces/_method_.extrinsics.md) conatined in the block
|
||||
|
||||
@@ -117,7 +117,7 @@ ___
|
||||
|
||||
gethash(): [Hash](_hash_.hash.md)
|
||||
|
||||
*Defined in [Block.ts:42](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Block.ts#L42)*
|
||||
*Defined in [Block.ts:42](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Block.ts#L42)*
|
||||
|
||||
*__description__*: Coinvenience getter, encoded the [Hash](_hash_.hash.md) for the block
|
||||
|
||||
@@ -130,7 +130,7 @@ ___
|
||||
|
||||
getheader(): [Header](_header_.header.md)
|
||||
|
||||
*Defined in [Block.ts:51](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Block.ts#L51)*
|
||||
*Defined in [Block.ts:51](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Block.ts#L51)*
|
||||
|
||||
*__description__*: The [Header](_header_.header.md) in the block
|
||||
|
||||
@@ -232,7 +232,7 @@ ___
|
||||
|
||||
*Overrides Map.get*
|
||||
|
||||
*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L158)*
|
||||
*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L158)*
|
||||
|
||||
*__description__*: Returns a specific names entry in the structure
|
||||
|
||||
@@ -253,7 +253,7 @@ ___
|
||||
|
||||
*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)*
|
||||
|
||||
*Defined in [codec/Struct.ts:165](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L165)*
|
||||
*Defined in [codec/Struct.ts:165](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L165)*
|
||||
|
||||
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
|
||||
|
||||
@@ -328,7 +328,7 @@ ___
|
||||
|
||||
*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)*
|
||||
|
||||
*Defined in [codec/Struct.ts:172](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L172)*
|
||||
*Defined in [codec/Struct.ts:172](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L172)*
|
||||
|
||||
*__description__*: Converts the Object to an standard JavaScript Array
|
||||
|
||||
@@ -345,7 +345,7 @@ ___
|
||||
|
||||
*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)*
|
||||
|
||||
*Defined in [codec/Struct.ts:179](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L179)*
|
||||
*Defined in [codec/Struct.ts:179](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L179)*
|
||||
|
||||
*__description__*: Returns a hex string representation of the value
|
||||
|
||||
@@ -362,7 +362,7 @@ ___
|
||||
|
||||
*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
|
||||
|
||||
*Defined in [codec/Struct.ts:186](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L186)*
|
||||
*Defined in [codec/Struct.ts:186](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L186)*
|
||||
|
||||
*__description__*: Converts the Object to JSON, typically used for RPC transfers
|
||||
|
||||
@@ -379,7 +379,7 @@ ___
|
||||
|
||||
*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)*
|
||||
|
||||
*Defined in [codec/Struct.ts:200](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L200)*
|
||||
*Defined in [codec/Struct.ts:200](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L200)*
|
||||
|
||||
*__description__*: Returns the string representation of the value
|
||||
|
||||
@@ -394,7 +394,7 @@ ___
|
||||
|
||||
*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
|
||||
|
||||
*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L208)*
|
||||
*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L208)*
|
||||
|
||||
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
|
||||
|
||||
@@ -430,7 +430,7 @@ ___
|
||||
|
||||
*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
|
||||
|
||||
*Defined in [codec/Struct.ts:121](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Struct.ts#L121)*
|
||||
*Defined in [codec/Struct.ts:121](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Struct.ts#L121)*
|
||||
|
||||
**Type parameters:**
|
||||
|
||||
|
||||
@@ -1975,7 +1975,7 @@
|
||||
<p>⊕ <strong>new BlockNumber</strong>(value?: <em><a href="../modules/_types_.md#anynumber">AnyNumber</a></em>): <a href="_blocknumber_.blocknumber.html">BlockNumber</a></p>
|
||||
<p><em>Inherited from <a href="_u64_.u64.html">U64</a>.<a href="_u64_.u64.html#constructor">constructor</a></em></p>
|
||||
<p><em>Overrides <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#constructor">constructor</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/U64.ts#L14" target="_blank">U64.ts:14</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/U64.ts#L14" target="_blank">U64.ts:14</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -1998,7 +1998,7 @@
|
||||
<h2 id="encodedlength">encodedLength</h2>
|
||||
<p>getencodedLength(): <code>number</code></p>
|
||||
<p><em>Inherited from <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#encodedlength">encodedLength</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/UInt.ts#L57" target="_blank">codec/UInt.ts:57</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/UInt.ts#L57" target="_blank">codec/UInt.ts:57</a></em></p>
|
||||
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
|
||||
<p><strong>Returns:</strong> <code>number</code></p>
|
||||
<hr>
|
||||
@@ -2131,7 +2131,7 @@
|
||||
<p>▸ <strong>bitLength</strong>(): <a href="../modules/_codec_uint_.md#uintbitlength">UIntBitLength</a></p>
|
||||
<p><em>Inherited from <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#bitlength">bitLength</a></em></p>
|
||||
<p><em>Overrides BN.bitLength</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/UInt.ts#L64" target="_blank">codec/UInt.ts:64</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/UInt.ts#L64" target="_blank">codec/UInt.ts:64</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Returns the number of bits in the value</p>
|
||||
<p><strong>Returns:</strong> <a href="../modules/_codec_uint_.md#uintbitlength">UIntBitLength</a></p>
|
||||
<hr>
|
||||
@@ -3509,7 +3509,7 @@
|
||||
<h2 id="tobn">toBn</h2>
|
||||
<p>▸ <strong>toBn</strong>(): <code>BN</code></p>
|
||||
<p><em>Inherited from <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#tobn">toBn</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/UInt.ts#L71" target="_blank">codec/UInt.ts:71</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/UInt.ts#L71" target="_blank">codec/UInt.ts:71</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Returns the BN representation of the number. (Compatibility)</p>
|
||||
<p><strong>Returns:</strong> <code>BN</code></p>
|
||||
<hr>
|
||||
@@ -3545,7 +3545,7 @@
|
||||
<p>▸ <strong>toHex</strong>(): <code>string</code></p>
|
||||
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
|
||||
<p><em>Inherited from <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#tohex">toHex</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/UInt.ts#L78" target="_blank">codec/UInt.ts:78</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/UInt.ts#L78" target="_blank">codec/UInt.ts:78</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
|
||||
<p><strong>Returns:</strong> <code>string</code></p>
|
||||
<hr>
|
||||
@@ -3555,7 +3555,7 @@
|
||||
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
|
||||
<p><em>Inherited from <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#tojson">toJSON</a></em></p>
|
||||
<p><em>Overrides BN.toJSON</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/UInt.ts#L85" target="_blank">codec/UInt.ts:85</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/UInt.ts#L85" target="_blank">codec/UInt.ts:85</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
|
||||
<p><strong>Returns:</strong> <code>any</code></p>
|
||||
<hr>
|
||||
@@ -3595,7 +3595,7 @@
|
||||
<p>▸ <strong>toString</strong>(base?: <em> <code>undefined</code> | <code>number</code></em>): <code>string</code></p>
|
||||
<p><em>Inherited from <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#tostring">toString</a></em></p>
|
||||
<p><em>Overrides BN.toString</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/UInt.ts#L95" target="_blank">codec/UInt.ts:95</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/UInt.ts#L95" target="_blank">codec/UInt.ts:95</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
@@ -3643,7 +3643,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_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/d11906e/packages/types/src/codec/UInt.ts#L104" target="_blank">codec/UInt.ts:104</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/UInt.ts#L104" target="_blank">codec/UInt.ts:104</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
@@ -3860,7 +3860,7 @@
|
||||
<h2 id="static-decodeuint"><code><Static></code> decodeUInt</h2>
|
||||
<p>▸ <strong>decodeUInt</strong>(value: <em><a href="../modules/_types_.md#anynumber">AnyNumber</a></em>, bitLength: <em><a href="../modules/_codec_uint_.md#uintbitlength">UIntBitLength</a></em>): <code>string</code></p>
|
||||
<p><em>Inherited from <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#decodeuint">decodeUInt</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/UInt.ts#L38" target="_blank">codec/UInt.ts:38</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/UInt.ts#L38" target="_blank">codec/UInt.ts:38</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -4048,7 +4048,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.9","depth":1,"next":{"title":"hidden","level":"4.10","depth":1,"path":"types/classes/_bool_.bool.md","ref":"types/classes/_bool_.bool.md","articles":[]},"previous":{"title":"hidden","level":"4.8","depth":1,"path":"types/classes/_block_.block.md","ref":"types/classes/_block_.block.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"types/classes/_blocknumber_.blocknumber.md","mtime":"2018-12-17T11:43:42.096Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T11:44:28.801Z"},"basePath":"../..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.9","depth":1,"next":{"title":"hidden","level":"4.10","depth":1,"path":"types/classes/_bool_.bool.md","ref":"types/classes/_bool_.bool.md","articles":[]},"previous":{"title":"hidden","level":"4.8","depth":1,"path":"types/classes/_block_.block.md","ref":"types/classes/_block_.block.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"types/classes/_blocknumber_.blocknumber.md","mtime":"2018-12-17T13:58:51.853Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T13:59:36.621Z"},"basePath":"../..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -26,7 +26,7 @@
|
||||
|
||||
*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)*
|
||||
|
||||
*Defined in [U64.ts:14](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/U64.ts#L14)*
|
||||
*Defined in [U64.ts:14](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/U64.ts#L14)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -48,7 +48,7 @@ getencodedLength(): `number`
|
||||
|
||||
*Inherited from [UInt](_codec_uint_.uint.md).[encodedLength](_codec_uint_.uint.md#encodedlength)*
|
||||
|
||||
*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/UInt.ts#L57)*
|
||||
*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/UInt.ts#L57)*
|
||||
|
||||
*__description__*: The length of the value when encoded as a Uint8Array
|
||||
|
||||
@@ -188,7 +188,7 @@ ___
|
||||
|
||||
*Overrides BN.bitLength*
|
||||
|
||||
*Defined in [codec/UInt.ts:64](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/UInt.ts#L64)*
|
||||
*Defined in [codec/UInt.ts:64](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/UInt.ts#L64)*
|
||||
|
||||
*__description__*: Returns the number of bits in the value
|
||||
|
||||
@@ -1523,7 +1523,7 @@ ___
|
||||
|
||||
*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)*
|
||||
|
||||
*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/UInt.ts#L71)*
|
||||
*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/UInt.ts#L71)*
|
||||
|
||||
*__description__*: Returns the BN representation of the number. (Compatibility)
|
||||
|
||||
@@ -1562,7 +1562,7 @@ ___
|
||||
|
||||
*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)*
|
||||
|
||||
*Defined in [codec/UInt.ts:78](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/UInt.ts#L78)*
|
||||
*Defined in [codec/UInt.ts:78](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/UInt.ts#L78)*
|
||||
|
||||
*__description__*: Returns a hex string representation of the value
|
||||
|
||||
@@ -1581,7 +1581,7 @@ ___
|
||||
|
||||
*Overrides BN.toJSON*
|
||||
|
||||
*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/UInt.ts#L85)*
|
||||
*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/UInt.ts#L85)*
|
||||
|
||||
*__description__*: Converts the Object to JSON, typically used for RPC transfers
|
||||
|
||||
@@ -1634,7 +1634,7 @@ ___
|
||||
|
||||
*Overrides BN.toString*
|
||||
|
||||
*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/UInt.ts#L95)*
|
||||
*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/UInt.ts#L95)*
|
||||
|
||||
*__description__*: Returns the string representation of the value
|
||||
|
||||
@@ -1676,7 +1676,7 @@ ___
|
||||
|
||||
*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)*
|
||||
|
||||
*Defined in [codec/UInt.ts:104](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/UInt.ts#L104)*
|
||||
*Defined in [codec/UInt.ts:104](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/UInt.ts#L104)*
|
||||
|
||||
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
|
||||
|
||||
@@ -1880,7 +1880,7 @@ ___
|
||||
|
||||
*Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)*
|
||||
|
||||
*Defined in [codec/UInt.ts:38](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/UInt.ts#L38)*
|
||||
*Defined in [codec/UInt.ts:38](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/UInt.ts#L38)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -1973,7 +1973,7 @@
|
||||
<p><a id="constructor"></a></p>
|
||||
<h2 id="constructor">constructor</h2>
|
||||
<p>⊕ <strong>new Bool</strong>(value?: <em> <a href="_bool_.bool.html">Bool</a> | <code>Boolean</code> | <code>Uint8Array</code> | <code>boolean</code> | <code>number</code></em>): <a href="_bool_.bool.html">Bool</a></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Bool.ts#L15" target="_blank">Bool.ts:15</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Bool.ts#L15" target="_blank">Bool.ts:15</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -2003,7 +2003,7 @@
|
||||
<p><a id="encodedlength"></a></p>
|
||||
<h2 id="encodedlength">encodedLength</h2>
|
||||
<p>getencodedLength(): <code>number</code></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Bool.ts#L35" target="_blank">Bool.ts:35</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Bool.ts#L35" target="_blank">Bool.ts:35</a></em></p>
|
||||
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
|
||||
<p><strong>Returns:</strong> <code>number</code></p>
|
||||
<hr>
|
||||
@@ -2012,7 +2012,7 @@
|
||||
<h2 id="tohex">toHex</h2>
|
||||
<p>▸ <strong>toHex</strong>(): <code>string</code></p>
|
||||
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Bool.ts#L42" target="_blank">Bool.ts:42</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Bool.ts#L42" target="_blank">Bool.ts:42</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
|
||||
<p><strong>Returns:</strong> <code>string</code></p>
|
||||
<hr>
|
||||
@@ -2020,7 +2020,7 @@
|
||||
<h2 id="tojson">toJSON</h2>
|
||||
<p>▸ <strong>toJSON</strong>(): <code>any</code></p>
|
||||
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Bool.ts#L49" target="_blank">Bool.ts:49</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Bool.ts#L49" target="_blank">Bool.ts:49</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
|
||||
<p><strong>Returns:</strong> <code>any</code></p>
|
||||
<hr>
|
||||
@@ -2028,14 +2028,14 @@
|
||||
<h2 id="tostring">toString</h2>
|
||||
<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>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Bool.ts#L56" target="_blank">Bool.ts:56</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Bool.ts#L56" target="_blank">Bool.ts:56</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
|
||||
<p><strong>Returns:</strong> <code>string</code></p>
|
||||
<hr>
|
||||
<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/d11906e/packages/types/src/Bool.ts#L64" target="_blank">Bool.ts:64</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Bool.ts#L64" target="_blank">Bool.ts:64</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
@@ -2099,7 +2099,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.10","depth":1,"next":{"title":"hidden","level":"4.11","depth":1,"path":"types/classes/_bytes_.bytes.md","ref":"types/classes/_bytes_.bytes.md","articles":[]},"previous":{"title":"hidden","level":"4.9","depth":1,"path":"types/classes/_blocknumber_.blocknumber.md","ref":"types/classes/_blocknumber_.blocknumber.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"types/classes/_bool_.bool.md","mtime":"2018-12-17T11:43:42.112Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T11:44:28.801Z"},"basePath":"../..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.10","depth":1,"next":{"title":"hidden","level":"4.11","depth":1,"path":"types/classes/_bytes_.bytes.md","ref":"types/classes/_bytes_.bytes.md","articles":[]},"previous":{"title":"hidden","level":"4.9","depth":1,"path":"types/classes/_blocknumber_.blocknumber.md","ref":"types/classes/_blocknumber_.blocknumber.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"types/classes/_bool_.bool.md","mtime":"2018-12-17T13:58:51.869Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T13:59:36.621Z"},"basePath":"../..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -22,7 +22,7 @@
|
||||
|
||||
⊕ **new Bool**(value?: * [Bool](_bool_.bool.md) | `Boolean` | `Uint8Array` | `boolean` | `number`*): [Bool](_bool_.bool.md)
|
||||
|
||||
*Defined in [Bool.ts:15](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Bool.ts#L15)*
|
||||
*Defined in [Bool.ts:15](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Bool.ts#L15)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -54,7 +54,7 @@ ___
|
||||
|
||||
getencodedLength(): `number`
|
||||
|
||||
*Defined in [Bool.ts:35](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Bool.ts#L35)*
|
||||
*Defined in [Bool.ts:35](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Bool.ts#L35)*
|
||||
|
||||
*__description__*: The length of the value when encoded as a Uint8Array
|
||||
|
||||
@@ -72,7 +72,7 @@ ___
|
||||
|
||||
*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)*
|
||||
|
||||
*Defined in [Bool.ts:42](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Bool.ts#L42)*
|
||||
*Defined in [Bool.ts:42](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Bool.ts#L42)*
|
||||
|
||||
*__description__*: Returns a hex string representation of the value
|
||||
|
||||
@@ -87,7 +87,7 @@ ___
|
||||
|
||||
*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)*
|
||||
|
||||
*Defined in [Bool.ts:49](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Bool.ts#L49)*
|
||||
*Defined in [Bool.ts:49](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Bool.ts#L49)*
|
||||
|
||||
*__description__*: Converts the Object to JSON, typically used for RPC transfers
|
||||
|
||||
@@ -102,7 +102,7 @@ ___
|
||||
|
||||
*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)*
|
||||
|
||||
*Defined in [Bool.ts:56](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Bool.ts#L56)*
|
||||
*Defined in [Bool.ts:56](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Bool.ts#L56)*
|
||||
|
||||
*__description__*: Returns the string representation of the value
|
||||
|
||||
@@ -115,7 +115,7 @@ ___
|
||||
|
||||
▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array`
|
||||
|
||||
*Defined in [Bool.ts:64](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Bool.ts#L64)*
|
||||
*Defined in [Bool.ts:64](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Bool.ts#L64)*
|
||||
|
||||
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
|
||||
|
||||
|
||||
@@ -1980,7 +1980,7 @@
|
||||
<h2 id="constructor">constructor</h2>
|
||||
<p>⊕ <strong>new Bytes</strong>(value: <em><a href="../modules/_types_.md#anyu8a">AnyU8a</a></em>): <a href="_bytes_.bytes.html">Bytes</a></p>
|
||||
<p><em>Overrides <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#constructor">constructor</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Bytes.ts#L18" target="_blank">Bytes.ts:18</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Bytes.ts#L18" target="_blank">Bytes.ts:18</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -2038,7 +2038,7 @@
|
||||
<h2 id="encodedlength">encodedLength</h2>
|
||||
<p>getencodedLength(): <code>number</code></p>
|
||||
<p><em>Overrides <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/d11906e/packages/types/src/Bytes.ts#L64" target="_blank">Bytes.ts:64</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Bytes.ts#L64" target="_blank">Bytes.ts:64</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>
|
||||
@@ -2047,7 +2047,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/d11906e/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/5f1178f/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>
|
||||
@@ -2722,7 +2722,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/d11906e/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/5f1178f/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>
|
||||
@@ -2753,7 +2753,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/d11906e/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/5f1178f/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>
|
||||
@@ -2762,7 +2762,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>Inherited from <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/d11906e/packages/types/src/codec/U8a.ts#L67" target="_blank">codec/U8a.ts:67</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/U8a.ts#L67" target="_blank">codec/U8a.ts:67</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>
|
||||
@@ -2780,7 +2780,7 @@
|
||||
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
|
||||
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#tostring">toString</a></em></p>
|
||||
<p><em>Overrides Uint8Array.toString</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/U8a.ts#L74" target="_blank">codec/U8a.ts:74</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/U8a.ts#L74" target="_blank">codec/U8a.ts:74</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>
|
||||
@@ -2788,7 +2788,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>Overrides <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/d11906e/packages/types/src/Bytes.ts#L72" target="_blank">Bytes.ts:72</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Bytes.ts#L72" target="_blank">Bytes.ts:72</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>
|
||||
@@ -2860,7 +2860,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.11","depth":1,"next":{"title":"hidden","level":"4.12","depth":1,"path":"types/classes/_chainproperties_.chainproperties.md","ref":"types/classes/_chainproperties_.chainproperties.md","articles":[]},"previous":{"title":"hidden","level":"4.10","depth":1,"path":"types/classes/_bool_.bool.md","ref":"types/classes/_bool_.bool.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/_bytes_.bytes.md","mtime":"2018-12-17T11:43:42.292Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T11:44:28.801Z"},"basePath":"../..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.11","depth":1,"next":{"title":"hidden","level":"4.12","depth":1,"path":"types/classes/_chainproperties_.chainproperties.md","ref":"types/classes/_chainproperties_.chainproperties.md","articles":[]},"previous":{"title":"hidden","level":"4.10","depth":1,"path":"types/classes/_bool_.bool.md","ref":"types/classes/_bool_.bool.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/_bytes_.bytes.md","mtime":"2018-12-17T13:58:52.049Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T13:59:36.621Z"},"basePath":"../..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -35,7 +35,7 @@
|
||||
|
||||
*Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)*
|
||||
|
||||
*Defined in [Bytes.ts:18](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Bytes.ts#L18)*
|
||||
*Defined in [Bytes.ts:18](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Bytes.ts#L18)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -123,7 +123,7 @@ getencodedLength(): `number`
|
||||
|
||||
*Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)*
|
||||
|
||||
*Defined in [Bytes.ts:64](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Bytes.ts#L64)*
|
||||
*Defined in [Bytes.ts:64](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Bytes.ts#L64)*
|
||||
|
||||
*__description__*: The length of the value when encoded as a Uint8Array
|
||||
|
||||
@@ -140,7 +140,7 @@ getlength(): `number`
|
||||
|
||||
*Overrides Uint8Array.length*
|
||||
|
||||
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/U8a.ts#L43)*
|
||||
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/U8a.ts#L43)*
|
||||
|
||||
*__description__*: The length of the value
|
||||
|
||||
@@ -682,7 +682,7 @@ ___
|
||||
|
||||
*Overrides Uint8Array.subarray*
|
||||
|
||||
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/U8a.ts#L53)*
|
||||
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/5f1178f/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
|
||||
|
||||
@@ -706,7 +706,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/d11906e/packages/types/src/codec/U8a.ts#L60)*
|
||||
*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/U8a.ts#L60)*
|
||||
|
||||
*__description__*: Returns a hex string representation of the value
|
||||
|
||||
@@ -723,7 +723,7 @@ ___
|
||||
|
||||
*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
|
||||
|
||||
*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/U8a.ts#L67)*
|
||||
*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/U8a.ts#L67)*
|
||||
|
||||
*__description__*: Converts the Object to JSON, typically used for RPC transfers
|
||||
|
||||
@@ -757,7 +757,7 @@ ___
|
||||
|
||||
*Overrides Uint8Array.toString*
|
||||
|
||||
*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/U8a.ts#L74)*
|
||||
*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/U8a.ts#L74)*
|
||||
|
||||
*__description__*: Returns the string representation of the value
|
||||
|
||||
@@ -772,7 +772,7 @@ ___
|
||||
|
||||
*Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
|
||||
|
||||
*Defined in [Bytes.ts:72](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/Bytes.ts#L72)*
|
||||
*Defined in [Bytes.ts:72](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/Bytes.ts#L72)*
|
||||
|
||||
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
|
||||
|
||||
|
||||
@@ -1973,7 +1973,7 @@
|
||||
<p><a id="constructor"></a></p>
|
||||
<h2 id="constructor">constructor</h2>
|
||||
<p>⊕ <strong>new ChainProperties</strong>(value?: <em> <code>object</code> | <code>null</code></em>): <a href="_chainproperties_.chainproperties.html">ChainProperties</a></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/ChainProperties.ts#L17" target="_blank">ChainProperties.ts:17</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/ChainProperties.ts#L17" target="_blank">ChainProperties.ts:17</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -2001,7 +2001,7 @@
|
||||
<p><a id="encodedlength"></a></p>
|
||||
<h2 id="encodedlength">encodedLength</h2>
|
||||
<p>getencodedLength(): <code>number</code></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/ChainProperties.ts#L29" target="_blank">ChainProperties.ts:29</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/ChainProperties.ts#L29" target="_blank">ChainProperties.ts:29</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Always 0, never encodes as a Uint8Array</p>
|
||||
<p><strong>Returns:</strong> <code>number</code></p>
|
||||
<hr>
|
||||
@@ -2010,7 +2010,7 @@
|
||||
<h2 id="get">get</h2>
|
||||
<p>▸ <strong>get</strong>(name: <em><code>string</code></em>): <code>any</code> | <code>undefined</code></p>
|
||||
<p><em>Overrides Map.get</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/ChainProperties.ts#L37" target="_blank">ChainProperties.ts:37</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/ChainProperties.ts#L37" target="_blank">ChainProperties.ts:37</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Returns a specific names entry in the structure</p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
@@ -2035,7 +2035,7 @@
|
||||
<h2 id="tohex">toHex</h2>
|
||||
<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>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/ChainProperties.ts#L44" target="_blank">ChainProperties.ts:44</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/ChainProperties.ts#L44" target="_blank">ChainProperties.ts:44</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Unimplemented, will throw</p>
|
||||
<p><strong>Returns:</strong> <code>string</code></p>
|
||||
<hr>
|
||||
@@ -2043,7 +2043,7 @@
|
||||
<h2 id="tojson">toJSON</h2>
|
||||
<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>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/ChainProperties.ts#L51" target="_blank">ChainProperties.ts:51</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/ChainProperties.ts#L51" target="_blank">ChainProperties.ts:51</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>
|
||||
@@ -2051,14 +2051,14 @@
|
||||
<h2 id="tostring">toString</h2>
|
||||
<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>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/ChainProperties.ts#L62" target="_blank">ChainProperties.ts:62</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/ChainProperties.ts#L62" target="_blank">ChainProperties.ts:62</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/d11906e/packages/types/src/ChainProperties.ts#L69" target="_blank">ChainProperties.ts:69</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/ChainProperties.ts#L69" target="_blank">ChainProperties.ts:69</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Unimplemented, will throw</p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
@@ -2120,7 +2120,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.12","depth":1,"next":{"title":"hidden","level":"4.13","depth":1,"path":"types/classes/_codec_base_.base.md","ref":"types/classes/_codec_base_.base.md","articles":[]},"previous":{"title":"hidden","level":"4.11","depth":1,"path":"types/classes/_bytes_.bytes.md","ref":"types/classes/_bytes_.bytes.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/_chainproperties_.chainproperties.md","mtime":"2018-12-17T11:43:42.312Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T11:44:28.801Z"},"basePath":"../..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.12","depth":1,"next":{"title":"hidden","level":"4.13","depth":1,"path":"types/classes/_codec_base_.base.md","ref":"types/classes/_codec_base_.base.md","articles":[]},"previous":{"title":"hidden","level":"4.11","depth":1,"path":"types/classes/_bytes_.bytes.md","ref":"types/classes/_bytes_.bytes.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/_chainproperties_.chainproperties.md","mtime":"2018-12-17T13:58:52.069Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T13:59:36.621Z"},"basePath":"../..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -22,7 +22,7 @@
|
||||
|
||||
⊕ **new ChainProperties**(value?: * `object` | `null`*): [ChainProperties](_chainproperties_.chainproperties.md)
|
||||
|
||||
*Defined in [ChainProperties.ts:17](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/ChainProperties.ts#L17)*
|
||||
*Defined in [ChainProperties.ts:17](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/ChainProperties.ts#L17)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -54,7 +54,7 @@ ___
|
||||
|
||||
getencodedLength(): `number`
|
||||
|
||||
*Defined in [ChainProperties.ts:29](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/ChainProperties.ts#L29)*
|
||||
*Defined in [ChainProperties.ts:29](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/ChainProperties.ts#L29)*
|
||||
|
||||
*__description__*: Always 0, never encodes as a Uint8Array
|
||||
|
||||
@@ -72,7 +72,7 @@ ___
|
||||
|
||||
*Overrides Map.get*
|
||||
|
||||
*Defined in [ChainProperties.ts:37](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/ChainProperties.ts#L37)*
|
||||
*Defined in [ChainProperties.ts:37](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/ChainProperties.ts#L37)*
|
||||
|
||||
*__description__*: Returns a specific names entry in the structure
|
||||
|
||||
@@ -93,7 +93,7 @@ ___
|
||||
|
||||
*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)*
|
||||
|
||||
*Defined in [ChainProperties.ts:44](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/ChainProperties.ts#L44)*
|
||||
*Defined in [ChainProperties.ts:44](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/ChainProperties.ts#L44)*
|
||||
|
||||
*__description__*: Unimplemented, will throw
|
||||
|
||||
@@ -108,7 +108,7 @@ ___
|
||||
|
||||
*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)*
|
||||
|
||||
*Defined in [ChainProperties.ts:51](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/ChainProperties.ts#L51)*
|
||||
*Defined in [ChainProperties.ts:51](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/ChainProperties.ts#L51)*
|
||||
|
||||
*__description__*: Converts the Object to JSON, typically used for RPC transfers
|
||||
|
||||
@@ -123,7 +123,7 @@ ___
|
||||
|
||||
*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)*
|
||||
|
||||
*Defined in [ChainProperties.ts:62](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/ChainProperties.ts#L62)*
|
||||
*Defined in [ChainProperties.ts:62](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/ChainProperties.ts#L62)*
|
||||
|
||||
*__description__*: Returns the string representation of the value
|
||||
|
||||
@@ -136,7 +136,7 @@ ___
|
||||
|
||||
▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array`
|
||||
|
||||
*Defined in [ChainProperties.ts:69](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/ChainProperties.ts#L69)*
|
||||
*Defined in [ChainProperties.ts:69](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/ChainProperties.ts#L69)*
|
||||
|
||||
*__description__*: Unimplemented, will throw
|
||||
|
||||
|
||||
@@ -1976,7 +1976,7 @@
|
||||
<p><a id="constructor"></a></p>
|
||||
<h2 id="constructor">constructor</h2>
|
||||
<p>⊕ <strong>new Base</strong>(value?: <em><code>any</code></em>): <a href="_codec_base_.base.html">Base</a></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Base.ts#L10" target="_blank">codec/Base.ts:10</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Base.ts#L10" target="_blank">codec/Base.ts:10</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -2037,7 +2037,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.13","depth":1,"next":{"title":"hidden","level":"4.14","depth":1,"path":"types/classes/_codec_compact_.compact.md","ref":"types/classes/_codec_compact_.compact.md","articles":[]},"previous":{"title":"hidden","level":"4.12","depth":1,"path":"types/classes/_chainproperties_.chainproperties.md","ref":"types/classes/_chainproperties_.chainproperties.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/_codec_base_.base.md","mtime":"2018-12-17T11:43:52.647Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T11:44:28.801Z"},"basePath":"../..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.13","depth":1,"next":{"title":"hidden","level":"4.14","depth":1,"path":"types/classes/_codec_compact_.compact.md","ref":"types/classes/_codec_compact_.compact.md","articles":[]},"previous":{"title":"hidden","level":"4.12","depth":1,"path":"types/classes/_chainproperties_.chainproperties.md","ref":"types/classes/_chainproperties_.chainproperties.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/_codec_base_.base.md","mtime":"2018-12-17T13:59:02.097Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T13:59:36.621Z"},"basePath":"../..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -30,7 +30,7 @@
|
||||
|
||||
⊕ **new Base**(value?: *`any`*): [Base](_codec_base_.base.md)
|
||||
|
||||
*Defined in [codec/Base.ts:10](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Base.ts#L10)*
|
||||
*Defined in [codec/Base.ts:10](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Base.ts#L10)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -1974,7 +1974,7 @@
|
||||
<h2 id="constructor">constructor</h2>
|
||||
<p>⊕ <strong>new Compact</strong>(Type: <em><a href="../modules/_types_.md#constructor">Constructor</a>< <a href="_codec_uint_.uint.html">UInt</a> | <a href="_moment_.moment.html">Moment</a>></em>, value?: <em><a href="../modules/_types_.md#anynumber">AnyNumber</a></em>): <a href="_codec_compact_.compact.html">Compact</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/d11906e/packages/types/src/codec/Compact.ts#L22" target="_blank">codec/Compact.ts:22</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Compact.ts#L22" target="_blank">codec/Compact.ts:22</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -2003,25 +2003,25 @@
|
||||
<p><a id="addlengthprefix"></a></p>
|
||||
<h2 id="static-addlengthprefix"><code><Static></code> addLengthPrefix</h2>
|
||||
<p><strong>● addLengthPrefix</strong>: <em><code>compactAddLength</code></em> = compactAddLength</p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Compact.ts#L40" target="_blank">codec/Compact.ts:40</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Compact.ts#L40" target="_blank">codec/Compact.ts:40</a></em></p>
|
||||
<p>Prepend a Uint8Array with its compact length.
|
||||
<em><strong>param</strong></em>: The Uint8Array to be prefixed</p>
|
||||
<hr>
|
||||
<p><a id="decodeu8a"></a></p>
|
||||
<h2 id="static-decodeu8a"><code><Static></code> decodeU8a</h2>
|
||||
<p><strong>● decodeU8a</strong>: <em><code>compactFromU8a</code></em> = compactFromU8a</p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Compact.ts#L41" target="_blank">codec/Compact.ts:41</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Compact.ts#L41" target="_blank">codec/Compact.ts:41</a></em></p>
|
||||
<hr>
|
||||
<p><a id="encodeu8a"></a></p>
|
||||
<h2 id="static-encodeu8a"><code><Static></code> encodeU8a</h2>
|
||||
<p><strong>● encodeU8a</strong>: <em><code>compactToU8a</code></em> = compactToU8a</p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Compact.ts#L42" target="_blank">codec/Compact.ts:42</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Compact.ts#L42" target="_blank">codec/Compact.ts:42</a></em></p>
|
||||
<hr>
|
||||
<h1 id="accessors">Accessors</h1>
|
||||
<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/d11906e/packages/types/src/codec/Compact.ts#L71" target="_blank">codec/Compact.ts:71</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Compact.ts#L71" target="_blank">codec/Compact.ts:71</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>
|
||||
@@ -2029,14 +2029,14 @@
|
||||
<p><a id="bitlength"></a></p>
|
||||
<h2 id="bitlength">bitLength</h2>
|
||||
<p>▸ <strong>bitLength</strong>(): <a href="../modules/_codec_uint_.md#uintbitlength">UIntBitLength</a></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Compact.ts#L78" target="_blank">codec/Compact.ts:78</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Compact.ts#L78" target="_blank">codec/Compact.ts:78</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Returns the number of bits in the value</p>
|
||||
<p><strong>Returns:</strong> <a href="../modules/_codec_uint_.md#uintbitlength">UIntBitLength</a></p>
|
||||
<hr>
|
||||
<p><a id="tobn"></a></p>
|
||||
<h2 id="tobn">toBn</h2>
|
||||
<p>▸ <strong>toBn</strong>(): <code>BN</code></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Compact.ts#L85" target="_blank">codec/Compact.ts:85</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Compact.ts#L85" target="_blank">codec/Compact.ts:85</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Returns the BN representation of the number</p>
|
||||
<p><strong>Returns:</strong> <code>BN</code></p>
|
||||
<hr>
|
||||
@@ -2044,7 +2044,7 @@
|
||||
<h2 id="tohex">toHex</h2>
|
||||
<p>▸ <strong>toHex</strong>(): <code>any</code></p>
|
||||
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Compact.ts#L92" target="_blank">codec/Compact.ts:92</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Compact.ts#L92" target="_blank">codec/Compact.ts:92</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
|
||||
<p><strong>Returns:</strong> <code>any</code></p>
|
||||
<hr>
|
||||
@@ -2052,14 +2052,14 @@
|
||||
<h2 id="tojson">toJSON</h2>
|
||||
<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>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Compact.ts#L99" target="_blank">codec/Compact.ts:99</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Compact.ts#L99" target="_blank">codec/Compact.ts:99</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="tonumber"></a></p>
|
||||
<h2 id="tonumber">toNumber</h2>
|
||||
<p>▸ <strong>toNumber</strong>(): <code>number</code></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Compact.ts#L106" target="_blank">codec/Compact.ts:106</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Compact.ts#L106" target="_blank">codec/Compact.ts:106</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Returns the number representation for the value</p>
|
||||
<p><strong>Returns:</strong> <code>number</code></p>
|
||||
<hr>
|
||||
@@ -2067,14 +2067,14 @@
|
||||
<h2 id="tostring">toString</h2>
|
||||
<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>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Compact.ts#L113" target="_blank">codec/Compact.ts:113</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Compact.ts#L113" target="_blank">codec/Compact.ts:113</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/d11906e/packages/types/src/codec/Compact.ts#L121" target="_blank">codec/Compact.ts:121</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Compact.ts#L121" target="_blank">codec/Compact.ts:121</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>
|
||||
@@ -2098,7 +2098,7 @@
|
||||
<p><a id="decodecompact"></a></p>
|
||||
<h2 id="static-decodecompact"><code><Static></code> decodeCompact</h2>
|
||||
<p>▸ <strong>decodeCompact</strong>(Type: <em><a href="../modules/_types_.md#constructor">Constructor</a>< <a href="_codec_uint_.uint.html">UInt</a> | <a href="_moment_.moment.html">Moment</a>></em>, value: <em><a href="../modules/_types_.md#anynumber">AnyNumber</a></em>): <a href="_moment_.moment.html">Moment</a> | <a href="_codec_uint_.uint.html">UInt</a></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Compact.ts#L50" target="_blank">codec/Compact.ts:50</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Compact.ts#L50" target="_blank">codec/Compact.ts:50</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -2123,7 +2123,7 @@
|
||||
<p><a id="striplengthprefix"></a></p>
|
||||
<h2 id="static-striplengthprefix"><code><Static></code> stripLengthPrefix</h2>
|
||||
<p>▸ <strong>stripLengthPrefix</strong>(u8a: <em><code>Uint8Array</code></em>, bitLength?: <em><a href="../modules/_codec_uint_.md#uintbitlength">UIntBitLength</a></em>): <code>Uint8Array</code></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Compact.ts#L44" target="_blank">codec/Compact.ts:44</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Compact.ts#L44" target="_blank">codec/Compact.ts:44</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -2151,7 +2151,7 @@
|
||||
<p><a id="with"></a></p>
|
||||
<h2 id="static-with"><code><Static></code> with</h2>
|
||||
<p>▸ <strong>with</strong>(Type: <em><a href="../modules/_types_.md#constructor">Constructor</a>< <a href="_codec_uint_.uint.html">UInt</a> | <a href="_moment_.moment.html">Moment</a>></em>): <a href="../modules/_types_.md#constructor">Constructor</a><<a href="_codec_compact_.compact.html">Compact</a>></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Compact.ts#L27" target="_blank">codec/Compact.ts:27</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Compact.ts#L27" target="_blank">codec/Compact.ts:27</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -2212,7 +2212,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.14","depth":1,"next":{"title":"hidden","level":"4.15","depth":1,"path":"types/classes/_codec_enum_.enum.md","ref":"types/classes/_codec_enum_.enum.md","articles":[]},"previous":{"title":"hidden","level":"4.13","depth":1,"path":"types/classes/_codec_base_.base.md","ref":"types/classes/_codec_base_.base.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/_codec_compact_.compact.md","mtime":"2018-12-17T11:43:52.683Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T11:44:28.801Z"},"basePath":"../..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.14","depth":1,"next":{"title":"hidden","level":"4.15","depth":1,"path":"types/classes/_codec_enum_.enum.md","ref":"types/classes/_codec_enum_.enum.md","articles":[]},"previous":{"title":"hidden","level":"4.13","depth":1,"path":"types/classes/_codec_base_.base.md","ref":"types/classes/_codec_base_.base.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/_codec_compact_.compact.md","mtime":"2018-12-17T13:59:02.133Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T13:59:36.621Z"},"basePath":"../..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -24,7 +24,7 @@
|
||||
|
||||
*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)*
|
||||
|
||||
*Defined in [codec/Compact.ts:22](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Compact.ts#L22)*
|
||||
*Defined in [codec/Compact.ts:22](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Compact.ts#L22)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -45,7 +45,7 @@ ___
|
||||
|
||||
**● addLengthPrefix**: *`compactAddLength`* = compactAddLength
|
||||
|
||||
*Defined in [codec/Compact.ts:40](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Compact.ts#L40)*
|
||||
*Defined in [codec/Compact.ts:40](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Compact.ts#L40)*
|
||||
|
||||
Prepend a Uint8Array with its compact length.
|
||||
*__param__*: The Uint8Array to be prefixed
|
||||
@@ -57,7 +57,7 @@ ___
|
||||
|
||||
**● decodeU8a**: *`compactFromU8a`* = compactFromU8a
|
||||
|
||||
*Defined in [codec/Compact.ts:41](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Compact.ts#L41)*
|
||||
*Defined in [codec/Compact.ts:41](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Compact.ts#L41)*
|
||||
|
||||
___
|
||||
<a id="encodeu8a"></a>
|
||||
@@ -66,7 +66,7 @@ ___
|
||||
|
||||
**● encodeU8a**: *`compactToU8a`* = compactToU8a
|
||||
|
||||
*Defined in [codec/Compact.ts:42](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Compact.ts#L42)*
|
||||
*Defined in [codec/Compact.ts:42](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Compact.ts#L42)*
|
||||
|
||||
___
|
||||
|
||||
@@ -78,7 +78,7 @@ ___
|
||||
|
||||
getencodedLength(): `number`
|
||||
|
||||
*Defined in [codec/Compact.ts:71](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Compact.ts#L71)*
|
||||
*Defined in [codec/Compact.ts:71](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Compact.ts#L71)*
|
||||
|
||||
*__description__*: The length of the value when encoded as a Uint8Array
|
||||
|
||||
@@ -94,7 +94,7 @@ ___
|
||||
|
||||
▸ **bitLength**(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength)
|
||||
|
||||
*Defined in [codec/Compact.ts:78](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Compact.ts#L78)*
|
||||
*Defined in [codec/Compact.ts:78](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Compact.ts#L78)*
|
||||
|
||||
*__description__*: Returns the number of bits in the value
|
||||
|
||||
@@ -107,7 +107,7 @@ ___
|
||||
|
||||
▸ **toBn**(): `BN`
|
||||
|
||||
*Defined in [codec/Compact.ts:85](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Compact.ts#L85)*
|
||||
*Defined in [codec/Compact.ts:85](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Compact.ts#L85)*
|
||||
|
||||
*__description__*: Returns the BN representation of the number
|
||||
|
||||
@@ -122,7 +122,7 @@ ___
|
||||
|
||||
*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)*
|
||||
|
||||
*Defined in [codec/Compact.ts:92](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Compact.ts#L92)*
|
||||
*Defined in [codec/Compact.ts:92](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Compact.ts#L92)*
|
||||
|
||||
*__description__*: Returns a hex string representation of the value
|
||||
|
||||
@@ -137,7 +137,7 @@ ___
|
||||
|
||||
*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)*
|
||||
|
||||
*Defined in [codec/Compact.ts:99](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Compact.ts#L99)*
|
||||
*Defined in [codec/Compact.ts:99](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Compact.ts#L99)*
|
||||
|
||||
*__description__*: Converts the Object to JSON, typically used for RPC transfers
|
||||
|
||||
@@ -150,7 +150,7 @@ ___
|
||||
|
||||
▸ **toNumber**(): `number`
|
||||
|
||||
*Defined in [codec/Compact.ts:106](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Compact.ts#L106)*
|
||||
*Defined in [codec/Compact.ts:106](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Compact.ts#L106)*
|
||||
|
||||
*__description__*: Returns the number representation for the value
|
||||
|
||||
@@ -165,7 +165,7 @@ ___
|
||||
|
||||
*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)*
|
||||
|
||||
*Defined in [codec/Compact.ts:113](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Compact.ts#L113)*
|
||||
*Defined in [codec/Compact.ts:113](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Compact.ts#L113)*
|
||||
|
||||
*__description__*: Returns the string representation of the value
|
||||
|
||||
@@ -178,7 +178,7 @@ ___
|
||||
|
||||
▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array`
|
||||
|
||||
*Defined in [codec/Compact.ts:121](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Compact.ts#L121)*
|
||||
*Defined in [codec/Compact.ts:121](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Compact.ts#L121)*
|
||||
|
||||
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
|
||||
|
||||
@@ -197,7 +197,7 @@ ___
|
||||
|
||||
▸ **decodeCompact**(Type: *[Constructor](../modules/_types_.md#constructor)< [UInt](_codec_uint_.uint.md) | [Moment](_moment_.moment.md)>*, value: *[AnyNumber](../modules/_types_.md#anynumber)*): [Moment](_moment_.moment.md) | [UInt](_codec_uint_.uint.md)
|
||||
|
||||
*Defined in [codec/Compact.ts:50](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Compact.ts#L50)*
|
||||
*Defined in [codec/Compact.ts:50](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Compact.ts#L50)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -215,7 +215,7 @@ ___
|
||||
|
||||
▸ **stripLengthPrefix**(u8a: *`Uint8Array`*, bitLength?: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `Uint8Array`
|
||||
|
||||
*Defined in [codec/Compact.ts:44](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Compact.ts#L44)*
|
||||
*Defined in [codec/Compact.ts:44](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Compact.ts#L44)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -233,7 +233,7 @@ ___
|
||||
|
||||
▸ **with**(Type: *[Constructor](../modules/_types_.md#constructor)< [UInt](_codec_uint_.uint.md) | [Moment](_moment_.moment.md)>*): [Constructor](../modules/_types_.md#constructor)<[Compact](_codec_compact_.compact.md)>
|
||||
|
||||
*Defined in [codec/Compact.ts:27](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Compact.ts#L27)*
|
||||
*Defined in [codec/Compact.ts:27](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Compact.ts#L27)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -1977,7 +1977,7 @@
|
||||
<h2 id="constructor">constructor</h2>
|
||||
<p>⊕ <strong>new Enum</strong>(def: <em><code>EnumDef</code></em>, value?: <em> <a href="_codec_enum_.enum.html">Enum</a> | <code>Uint8Array</code> | <code>string</code> | <code>number</code></em>): <a href="_codec_enum_.enum.html">Enum</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/d11906e/packages/types/src/codec/Enum.ts#L29" target="_blank">codec/Enum.ts:29</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Enum.ts#L29" target="_blank">codec/Enum.ts:29</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -2006,7 +2006,7 @@
|
||||
<p><a id="encodedlength"></a></p>
|
||||
<h2 id="encodedlength">encodedLength</h2>
|
||||
<p>getencodedLength(): <code>number</code></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Enum.ts#L64" target="_blank">codec/Enum.ts:64</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Enum.ts#L64" target="_blank">codec/Enum.ts:64</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>
|
||||
@@ -2015,7 +2015,7 @@
|
||||
<h2 id="tohex">toHex</h2>
|
||||
<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>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Enum.ts#L71" target="_blank">codec/Enum.ts:71</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Enum.ts#L71" target="_blank">codec/Enum.ts:71</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>
|
||||
@@ -2023,14 +2023,14 @@
|
||||
<h2 id="tojson">toJSON</h2>
|
||||
<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>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Enum.ts#L78" target="_blank">codec/Enum.ts:78</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Enum.ts#L78" target="_blank">codec/Enum.ts:78</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="tonumber"></a></p>
|
||||
<h2 id="tonumber">toNumber</h2>
|
||||
<p>▸ <strong>toNumber</strong>(): <code>number</code></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Enum.ts#L85" target="_blank">codec/Enum.ts:85</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Enum.ts#L85" target="_blank">codec/Enum.ts:85</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Returns the number representation for the value</p>
|
||||
<p><strong>Returns:</strong> <code>number</code></p>
|
||||
<hr>
|
||||
@@ -2038,14 +2038,14 @@
|
||||
<h2 id="tostring">toString</h2>
|
||||
<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>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Enum.ts#L92" target="_blank">codec/Enum.ts:92</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Enum.ts#L92" target="_blank">codec/Enum.ts:92</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/d11906e/packages/types/src/codec/Enum.ts#L100" target="_blank">codec/Enum.ts:100</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Enum.ts#L100" target="_blank">codec/Enum.ts:100</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>
|
||||
@@ -2069,7 +2069,7 @@
|
||||
<p><a id="decodeenum"></a></p>
|
||||
<h2 id="static-decodeenum"><code><Static></code> decodeEnum</h2>
|
||||
<p>▸ <strong>decodeEnum</strong>(def: <em><code>EnumDef</code></em>, value: <em> <a href="_codec_enum_.enum.html">Enum</a> | <code>Uint8Array</code> | <code>string</code> | <code>number</code></em>): <code>number</code> | <code>undefined</code></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Enum.ts#L47" target="_blank">codec/Enum.ts:47</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Enum.ts#L47" target="_blank">codec/Enum.ts:47</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -2134,7 +2134,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.15","depth":1,"next":{"title":"hidden","level":"4.16","depth":1,"path":"types/classes/_codec_enumtype_.enumtype.md","ref":"types/classes/_codec_enumtype_.enumtype.md","articles":[]},"previous":{"title":"hidden","level":"4.14","depth":1,"path":"types/classes/_codec_compact_.compact.md","ref":"types/classes/_codec_compact_.compact.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/_codec_enum_.enum.md","mtime":"2018-12-17T11:43:52.695Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T11:44:28.801Z"},"basePath":"../..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.15","depth":1,"next":{"title":"hidden","level":"4.16","depth":1,"path":"types/classes/_codec_enumtype_.enumtype.md","ref":"types/classes/_codec_enumtype_.enumtype.md","articles":[]},"previous":{"title":"hidden","level":"4.14","depth":1,"path":"types/classes/_codec_compact_.compact.md","ref":"types/classes/_codec_compact_.compact.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/_codec_enum_.enum.md","mtime":"2018-12-17T13:59:02.149Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T13:59:36.621Z"},"basePath":"../..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -30,7 +30,7 @@
|
||||
|
||||
*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)*
|
||||
|
||||
*Defined in [codec/Enum.ts:29](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Enum.ts#L29)*
|
||||
*Defined in [codec/Enum.ts:29](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Enum.ts#L29)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -51,7 +51,7 @@ ___
|
||||
|
||||
getencodedLength(): `number`
|
||||
|
||||
*Defined in [codec/Enum.ts:64](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Enum.ts#L64)*
|
||||
*Defined in [codec/Enum.ts:64](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Enum.ts#L64)*
|
||||
|
||||
*__description__*: The length of the value when encoded as a Uint8Array
|
||||
|
||||
@@ -69,7 +69,7 @@ ___
|
||||
|
||||
*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)*
|
||||
|
||||
*Defined in [codec/Enum.ts:71](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Enum.ts#L71)*
|
||||
*Defined in [codec/Enum.ts:71](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Enum.ts#L71)*
|
||||
|
||||
*__description__*: Returns a hex string representation of the value
|
||||
|
||||
@@ -84,7 +84,7 @@ ___
|
||||
|
||||
*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)*
|
||||
|
||||
*Defined in [codec/Enum.ts:78](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Enum.ts#L78)*
|
||||
*Defined in [codec/Enum.ts:78](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Enum.ts#L78)*
|
||||
|
||||
*__description__*: Converts the Object to JSON, typically used for RPC transfers
|
||||
|
||||
@@ -97,7 +97,7 @@ ___
|
||||
|
||||
▸ **toNumber**(): `number`
|
||||
|
||||
*Defined in [codec/Enum.ts:85](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Enum.ts#L85)*
|
||||
*Defined in [codec/Enum.ts:85](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Enum.ts#L85)*
|
||||
|
||||
*__description__*: Returns the number representation for the value
|
||||
|
||||
@@ -112,7 +112,7 @@ ___
|
||||
|
||||
*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)*
|
||||
|
||||
*Defined in [codec/Enum.ts:92](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Enum.ts#L92)*
|
||||
*Defined in [codec/Enum.ts:92](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Enum.ts#L92)*
|
||||
|
||||
*__description__*: Returns the string representation of the value
|
||||
|
||||
@@ -125,7 +125,7 @@ ___
|
||||
|
||||
▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array`
|
||||
|
||||
*Defined in [codec/Enum.ts:100](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Enum.ts#L100)*
|
||||
*Defined in [codec/Enum.ts:100](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Enum.ts#L100)*
|
||||
|
||||
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
|
||||
|
||||
@@ -144,7 +144,7 @@ ___
|
||||
|
||||
▸ **decodeEnum**(def: *`EnumDef`*, value: * [Enum](_codec_enum_.enum.md) | `Uint8Array` | `string` | `number`*): `number` | `undefined`
|
||||
|
||||
*Defined in [codec/Enum.ts:47](https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/Enum.ts#L47)*
|
||||
*Defined in [codec/Enum.ts:47](https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/Enum.ts#L47)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -1981,7 +1981,7 @@
|
||||
<h2 id="constructor">constructor</h2>
|
||||
<p>⊕ <strong>new EnumType</strong>(def: <em><code>TypesDef</code></em>, value?: <em><code>any</code></em>, index?: <em> <code>number</code> | <a href="_codec_enumtype_.enumtype.html">EnumType</a><<code>T</code>></em>): <a href="_codec_enumtype_.enumtype.html">EnumType</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/d11906e/packages/types/src/codec/EnumType.ts#L32" target="_blank">codec/EnumType.ts:32</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/EnumType.ts#L32" target="_blank">codec/EnumType.ts:32</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -2011,35 +2011,35 @@
|
||||
<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/d11906e/packages/types/src/codec/EnumType.ts#L90" target="_blank">codec/EnumType.ts:90</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/EnumType.ts#L90" target="_blank">codec/EnumType.ts:90</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="isnone"></a></p>
|
||||
<h2 id="isnone">isNone</h2>
|
||||
<p>getisNone(): <code>boolean</code></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/EnumType.ts#L97" target="_blank">codec/EnumType.ts:97</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/EnumType.ts#L97" target="_blank">codec/EnumType.ts:97</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Checks if the Enum points to a <a href="_null_.null.html">Null</a> type</p>
|
||||
<p><strong>Returns:</strong> <code>boolean</code></p>
|
||||
<hr>
|
||||
<p><a id="isnull"></a></p>
|
||||
<h2 id="isnull">isNull</h2>
|
||||
<p>getisNull(): <code>boolean</code></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/EnumType.ts#L104" target="_blank">codec/EnumType.ts:104</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/EnumType.ts#L104" target="_blank">codec/EnumType.ts:104</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Checks if the Enum points to a <a href="_null_.null.html">Null</a> type (deprecated, use isNone)</p>
|
||||
<p><strong>Returns:</strong> <code>boolean</code></p>
|
||||
<hr>
|
||||
<p><a id="type"></a></p>
|
||||
<h2 id="type">type</h2>
|
||||
<p>gettype(): <code>string</code></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/EnumType.ts#L111" target="_blank">codec/EnumType.ts:111</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/EnumType.ts#L111" target="_blank">codec/EnumType.ts:111</a></em></p>
|
||||
<p><em><strong>description</strong></em>: The name of the type this enum value represents</p>
|
||||
<p><strong>Returns:</strong> <code>string</code></p>
|
||||
<hr>
|
||||
<p><a id="value"></a></p>
|
||||
<h2 id="value">value</h2>
|
||||
<p>getvalue(): <a href="../interfaces/_types_.codec.md">Codec</a></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/EnumType.ts#L118" target="_blank">codec/EnumType.ts:118</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/EnumType.ts#L118" target="_blank">codec/EnumType.ts:118</a></em></p>
|
||||
<p><em><strong>description</strong></em>: The value of the enum</p>
|
||||
<p><strong>Returns:</strong> <a href="../interfaces/_types_.codec.md">Codec</a></p>
|
||||
<hr>
|
||||
@@ -2048,7 +2048,7 @@
|
||||
<h2 id="tohex">toHex</h2>
|
||||
<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>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/EnumType.ts#L125" target="_blank">codec/EnumType.ts:125</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/EnumType.ts#L125" target="_blank">codec/EnumType.ts:125</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>
|
||||
@@ -2056,14 +2056,14 @@
|
||||
<h2 id="tojson">toJSON</h2>
|
||||
<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>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/EnumType.ts#L132" target="_blank">codec/EnumType.ts:132</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/EnumType.ts#L132" target="_blank">codec/EnumType.ts:132</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="tonumber"></a></p>
|
||||
<h2 id="tonumber">toNumber</h2>
|
||||
<p>▸ <strong>toNumber</strong>(): <code>number</code></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/EnumType.ts#L139" target="_blank">codec/EnumType.ts:139</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/EnumType.ts#L139" target="_blank">codec/EnumType.ts:139</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Returns the number representation for the value</p>
|
||||
<p><strong>Returns:</strong> <code>number</code></p>
|
||||
<hr>
|
||||
@@ -2071,14 +2071,14 @@
|
||||
<h2 id="tostring">toString</h2>
|
||||
<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>Defined in <a href="https://github.com/polkadot-js/api/blob/d11906e/packages/types/src/codec/EnumType.ts#L146" target="_blank">codec/EnumType.ts:146</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/EnumType.ts#L146" target="_blank">codec/EnumType.ts:146</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/d11906e/packages/types/src/codec/EnumType.ts#L154" target="_blank">codec/EnumType.ts:154</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/5f1178f/packages/types/src/codec/EnumType.ts#L154" target="_blank">codec/EnumType.ts:154</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>
|
||||
@@ -2142,7 +2142,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.16","depth":1,"next":{"title":"hidden","level":"4.17","depth":1,"path":"types/classes/_codec_option_.option.md","ref":"types/classes/_codec_option_.option.md","articles":[]},"previous":{"title":"hidden","level":"4.15","depth":1,"path":"types/classes/_codec_enum_.enum.md","ref":"types/classes/_codec_enum_.enum.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/_codec_enumtype_.enumtype.md","mtime":"2018-12-17T11:43:52.715Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T11:44:28.801Z"},"basePath":"../..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.16","depth":1,"next":{"title":"hidden","level":"4.17","depth":1,"path":"types/classes/_codec_option_.option.md","ref":"types/classes/_codec_option_.option.md","articles":[]},"previous":{"title":"hidden","level":"4.15","depth":1,"path":"types/classes/_codec_enum_.enum.md","ref":"types/classes/_codec_enum_.enum.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/_codec_enumtype_.enumtype.md","mtime":"2018-12-17T13:59:02.169Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-17T13:59:36.621Z"},"basePath":"../..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user