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
This commit is contained in:
Chevdor
2018-09-15 09:11:56 +02:00
committed by Jaco Greeff
parent 7fffcb3747
commit 0981a30d84
61 changed files with 6937 additions and 105 deletions
+14
View File
@@ -13,6 +13,17 @@ import Ws from '@polkadot/api-provider/ws';
import defaults from './defaults';
import createInterface from './interface';
/**
* 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);
* ```
*/
export default class RxApi implements RxApiInterface {
private _api: ApiInterface;
private _isConnected: BehaviorSubject<boolean>;
@@ -21,6 +32,9 @@ export default class RxApi implements RxApiInterface {
readonly state: RxApiInterface$Section;
readonly system: RxApiInterface$Section;
/**
* @param {ProviderInterface} provider An API provider using HTTP or WebSocket
*/
constructor (provider: ProviderInterface = new Ws(defaults.WS_URL)) {
this._api = new Api(provider);
this._isConnected = new BehaviorSubject(provider.isConnected());