Files
api/docs/api-rx/classes/_index_.rxapi.md
T
2018-09-26 12:38:06 +00:00

2.0 KiB

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`

# Constructors

<a id="constructor"></a>

##  constructor

⊕ **new RxApi**(provider?: *`ProviderInterface`*): [RxApi](_index_.rxapi.md)

*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/dfd2e70/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 |

**Returns:** [RxApi](_index_.rxapi.md)

___

# Properties

<a id="author"></a>

##  author

**● author**: *[RxApiInterface$Section](../modules/_types_d_.md#rxapiinterface_section)*

*Defined in [index.ts:40](https://github.com/polkadot-js/api/blob/dfd2e70/packages/api-rx/src/index.ts#L40)*

___
<a id="chain"></a>

##  chain

**● chain**: *[RxApiInterface$Section](../modules/_types_d_.md#rxapiinterface_section)*

*Defined in [index.ts:41](https://github.com/polkadot-js/api/blob/dfd2e70/packages/api-rx/src/index.ts#L41)*

___
<a id="state"></a>

##  state

**● state**: *[RxApiInterface$Section](../modules/_types_d_.md#rxapiinterface_section)*

*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/dfd2e70/packages/api-rx/src/index.ts#L42)*

___
<a id="system"></a>

##  system

**● system**: *[RxApiInterface$Section](../modules/_types_d_.md#rxapiinterface_section)*

*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/dfd2e70/packages/api-rx/src/index.ts#L43)*

___

# Methods

<a id="isconnected"></a>

##  isConnected

▸ **isConnected**(): `BehaviorSubject`<`boolean`>

*Defined in [index.ts:62](https://github.com/polkadot-js/api/blob/dfd2e70/packages/api-rx/src/index.ts#L62)*

**Returns:** `BehaviorSubject`<`boolean`>

___