Add documentation and examples (#145)

* Add documentation * Justification u8a decoding and json encoding (#146) * Decode Justifications * Json encoding for justifications * Bump deps * Allow extrinsic length encoding to operate on u8a[] (#148) * Fix config and move generated doc to a subfolder * Cleanup extrinsic encoding (#150) * Cleanup extrinsic encoding * Removed now-defunct type * Add uncheckedLength encoding * Add examples * Ignore package-lock since we use yarn * Cleanup examples * Add gitbook config and some base files for the doc * Do not make full doc mandatory for now * Add contributing guide, polish doc and samples * Update the deps of all samples and add yarn scripts Fix and regenerate the doc * Fix Contributing guide
2018-09-15 09:11:56 +02:00
parent 7fffcb3747
commit 0981a30d84
61 changed files with 6937 additions and 105 deletions
@@ -0,0 +1,112 @@
+[Polkadot JS API](../README.md) > [RxApi](../classes/rxapi.md)
+
+# Class: RxApi
+
+An RxJs wrapper around the \[\[api\]\].
+*__example__*: ```javascript
+import RxApi from '@polkadot/api';
+import WsProvider from '@polkadot/api-provider/ws';
+const provider = new WsProvider('http://127.0.0.1:9944');
+const rxapi = new RxApi(provider);
+```
+
+## Hierarchy
+
+**RxApi**
+
+## Implements
+
+*  `object` & `object`
+
+## Index
+
+### Constructors
+
+* [constructor](rxapi.md#constructor)
+
+### Properties
+
+* [author](rxapi.md#author)
+* [chain](rxapi.md#chain)
+* [state](rxapi.md#state)
+* [system](rxapi.md#system)
+
+### Methods
+
+* [isConnected](rxapi.md#isconnected)
+
+---
+
+## Constructors
+
+<a id="constructor"></a>
+
+###  constructor
+
+⊕ **new RxApi**(provider?: *`ProviderInterface`*): [RxApi](rxapi.md)
+
+*Defined in [index.ts:33](https://github.com/chevdor/polkadot-js-api/blob/461228c/packages/api-rx/src/index.ts#L33)*
+
+**Parameters:**
+
+| Param | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `Default value` provider | `ProviderInterface` |  new Ws(defaults.WS_URL) |  An API provider using HTTP or WebSocket |
+
+**Returns:** [RxApi](rxapi.md)
+
+___
+
+## Properties
+
+<a id="author"></a>
+
+###  author
+
+**● author**: *[RxApiInterface$Section](../#rxapiinterface_section)*
+
+*Defined in [index.ts:30](https://github.com/chevdor/polkadot-js-api/blob/461228c/packages/api-rx/src/index.ts#L30)*
+
+___
+<a id="chain"></a>
+
+###  chain
+
+**● chain**: *[RxApiInterface$Section](../#rxapiinterface_section)*
+
+*Defined in [index.ts:31](https://github.com/chevdor/polkadot-js-api/blob/461228c/packages/api-rx/src/index.ts#L31)*
+
+___
+<a id="state"></a>
+
+###  state
+
+**● state**: *[RxApiInterface$Section](../#rxapiinterface_section)*
+
+*Defined in [index.ts:32](https://github.com/chevdor/polkadot-js-api/blob/461228c/packages/api-rx/src/index.ts#L32)*
+
+___
+<a id="system"></a>
+
+###  system
+
+**● system**: *[RxApiInterface$Section](../#rxapiinterface_section)*
+
+*Defined in [index.ts:33](https://github.com/chevdor/polkadot-js-api/blob/461228c/packages/api-rx/src/index.ts#L33)*
+
+___
+
+## Methods
+
+<a id="isconnected"></a>
+
+###  isConnected
+
+▸ **isConnected**(): `BehaviorSubject`<`boolean`>
+
+*Defined in [index.ts:51](https://github.com/chevdor/polkadot-js-api/blob/461228c/packages/api-rx/src/index.ts#L51)*
+
+**Returns:** `BehaviorSubject`<`boolean`>
+
+___
+