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

[CI Skip] 0.30.26

Browse Source
This commit is contained in:
Travis CI
2018-10-05 06:46:31 +00:00
parent fd596a1eb4
commit 2bc61b30b3
156 changed files with 2021 additions and 1922 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api-rx/classes/_index_.rxapi.html
+17 -11
View File
@@ -369,10 +369,16 @@
<section class="normal markdown-section">
<p>An RxJs wrapper around the [[api]].
<em><strong>example</strong></em>: import RxApi from &apos;@polkadot/api&apos;; import WsProvider from &apos;@polkadot/api-provider/ws&apos;;</p>
<p>const provider = new WsProvider(&apos;<a href="http://127.0.0.1:9944&apos;" target="_blank">http://127.0.0.1:9944&apos;)</a>); const rxapi = new RxApi(provider);</p>
<h1 id="hierarchy">Hierarchy</h1>
<p><em><strong>name</strong></em>: RxApi</p>
<p><em><strong>summary</strong></em>: The RxJS API is a wrapper around the API.</p>
<p><em><strong>description</strong></em>: It allows wrapping API components with observables using RxJS.</p>
<p><em><strong>example</strong></em>: </p>
<pre><code>import RxApi from &apos;@polkadot/api&apos;;
import WsProvider from &apos;@polkadot/api-provider/ws&apos;;
const provider = new WsProvider(&apos;http://127.0.0.1:9944&apos;);
const rxapi = new RxApi(provider);
</code></pre><h1 id="hierarchy">Hierarchy</h1>
<p><strong>RxApi</strong></p>
<h1 id="implements">Implements</h1>
<ul>
@@ -382,7 +388,7 @@
<p><a id="constructor"></a></p>
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new RxApi</strong>(provider?: <em><code>ProviderInterface</code></em>): <a href="_index_.rxapi.html">RxApi</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/522eae6/packages/api-rx/src/index.ts#L40" target="_blank">index.ts:40</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd596a1/packages/api-rx/src/index.ts#L44" target="_blank">index.ts:44</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -408,28 +414,28 @@
<p><a id="author"></a></p>
<h2 id="author">author</h2>
<p><strong>&#x25CF; author</strong>: <em><a href="../modules/_types_d_.md#rxapiinterface_section">RxApiInterface$Section</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/522eae6/packages/api-rx/src/index.ts#L37" target="_blank">index.ts:37</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd596a1/packages/api-rx/src/index.ts#L41" target="_blank">index.ts:41</a></em></p>
<hr>
<p><a id="chain"></a></p>
<h2 id="chain">chain</h2>
<p><strong>&#x25CF; chain</strong>: <em><a href="../modules/_types_d_.md#rxapiinterface_section">RxApiInterface$Section</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/522eae6/packages/api-rx/src/index.ts#L38" target="_blank">index.ts:38</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd596a1/packages/api-rx/src/index.ts#L42" target="_blank">index.ts:42</a></em></p>
<hr>
<p><a id="state"></a></p>
<h2 id="state">state</h2>
<p><strong>&#x25CF; state</strong>: <em><a href="../modules/_types_d_.md#rxapiinterface_section">RxApiInterface$Section</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/522eae6/packages/api-rx/src/index.ts#L39" target="_blank">index.ts:39</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd596a1/packages/api-rx/src/index.ts#L43" target="_blank">index.ts:43</a></em></p>
<hr>
<p><a id="system"></a></p>
<h2 id="system">system</h2>
<p><strong>&#x25CF; system</strong>: <em><a href="../modules/_types_d_.md#rxapiinterface_section">RxApiInterface$Section</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/522eae6/packages/api-rx/src/index.ts#L40" target="_blank">index.ts:40</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd596a1/packages/api-rx/src/index.ts#L44" target="_blank">index.ts:44</a></em></p>
<hr>
<h1 id="methods">Methods</h1>
<p><a id="isconnected"></a></p>
<h2 id="isconnected">isConnected</h2>
<p>&#x25B8; <strong>isConnected</strong>(): <code>BehaviorSubject</code>&lt;<code>boolean</code>&gt;</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/522eae6/packages/api-rx/src/index.ts#L59" target="_blank">index.ts:59</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd596a1/packages/api-rx/src/index.ts#L63" target="_blank">index.ts:63</a></em></p>
<p><strong>Returns:</strong> <code>BehaviorSubject</code>&lt;<code>boolean</code>&gt;</p>
<hr>
@@ -475,7 +481,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"ApiRx","level":"1.4.1","depth":2,"next":{"title":"Overview","level":"2.1","depth":1,"path":"examples/README.md","ref":"examples/README.md","articles":[]},"previous":{"title":"api-rx","level":"1.4","depth":1,"path":"api-rx/README.md","ref":"api-rx/README.md","articles":[{"title":"ApiRx","level":"1.4.1","depth":2,"path":"api-rx/classes/_index_.rxapi.md","ref":"api-rx/classes/_index_.rxapi.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["include-codeblock"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"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-rx/classes/_index_.rxapi.md","mtime":"2018-10-04T20:14:16.998Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-04T20:14:53.260Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"ApiRx","level":"1.4.1","depth":2,"next":{"title":"Overview","level":"2.1","depth":1,"path":"examples/README.md","ref":"examples/README.md","articles":[]},"previous":{"title":"api-rx","level":"1.4","depth":1,"path":"api-rx/README.md","ref":"api-rx/README.md","articles":[{"title":"ApiRx","level":"1.4.1","depth":2,"path":"api-rx/classes/_index_.rxapi.md","ref":"api-rx/classes/_index_.rxapi.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["include-codeblock"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"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-rx/classes/_index_.rxapi.md","mtime":"2018-10-05T06:45:44.125Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-05T06:46:24.745Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>