[CI Skip] 0.31.1

2018-10-10 08:05:35 +00:00
parent 4344f33de8
commit af10c69d2b
211 changed files with 7990 additions and 2245 deletions
@@ -0,0 +1,8 @@
+
+[![polkadotjs](https://img.shields.io/badge/polkadot-js-orange.svg?style=flat-square)](https://polkadot.js.org) ![isc](https://img.shields.io/badge/license-ISC-lightgrey.svg?style=flat-square) [![style](https://img.shields.io/badge/code%20style-semistandard-lightgrey.svg?style=flat-square)](https://github.com/Flet/semistandard) [![npm](https://img.shields.io/npm/v/@polkadot/rpc-rx.svg?style=flat-square)](https://www.npmjs.com/package/@polkadot/rpc-rx) [![travis](https://img.shields.io/travis/polkadot-js/api.svg?style=flat-square)](https://travis-ci.org/polkadot-js/api) [![maintainability](https://img.shields.io/codeclimate/maintainability/polkadot-js/api.svg?style=flat-square)](https://codeclimate.com/github/polkadot-js/api/maintainability) [![coverage](https://img.shields.io/coveralls/polkadot-js/api.svg?style=flat-square)](https://coveralls.io/github/polkadot-js/api?branch=master) [![dependency](https://david-dm.org/polkadot-js/api.svg?style=flat-square&path=packages/rpc-rx)](https://david-dm.org/polkadot-js/api?path=packages/rpc-rx) [![devDependency](https://david-dm.org/polkadot-js/api/dev-status.svg?style=flat-square&path=packages/rpc-rx)](https://david-dm.org/polkadot-js/api?path=packages/rpc-rx#info=devDependencies)
+
+@polkadot/rpc-rx
+================
+
+An RxJs wrapper around the [@polkadot/api](../api).
+
@@ -0,0 +1,4 @@
+* [&quot;defaults&quot;](modules/_defaults_.md)
+* [&quot;index&quot;](modules/_index_.md)
+  * [RpcRx](classes/_index_.rpcrx.md)
+* [&quot;types.d&quot;](modules/_types_d_.md)
@@ -0,0 +1,98 @@
+
+
+*__name__*: RpcRx
+
+*__summary__*: The RxJS API is a wrapper around the API.
+
+*__description__*: It allows wrapping API components with observables using RxJS.
+
+*__example__*:   
+```javascript
+import Rpc from '@polkadot/rpc-rx';
+import WsProvider from '@polkadot/rpc-provider/ws';
+
+const provider = new WsProvider('http://127.0.0.1:9944');
+const api = new Rpc(provider);
+```
+
+# Hierarchy
+
+**RpcRx**
+
+# Implements
+
+* `object`
+
+# Constructors
+
+<a id="constructor"></a>
+
+##  constructor
+
+⊕ **new RpcRx**(provider?: *`ProviderInterface`*): [RpcRx](_index_.rpcrx.md)
+
+*Defined in [index.ts:46](https://github.com/polkadot-js/api/blob/4344f33/packages/rpc-rx/src/index.ts#L46)*
+
+**Parameters:**
+
+| Param | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `Default value` provider | `ProviderInterface` |  new Ws(defaults.WS_URL) |  An API provider using HTTP or WebSocket |
+
+**Returns:** [RpcRx](_index_.rpcrx.md)
+
+___
+
+# Properties
+
+<a id="author"></a>
+
+##  author
+
+**● author**: *[RxRpcInterface$Section](../modules/_types_d_.md#rxrpcinterface_section)*
+
+*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/4344f33/packages/rpc-rx/src/index.ts#L43)*
+
+___
+<a id="chain"></a>
+
+##  chain
+
+**● chain**: *[RxRpcInterface$Section](../modules/_types_d_.md#rxrpcinterface_section)*
+
+*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/4344f33/packages/rpc-rx/src/index.ts#L44)*
+
+___
+<a id="state"></a>
+
+##  state
+
+**● state**: *[RxRpcInterface$Section](../modules/_types_d_.md#rxrpcinterface_section)*
+
+*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/4344f33/packages/rpc-rx/src/index.ts#L45)*
+
+___
+<a id="system"></a>
+
+##  system
+
+**● system**: *[RxRpcInterface$Section](../modules/_types_d_.md#rxrpcinterface_section)*
+
+*Defined in [index.ts:46](https://github.com/polkadot-js/api/blob/4344f33/packages/rpc-rx/src/index.ts#L46)*
+
+___
+
+# Methods
+
+<a id="isconnected"></a>
+
+##  isConnected
+
+▸ **isConnected**(): `BehaviorSubject`<`boolean`>
+
+*Defined in [index.ts:65](https://github.com/polkadot-js/api/blob/4344f33/packages/rpc-rx/src/index.ts#L65)*
+
+**Returns:** `BehaviorSubject`<`boolean`>
+
+___
+
@@ -0,0 +1,454 @@
+
+<!DOCTYPE HTML>
+<html lang="" >
+    <head>
+        <meta charset="UTF-8">
+        <meta content="text/html; charset=utf-8" http-equiv="Content-Type">
+        <title>rpc-rx · Polkadot API Book</title>
+        <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+        <meta name="description" content="">
+        <meta name="generator" content="GitBook 3.2.3">
+        
+        
+        
+    
+    <link rel="stylesheet" href="../gitbook/style.css">
+
+    
+            
+                
+                <link rel="stylesheet" href="../gitbook/gitbook-plugin-sunlight-highlighter/sunlight.css">
+                
+            
+                
+                <link rel="stylesheet" href="../gitbook/gitbook-plugin-search/search.css">
+                
+            
+                
+                <link rel="stylesheet" href="../gitbook/gitbook-plugin-fontsettings/website.css">
+                
+            
+        
+
+    
+
+    
+        
+    
+        
+    
+        
+    
+        
+    
+        
+    
+        
+    
+
+        
+    
+    
+    <meta name="HandheldFriendly" content="true"/>
+    <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
+    <meta name="apple-mobile-web-app-capable" content="yes">
+    <meta name="apple-mobile-web-app-status-bar-style" content="black">
+    <link rel="apple-touch-icon-precomposed" sizes="152x152" href="../gitbook/images/apple-touch-icon-precomposed-152.png">
+    <link rel="shortcut icon" href="../gitbook/images/favicon.ico" type="image/x-icon">
+
+    
+    <link rel="next" href="classes/_index_.rxapi.md" />
+    
+    
+    <link rel="prev" href="../rpc-provider/classes/_ws_index_.wsprovider.html" />
+    
+
+    </head>
+    <body>
+        
+<div class="book">
+    <div class="book-summary">
+        
+            
+<div id="book-search-input" role="search">
+    <input type="text" placeholder="Type to search" />
+</div>
+
+            
+                <nav role="navigation">
+                
+
+
+<ul class="summary">
+    
+    
+
+    
+
+    
+        
+        <li class="header">Packages</li>
+        
+        
+    
+        <li class="chapter " data-level="1.1" data-path="../">
+            
+                <a href="../">
+            
+                    
+                    Introduction
+            
+                </a>
+            
+
+            
+        </li>
+    
+        <li class="chapter " data-level="1.2" data-path="../rpc-core/">
+            
+                <a href="../rpc-core/">
+            
+                    
+                    rpc-core
+            
+                </a>
+            
+
+            
+            <ul class="articles">
+                
+    
+        <li class="chapter " data-level="1.2.1" data-path="../rpc-core/classes/_index_.rpc.html">
+            
+                <a href="../rpc-core/classes/_index_.rpc.html">
+            
+                    
+                    Rpc
+            
+                </a>
+            
+
+            
+        </li>
+    
+
+            </ul>
+            
+        </li>
+    
+        <li class="chapter " data-level="1.3" data-path="../rpc-provider/">
+            
+                <a href="../rpc-provider/">
+            
+                    
+                    rpc-provider
+            
+                </a>
+            
+
+            
+            <ul class="articles">
+                
+    
+        <li class="chapter " data-level="1.3.1" data-path="../rpc-provider/classes/_http_index_.httpprovider.html">
+            
+                <a href="../rpc-provider/classes/_http_index_.httpprovider.html">
+            
+                    
+                    HttpProvider
+            
+                </a>
+            
+
+            
+        </li>
+    
+        <li class="chapter " data-level="1.3.2" data-path="../rpc-provider/classes/_ws_index_.wsprovider.html">
+            
+                <a href="../rpc-provider/classes/_ws_index_.wsprovider.html">
+            
+                    
+                    WsProvider
+            
+                </a>
+            
+
+            
+        </li>
+    
+
+            </ul>
+            
+        </li>
+    
+        <li class="chapter active" data-level="1.4" data-path="./">
+            
+                <a href="./">
+            
+                    
+                    rpc-rx
+            
+                </a>
+            
+
+            
+            <ul class="articles">
+                
+    
+        <li class="chapter " data-level="1.4.1" data-path="classes/_index_.rxapi.md">
+            
+                <span>
+            
+                    
+                    RpcRx
+            
+                </a>
+            
+
+            
+        </li>
+    
+
+            </ul>
+            
+        </li>
+    
+
+    
+        
+        <li class="header">Examples</li>
+        
+        
+    
+        <li class="chapter " data-level="2.1" data-path="../examples/">
+            
+                <a href="../examples/">
+            
+                    
+                    Overview
+            
+                </a>
+            
+
+            
+        </li>
+    
+        <li class="chapter " data-level="2.2" data-path="../examples/01_simple_connect/">
+            
+                <a href="../examples/01_simple_connect/">
+            
+                    
+                    Simple connect
+            
+                </a>
+            
+
+            
+        </li>
+    
+        <li class="chapter " data-level="2.3" data-path="../examples/02_listen_to_blocks/">
+            
+                <a href="../examples/02_listen_to_blocks/">
+            
+                    
+                    Listen to blocks
+            
+                </a>
+            
+
+            
+        </li>
+    
+        <li class="chapter " data-level="2.4" data-path="../examples/03_listen_to_balance_change/">
+            
+                <a href="../examples/03_listen_to_balance_change/">
+            
+                    
+                    Listen to balance change
+            
+                </a>
+            
+
+            
+        </li>
+    
+        <li class="chapter " data-level="2.5" data-path="../examples/04_generate_account/">
+            
+                <a href="../examples/04_generate_account/">
+            
+                    
+                    Generate Accounts
+            
+                </a>
+            
+
+            
+        </li>
+    
+        <li class="chapter " data-level="2.6" data-path="../examples/05_read_storage/">
+            
+                <a href="../examples/05_read_storage/">
+            
+                    
+                    Read Storage
+            
+                </a>
+            
+
+            
+        </li>
+    
+        <li class="chapter " data-level="2.7" data-path="../examples/06_craft_extrinsic/">
+            
+                <a href="../examples/06_craft_extrinsic/">
+            
+                    
+                    Craft Extrinsic
+            
+                </a>
+            
+
+            
+        </li>
+    
+        <li class="chapter " data-level="2.8" data-path="../examples/07_transfer_dots/">
+            
+                <a href="../examples/07_transfer_dots/">
+            
+                    
+                    Transfer DOTs
+            
+                </a>
+            
+
+            
+        </li>
+    
+
+    
+
+    <li class="divider"></li>
+
+    <li>
+        <a href="https://www.gitbook.com" target="blank" class="gitbook-link">
+            Published with GitBook
+        </a>
+    </li>
+</ul>
+
+
+                </nav>
+            
+        
+    </div>
+
+    <div class="book-body">
+        
+            <div class="body-inner">
+                
+                    
+
+<div class="book-header" role="navigation">
+    
+
+    <!-- Title -->
+    <h1>
+        <i class="fa fa-circle-o-notch fa-spin"></i>
+        <a href=".." >rpc-rx</a>
+    </h1>
+</div>
+
+
+
+
+                    <div class="page-wrapper" tabindex="-1" role="main">
+                        <div class="page-inner">
+                            
+<div id="book-search-results">
+    <div class="search-noresults">
+    
+                                <section class="normal markdown-section">
+                                
+                                <p><a href="https://polkadot.js.org" target="_blank"><img src="https://img.shields.io/badge/polkadot-js-orange.svg?style=flat-square" alt="polkadotjs"></a> <img src="https://img.shields.io/badge/license-ISC-lightgrey.svg?style=flat-square" alt="isc"> <a href="https://github.com/Flet/semistandard" target="_blank"><img src="https://img.shields.io/badge/code%20style-semistandard-lightgrey.svg?style=flat-square" alt="style"></a> <a href="https://www.npmjs.com/package/@polkadot/rpc-rx" target="_blank"><img src="https://img.shields.io/npm/v/@polkadot/rpc-rx.svg?style=flat-square" alt="npm"></a> <a href="https://travis-ci.org/polkadot-js/api" target="_blank"><img src="https://img.shields.io/travis/polkadot-js/api.svg?style=flat-square" alt="travis"></a> <a href="https://codeclimate.com/github/polkadot-js/api/maintainability" target="_blank"><img src="https://img.shields.io/codeclimate/maintainability/polkadot-js/api.svg?style=flat-square" alt="maintainability"></a> <a href="https://coveralls.io/github/polkadot-js/api?branch=master" target="_blank"><img src="https://img.shields.io/coveralls/polkadot-js/api.svg?style=flat-square" alt="coverage"></a> <a href="https://david-dm.org/polkadot-js/api?path=packages/rpc-rx" target="_blank"><img src="https://david-dm.org/polkadot-js/api.svg?style=flat-square&amp;path=packages/rpc-rx" alt="dependency"></a> <a href="https://david-dm.org/polkadot-js/api?path=packages/rpc-rx#info=devDependencies" target="_blank"><img src="https://david-dm.org/polkadot-js/api/dev-status.svg?style=flat-square&amp;path=packages/rpc-rx" alt="devDependency"></a></p>
+<h1 id="polkadotrpc-rx">@polkadot/rpc-rx</h1>
+<p>An RxJs wrapper around the <a href="../api">@polkadot/api</a>.</p>
+
+                                
+                                </section>
+                            
+    </div>
+    <div class="search-results">
+        <div class="has-results">
+            
+            <h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
+            <ul class="search-results-list"></ul>
+            
+        </div>
+        <div class="no-results">
+            
+            <h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
+            
+        </div>
+    </div>
+</div>
+
+                        </div>
+                    </div>
+                
+            </div>
+
+            
+                
+                <a href="../rpc-provider/classes/_ws_index_.wsprovider.html" class="navigation navigation-prev " aria-label="Previous page: WsProvider">
+                    <i class="fa fa-angle-left"></i>
+                </a>
+                
+                
+                <a href="classes/_index_.rxapi.md" class="navigation navigation-next " aria-label="Next page: RpcRx">
+                    <i class="fa fa-angle-right"></i>
+                </a>
+                
+            
+        
+    </div>
+
+    <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","-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},"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-10T08:04:32.480Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-10T08:05:29.107Z"},"basePath":"..","book":{"language":""}});
+        });
+    </script>
+</div>
+
+        
+    <script src="../gitbook/gitbook.js"></script>
+    <script src="../gitbook/theme.js"></script>
+    
+        
+        <script src="../gitbook/gitbook-plugin-search/search-engine.js"></script>
+        
+    
+        
+        <script src="../gitbook/gitbook-plugin-search/search.js"></script>
+        
+    
+        
+        <script src="../gitbook/gitbook-plugin-lunr/lunr.min.js"></script>
+        
+    
+        
+        <script src="../gitbook/gitbook-plugin-lunr/search-lunr.js"></script>
+        
+    
+        
+        <script src="../gitbook/gitbook-plugin-sharing/buttons.js"></script>
+        
+    
+        
+        <script src="../gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script>
+        
+    
+
+    </body>
+</html>
+
@@ -0,0 +1,2 @@
+
+
@@ -0,0 +1,10 @@
+
+
+# Index
+
+### Classes
+
+* [RpcRx](../classes/_index_.rpcrx.md)
+
+---
+
@@ -0,0 +1,49 @@
+
+
+# Type aliases
+
+<a id="rxrpcinterface"></a>
+
+##  RxRpcInterface
+
+**Ƭ RxRpcInterface**: *`object`*
+
+*Defined in [types.d.ts:15](https://github.com/polkadot-js/api/blob/4344f33/packages/rpc-rx/src/types.d.ts#L15)*
+
+#### Type declaration
+
+___
+<a id="rxrpcinterface_method"></a>
+
+##  RxRpcInterface$Method
+
+**Ƭ RxRpcInterface$Method**: *`function`*
+
+*Defined in [types.d.ts:9](https://github.com/polkadot-js/api/blob/4344f33/packages/rpc-rx/src/types.d.ts#L9)*
+
+#### Type declaration
+▸(...params: *`Array`<`any`>*):  `Observable`<`any`> &#124; `BehaviorSubject`<`any`>
+
+**Parameters:**
+
+| Param | Type |
+| ------ | ------ |
+| `Rest` params | `Array`<`any`> |
+
+**Returns:**  `Observable`<`any`> &#124; `BehaviorSubject`<`any`>
+
+___
+<a id="rxrpcinterface_section"></a>
+
+##  RxRpcInterface$Section
+
+**Ƭ RxRpcInterface$Section**: *`object`*
+
+*Defined in [types.d.ts:11](https://github.com/polkadot-js/api/blob/4344f33/packages/rpc-rx/src/types.d.ts#L11)*
+
+#### Type declaration
+
+[index: `string`]: [RxRpcInterface$Method](_types_d_.md#rxrpcinterface_method)
+
+___
+