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

[CI Skip] 0.31.4

Browse Source
This commit is contained in:
Travis CI
2018-10-10 18:23:34 +00:00
parent 7180f8958e
commit a9c195bf1e
200 changed files with 5946 additions and 2244 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/rpc-rx/classes/_index_.rpcrx.md
+237 -7
View File
@@ -15,9 +15,14 @@ const provider = new WsProvider('http://127.0.0.1:9944');
const api = new RpcRx(provider);
```
# Type parameters
#### EventTypes : `string` | `symbol`
# Hierarchy
**RpcRx**
`EventEmitter`
**↳ RpcRx**
# Implements
@@ -31,7 +36,7 @@ const api = new RpcRx(provider);
⊕ **new RpcRx**(provider?: *`ProviderInterface`*): [RpcRx](_index_.rpcrx.md)
*Defined in [index.ts:46](https://github.com/polkadot-js/api/blob/267411d/packages/rpc-rx/src/index.ts#L46)*
*Defined in [index.ts:47](https://github.com/polkadot-js/api/blob/7180f89/packages/rpc-rx/src/index.ts#L47)*
**Parameters:**
@@ -51,7 +56,7 @@ ___
**● author**: *[RxRpcInterface$Section](../modules/_types_d_.md#rxrpcinterface_section)*
*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/267411d/packages/rpc-rx/src/index.ts#L43)*
*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/7180f89/packages/rpc-rx/src/index.ts#L44)*
___
<a id="chain"></a>
@@ -60,7 +65,7 @@ ___
**● chain**: *[RxRpcInterface$Section](../modules/_types_d_.md#rxrpcinterface_section)*
*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/267411d/packages/rpc-rx/src/index.ts#L44)*
*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/7180f89/packages/rpc-rx/src/index.ts#L45)*
___
<a id="state"></a>
@@ -69,7 +74,7 @@ ___
**● state**: *[RxRpcInterface$Section](../modules/_types_d_.md#rxrpcinterface_section)*
*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/267411d/packages/rpc-rx/src/index.ts#L45)*
*Defined in [index.ts:46](https://github.com/polkadot-js/api/blob/7180f89/packages/rpc-rx/src/index.ts#L46)*
___
<a id="system"></a>
@@ -78,21 +83,246 @@ ___
**● system**: *[RxRpcInterface$Section](../modules/_types_d_.md#rxrpcinterface_section)*
*Defined in [index.ts:46](https://github.com/polkadot-js/api/blob/267411d/packages/rpc-rx/src/index.ts#L46)*
*Defined in [index.ts:47](https://github.com/polkadot-js/api/blob/7180f89/packages/rpc-rx/src/index.ts#L47)*
___
<a id="prefixed"></a>
## `<Static>` prefixed
**● prefixed**: * `string` &#124; `boolean`
*
*Inherited from EventEmitter.prefixed*
*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:6*
___
# Methods
<a id="addlistener"></a>
## addListener
▸ **addListener**(event: *`EventTypes`*, fn: *`ListenerFn`*, context?: *`any`*): `this`
*Inherited from EventEmitter.addListener*
*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:33*
**Parameters:**
| Param | Type |
| ------ | ------ |
| event | `EventTypes` |
| fn | `ListenerFn` |
| `Optional` context | `any` |
**Returns:** `this`
___
<a id="emit"></a>
## emit
▸ **emit**(event: *`EventTypes`*, ...args: *`Array`<`any`>*): `boolean`
*Inherited from EventEmitter.emit*
*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:27*
Calls each of the listeners registered for a given event.
**Parameters:**
| Param | Type |
| ------ | ------ |
| event | `EventTypes` |
| `Rest` args | `Array`<`any`> |
**Returns:** `boolean`
___
<a id="eventnames"></a>
## eventNames
▸ **eventNames**(): `Array`<`EventTypes`>
*Inherited from EventEmitter.eventNames*
*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:12*
Return an array listing the events for which the emitter has registered listeners.
**Returns:** `Array`<`EventTypes`>
___
<a id="isconnected"></a>
## isConnected
▸ **isConnected**(): `BehaviorSubject`<`boolean`>
*Defined in [index.ts:65](https://github.com/polkadot-js/api/blob/267411d/packages/rpc-rx/src/index.ts#L65)*
*Defined in [index.ts:67](https://github.com/polkadot-js/api/blob/7180f89/packages/rpc-rx/src/index.ts#L67)*
**Returns:** `BehaviorSubject`<`boolean`>
___
<a id="listenercount"></a>
## listenerCount
▸ **listenerCount**(event: *`EventTypes`*): `number`
*Inherited from EventEmitter.listenerCount*
*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:22*
Return the number of listeners listening to a given event.
**Parameters:**
| Param | Type |
| ------ | ------ |
| event | `EventTypes` |
**Returns:** `number`
___
<a id="listeners"></a>
## listeners
▸ **listeners**(event: *`EventTypes`*): `Array`<`ListenerFn`>
*Inherited from EventEmitter.listeners*
*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:17*
Return the listeners registered for a given event.
**Parameters:**
| Param | Type |
| ------ | ------ |
| event | `EventTypes` |
**Returns:** `Array`<`ListenerFn`>
___
<a id="off"></a>
## off
▸ **off**(event: *`EventTypes`*, fn?: *[ListenerFn](../interfaces/_index_.rpcrx.eventemitter.listenerfn.md)*, context?: *`any`*, once?: * `undefined` &#124; `false` &#124; `true`*): `this`
*Inherited from EventEmitter.off*
*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:44*
**Parameters:**
| Param | Type |
| ------ | ------ |
| event | `EventTypes` |
| `Optional` fn | [ListenerFn](../interfaces/_index_.rpcrx.eventemitter.listenerfn.md) |
| `Optional` context | `any` |
| `Optional` once | `undefined` &#124; `false` &#124; `true`|
**Returns:** `this`
___
<a id="on"></a>
## on
▸ **on**(event: *`EventTypes`*, fn: *`ListenerFn`*, context?: *`any`*): `this`
*Inherited from EventEmitter.on*
*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:32*
Add a listener for a given event.
**Parameters:**
| Param | Type |
| ------ | ------ |
| event | `EventTypes` |
| fn | `ListenerFn` |
| `Optional` context | `any` |
**Returns:** `this`
___
<a id="once"></a>
## once
▸ **once**(event: *`EventTypes`*, fn: *`ListenerFn`*, context?: *`any`*): `this`
*Inherited from EventEmitter.once*
*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:38*
Add a one-time listener for a given event.
**Parameters:**
| Param | Type |
| ------ | ------ |
| event | `EventTypes` |
| fn | `ListenerFn` |
| `Optional` context | `any` |
**Returns:** `this`
___
<a id="removealllisteners"></a>
## removeAllListeners
▸ **removeAllListeners**(event?: *[EventTypes]()*): `this`
*Inherited from EventEmitter.removeAllListeners*
*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:49*
Remove all listeners, or those of the specified event.
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` event | [EventTypes]() |
**Returns:** `this`
___
<a id="removelistener"></a>
## removeListener
▸ **removeListener**(event: *`EventTypes`*, fn?: *[ListenerFn](../interfaces/_index_.rpcrx.eventemitter.listenerfn.md)*, context?: *`any`*, once?: * `undefined` &#124; `false` &#124; `true`*): `this`
*Inherited from EventEmitter.removeListener*
*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:43*
Remove the listeners of a given event.
**Parameters:**
| Param | Type |
| ------ | ------ |
| event | `EventTypes` |
| `Optional` fn | [ListenerFn](../interfaces/_index_.rpcrx.eventemitter.listenerfn.md) |
| `Optional` context | `any` |
| `Optional` once | `undefined` &#124; `false` &#124; `true`|
**Returns:** `this`
___
docs/rpc-rx/index.html
+40 -8
View File
@@ -112,7 +112,39 @@
</li>
<li class="chapter " data-level="1.2" data-path="../rpc-core/">
<li class="chapter " data-level="1.2" data-path="../api/">
<a href="../api/">
api
</a>
<ul class="articles">
<li class="chapter " data-level="1.2.1" data-path="../api/classes/_rx_index_.apirx.html">
<a href="../api/classes/_rx_index_.apirx.html">
ApiRx
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.3" data-path="../rpc-core/">
<a href="../rpc-core/">
@@ -126,7 +158,7 @@
<ul class="articles">
<li class="chapter " data-level="1.2.1" data-path="../rpc-core/classes/_index_.rpc.html">
<li class="chapter " data-level="1.3.1" data-path="../rpc-core/classes/_index_.rpc.html">
<a href="../rpc-core/classes/_index_.rpc.html">
@@ -144,7 +176,7 @@
</li>
<li class="chapter " data-level="1.3" data-path="../rpc-provider/">
<li class="chapter " data-level="1.4" data-path="../rpc-provider/">
<a href="../rpc-provider/">
@@ -158,7 +190,7 @@
<ul class="articles">
<li class="chapter " data-level="1.3.1" data-path="../rpc-provider/classes/_http_index_.httpprovider.html">
<li class="chapter " data-level="1.4.1" data-path="../rpc-provider/classes/_http_index_.httpprovider.html">
<a href="../rpc-provider/classes/_http_index_.httpprovider.html">
@@ -171,7 +203,7 @@
</li>
<li class="chapter " data-level="1.3.2" data-path="../rpc-provider/classes/_ws_index_.wsprovider.html">
<li class="chapter " data-level="1.4.2" data-path="../rpc-provider/classes/_ws_index_.wsprovider.html">
<a href="../rpc-provider/classes/_ws_index_.wsprovider.html">
@@ -189,7 +221,7 @@
</li>
<li class="chapter active" data-level="1.4" data-path="./">
<li class="chapter active" data-level="1.5" data-path="./">
<a href="./">
@@ -203,7 +235,7 @@
<ul class="articles">
<li class="chapter " data-level="1.4.1" data-path="classes/_index_.rxapi.md">
<li class="chapter " data-level="1.5.1" data-path="classes/_index_.rxapi.md">
<span>
@@ -423,7 +455,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"rpc-rx","level":"1.4","depth":1,"next":{"title":"RpcRx","level":"1.4.1","depth":2,"path":"rpc-rx/classes/_index_.rxapi.md","ref":"rpc-rx/classes/_index_.rxapi.md","articles":[]},"previous":{"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","mermaid-gb3","-highlight","sunlight-highlighter"],"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":{"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"mermaid-gb3":{},"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":"rpc-rx/README.md","mtime":"2018-10-10T18:14:32.607Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-10T18:15:31.788Z"},"basePath":"..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"rpc-rx","level":"1.5","depth":1,"next":{"title":"RpcRx","level":"1.5.1","depth":2,"path":"rpc-rx/classes/_index_.rxapi.md","ref":"rpc-rx/classes/_index_.rxapi.md","articles":[]},"previous":{"title":"WsProvider","level":"1.4.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","mermaid-gb3","-highlight","sunlight-highlighter"],"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":{"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"mermaid-gb3":{},"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":"rpc-rx/README.md","mtime":"2018-10-10T18:22:24.214Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-10T18:23:26.992Z"},"basePath":"..","book":{"language":""}});
});
</script>
</div>
docs/rpc-rx/interfaces/_index_.rpcrx.eventemitter.eventemitterstatic.md
+24
View File
@@ -0,0 +1,24 @@
# Hierarchy
**EventEmitterStatic**
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new EventEmitterStatic**<`EventTypes`>(): `EventEmitter`<`EventTypes`>
*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:57*
**Type parameters:**
#### EventTypes : `string` &#124; `symbol`
**Returns:** `EventEmitter`<`EventTypes`>
___
docs/rpc-rx/interfaces/_index_.rpcrx.eventemitter.listenerfn.md
+19
View File
@@ -0,0 +1,19 @@
# Hierarchy
**ListenerFn**
# Callable
▸ **__call**(...args: *`Array`<`any`>*): `void`
*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:53*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Rest` args | `Array`<`any`> |
**Returns:** `void`
docs/rpc-rx/modules/_index_.rpcrx.eventemitter.md
+27
View File
@@ -0,0 +1,27 @@
# Index
### Interfaces
* [EventEmitterStatic](../interfaces/_index_.rpcrx.eventemitter.eventemitterstatic.md)
* [ListenerFn](../interfaces/_index_.rpcrx.eventemitter.listenerfn.md)
### Variables
* [EventEmitter](_index_.rpcrx.eventemitter.md#eventemitter)
---
# Variables
<a id="eventemitter"></a>
## `<Const>` EventEmitter
**● EventEmitter**: *`EventEmitterStatic`*
*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:61*
___
docs/rpc-rx/modules/_types_d_.md
+15 -5
View File
@@ -8,10 +8,20 @@
**Ƭ RxRpcInterface**: *`object`*
*Defined in [types.d.ts:15](https://github.com/polkadot-js/api/blob/267411d/packages/rpc-rx/src/types.d.ts#L15)*
*Defined in [types.d.ts:16](https://github.com/polkadot-js/api/blob/7180f89/packages/rpc-rx/src/types.d.ts#L16)*
#### Type declaration
___
<a id="rxrpcinterface_events"></a>
## RxRpcInterface$Events
**Ƭ RxRpcInterface$Events**: * "connected" &#124; "disconnected"
*
*Defined in [types.d.ts:14](https://github.com/polkadot-js/api/blob/7180f89/packages/rpc-rx/src/types.d.ts#L14)*
___
<a id="rxrpcinterface_method"></a>
@@ -19,10 +29,10 @@ ___
**Ƭ RxRpcInterface$Method**: *`function`*
*Defined in [types.d.ts:9](https://github.com/polkadot-js/api/blob/267411d/packages/rpc-rx/src/types.d.ts#L9)*
*Defined in [types.d.ts:8](https://github.com/polkadot-js/api/blob/7180f89/packages/rpc-rx/src/types.d.ts#L8)*
#### Type declaration
▸(...params: *`Array`<`any`>*): `Observable`<`any`> &#124; `BehaviorSubject`<`any`>
▸(...params: *`Array`<`any`>*): `Observable`<`any`> &#124; `ReplaySubject`<`any`>
**Parameters:**
@@ -30,7 +40,7 @@ ___
| ------ | ------ |
| `Rest` params | `Array`<`any`> |
**Returns:** `Observable`<`any`> &#124; `BehaviorSubject`<`any`>
**Returns:** `Observable`<`any`> &#124; `ReplaySubject`<`any`>
___
<a id="rxrpcinterface_section"></a>
@@ -39,7 +49,7 @@ ___
**Ƭ RxRpcInterface$Section**: *`object`*
*Defined in [types.d.ts:11](https://github.com/polkadot-js/api/blob/267411d/packages/rpc-rx/src/types.d.ts#L11)*
*Defined in [types.d.ts:10](https://github.com/polkadot-js/api/blob/7180f89/packages/rpc-rx/src/types.d.ts#L10)*
#### Type declaration