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

[CI Skip] 0.29.11

Browse Source
This commit is contained in:
Travis CI
2018-09-26 05:30:33 +00:00
parent f399bb6fd6
commit 7eb2b29201
56 changed files with 292 additions and 298 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api-rx/classes/_index_.rxapi.html
+7 -7
View File
@@ -386,7 +386,7 @@ const rxapi = new RxApi(provider);
<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/964bf84/packages/api-rx/src/index.ts#L43" target="_blank">index.ts:43</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f399bb6/packages/api-rx/src/index.ts#L43" target="_blank">index.ts:43</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -412,28 +412,28 @@ const rxapi = new RxApi(provider);
<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/964bf84/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/f399bb6/packages/api-rx/src/index.ts#L40" target="_blank">index.ts:40</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/964bf84/packages/api-rx/src/index.ts#L41" target="_blank">index.ts:41</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f399bb6/packages/api-rx/src/index.ts#L41" target="_blank">index.ts:41</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/964bf84/packages/api-rx/src/index.ts#L42" target="_blank">index.ts:42</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f399bb6/packages/api-rx/src/index.ts#L42" target="_blank">index.ts:42</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/964bf84/packages/api-rx/src/index.ts#L43" target="_blank">index.ts:43</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f399bb6/packages/api-rx/src/index.ts#L43" target="_blank">index.ts:43</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/964bf84/packages/api-rx/src/index.ts#L62" target="_blank">index.ts:62</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f399bb6/packages/api-rx/src/index.ts#L62" target="_blank">index.ts:62</a></em></p>
<p><strong>Returns:</strong> <code>BehaviorSubject</code>&lt;<code>boolean</code>&gt;</p>
<hr>
@@ -479,7 +479,7 @@ const rxapi = new RxApi(provider);
<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-09-25T16:27:04.340Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-09-25T16:27:51.734Z"},"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-09-26T05:29:57.264Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-09-26T05:30:25.997Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/api-rx/classes/_index_.rxapi.md
+8 -11
View File
@@ -1,10 +1,7 @@
An RxJs wrapper around the \[\[api\]\].
*__example__*:
```javascript
*__example__*: ```javascript
import RxApi from '@polkadot/api';
import WsProvider from '@polkadot/api-provider/ws';
@@ -28,13 +25,13 @@ const rxapi = new RxApi(provider);
⊕ **new RxApi**(provider?: *`ProviderInterface`*): [RxApi](_index_.rxapi.md)
*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/964bf84/packages/api-rx/src/index.ts#L43)*
*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/f399bb6/packages/api-rx/src/index.ts#L43)*
**Parameters:**
| Param | Type | Default value | Description |
| ------ | ------ | ------ | ------ |
| `Default value` provider | `ProviderInterface` | `new Ws(defaults.WS_URL)` | An API provider using HTTP or WebSocket |
| `Default value` provider | `ProviderInterface` | new Ws(defaults.WS_URL) | An API provider using HTTP or WebSocket |
**Returns:** [RxApi](_index_.rxapi.md)
@@ -48,7 +45,7 @@ ___
**● author**: *[RxApiInterface$Section](../modules/_types_d_.md#rxapiinterface_section)*
*Defined in [index.ts:40](https://github.com/polkadot-js/api/blob/964bf84/packages/api-rx/src/index.ts#L40)*
*Defined in [index.ts:40](https://github.com/polkadot-js/api/blob/f399bb6/packages/api-rx/src/index.ts#L40)*
___
<a id="chain"></a>
@@ -57,7 +54,7 @@ ___
**● chain**: *[RxApiInterface$Section](../modules/_types_d_.md#rxapiinterface_section)*
*Defined in [index.ts:41](https://github.com/polkadot-js/api/blob/964bf84/packages/api-rx/src/index.ts#L41)*
*Defined in [index.ts:41](https://github.com/polkadot-js/api/blob/f399bb6/packages/api-rx/src/index.ts#L41)*
___
<a id="state"></a>
@@ -66,7 +63,7 @@ ___
**● state**: *[RxApiInterface$Section](../modules/_types_d_.md#rxapiinterface_section)*
*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/964bf84/packages/api-rx/src/index.ts#L42)*
*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/f399bb6/packages/api-rx/src/index.ts#L42)*
___
<a id="system"></a>
@@ -75,7 +72,7 @@ ___
**● system**: *[RxApiInterface$Section](../modules/_types_d_.md#rxapiinterface_section)*
*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/964bf84/packages/api-rx/src/index.ts#L43)*
*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/f399bb6/packages/api-rx/src/index.ts#L43)*
___
@@ -87,7 +84,7 @@ ___
▸ **isConnected**(): `BehaviorSubject`<`boolean`>
*Defined in [index.ts:62](https://github.com/polkadot-js/api/blob/964bf84/packages/api-rx/src/index.ts#L62)*
*Defined in [index.ts:62](https://github.com/polkadot-js/api/blob/f399bb6/packages/api-rx/src/index.ts#L62)*
**Returns:** `BehaviorSubject`<`boolean`>
docs/api-rx/index.html
+1 -1
View File
@@ -415,7 +415,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"api-rx","level":"1.4","depth":1,"next":{"title":"ApiRx","level":"1.4.1","depth":2,"path":"api-rx/classes/_index_.rxapi.md","ref":"api-rx/classes/_index_.rxapi.md","articles":[]},"previous":{"title":"WsProvider","level":"1.3.2","depth":2,"path":"api-provider/classes/_ws_index_.wsprovider.md","ref":"api-provider/classes/_ws_index_.wsprovider.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/README.md","mtime":"2018-09-25T16:27:04.208Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-09-25T16:27:51.734Z"},"basePath":"..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"api-rx","level":"1.4","depth":1,"next":{"title":"ApiRx","level":"1.4.1","depth":2,"path":"api-rx/classes/_index_.rxapi.md","ref":"api-rx/classes/_index_.rxapi.md","articles":[]},"previous":{"title":"WsProvider","level":"1.3.2","depth":2,"path":"api-provider/classes/_ws_index_.wsprovider.md","ref":"api-provider/classes/_ws_index_.wsprovider.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/README.md","mtime":"2018-09-26T05:29:57.164Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-09-26T05:30:25.997Z"},"basePath":"..","book":{"language":""}});
});
</script>
</div>
docs/api-rx/modules/_types_d_.md
+3 -3
View File
@@ -9,7 +9,7 @@
**Ƭ RxApiInterface**: * `RxApiInterface$Keys` & `object`
*
*Defined in [types.d.ts:19](https://github.com/polkadot-js/api/blob/964bf84/packages/api-rx/src/types.d.ts#L19)*
*Defined in [types.d.ts:19](https://github.com/polkadot-js/api/blob/f399bb6/packages/api-rx/src/types.d.ts#L19)*
___
<a id="rxapiinterface_method"></a>
@@ -18,7 +18,7 @@ ___
**Ƭ RxApiInterface$Method**: *`function`*
*Defined in [types.d.ts:9](https://github.com/polkadot-js/api/blob/964bf84/packages/api-rx/src/types.d.ts#L9)*
*Defined in [types.d.ts:9](https://github.com/polkadot-js/api/blob/f399bb6/packages/api-rx/src/types.d.ts#L9)*
#### Type declaration
▸(...params: *`Array`<`any`>*): `Observable`<`any`> &#124; `BehaviorSubject`<`any`>
@@ -38,7 +38,7 @@ ___
**Ƭ RxApiInterface$Section**: *`object`*
*Defined in [types.d.ts:11](https://github.com/polkadot-js/api/blob/964bf84/packages/api-rx/src/types.d.ts#L11)*
*Defined in [types.d.ts:11](https://github.com/polkadot-js/api/blob/f399bb6/packages/api-rx/src/types.d.ts#L11)*
#### Type declaration