Files
api/docs/api-rx/classes/rxapi.md
T
2018-09-17 12:37:37 +00:00

2.3 KiB

Polkadot JS API > RxApi

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:43](https://github.com/polkadot-js/api/blob/f5b0e23/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](rxapi.md)

___

## Properties

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

###  author

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

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

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

###  chain

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

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

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

###  state

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

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

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

###  system

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

*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/f5b0e23/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/f5b0e23/packages/api-rx/src/index.ts#L62)*

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

___