quantus/api
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[CI Skip] 0.30.5

Browse Source
This commit is contained in:
Travis CI
2018-10-01 09:28:27 +00:00
parent 782bb8063c
commit d230c05d16
68 changed files with 4353 additions and 130 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api-observable/README.md
+8
View File
@@ -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/api-observable.svg?style=flat-square)](https://www.npmjs.com/package/@polkadot/api-observable) [![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/api-observable)](https://david-dm.org/polkadot-js/api?path=packages/api-observable) [![devDependency](https://david-dm.org/polkadot-js/api/dev-status.svg?style=flat-square&path=packages/api-observable)](https://david-dm.org/polkadot-js/api?path=packages/api-observable#info=devDependencies)
@polkadot/api-observable
========================
An RxJs wrapper around the [@polkadot/api](../api).
docs/api-observable/SUMMARY.md
+15
View File
@@ -0,0 +1,15 @@
* ["Base"](modules/_base_.md)
* [ApiBase](classes/_base_.apibase.md)
* ["Calls"](modules/_calls_.md)
* [ApiCalls](classes/_calls_.apicalls.md)
* ["Combined"](modules/_combined_.md)
* [ApiCombined](classes/_combined_.apicombined.md)
* ["Queries"](modules/_queries_.md)
* [ApiQueries](classes/_queries_.apiqueries.md)
* ["classes"](modules/_classes_.md)
* [RxProposal](classes/_classes_.rxproposal.md)
* [RxProposalDeposits](classes/_classes_.rxproposaldeposits.md)
* [RxReferendum](classes/_classes_.rxreferendum.md)
* ["index"](modules/_index_.md)
* [Api](classes/_index_.api.md)
* ["types.d"](modules/_types_d_.md)
docs/api-observable/classes/_base_.apibase.md
+138
View File
@@ -0,0 +1,138 @@
# Hierarchy
**ApiBase**
↳ [ApiQueries](_queries_.apiqueries.md)
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new ApiBase**(api: *`RxApiInterface`*): [ApiBase](_base_.apibase.md)
*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Base.ts#L22)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| api | `RxApiInterface` |
**Returns:** [ApiBase](_base_.apibase.md)
___
# Properties
<a id="api"></a>
## `<Protected>` api
**● api**: *`RxApiInterface`*
*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Base.ts#L22)*
___
# Methods
<a id="combine"></a>
## `<Protected>` combine
▸ **combine**<`T`,`R`>(observables: *`Array`<`Observable`<`any`>>*, mapfn?: *`MapFn`<`R`, `T`>*): `Observable`<`T`>
*Defined in [Base.ts:28](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Base.ts#L28)*
**Type parameters:**
#### T
#### R
**Parameters:**
| Param | Type | Default value |
| ------ | ------ | ------ |
| observables | `Array`<`Observable`<`any`>> | - |
| `Default value` mapfn | `MapFn`<`R`, `T`> | defaultMapFn |
**Returns:** `Observable`<`T`>
___
<a id="isconnected"></a>
## isConnected
▸ **isConnected**(): `Observable`<`boolean`>
*Defined in [Base.ts:36](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Base.ts#L36)*
**Returns:** `Observable`<`boolean`>
___
<a id="rawcall"></a>
## rawCall
▸ **rawCall**<`T`>(__namedParameters: *`object`*, ...params: *`Array`<`any`>*): `Observable`<`T`>
*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Base.ts#L40)*
**Type parameters:**
#### T
**Parameters:**
| Param | Type |
| ------ | ------ |
| __namedParameters | `object` |
| `Rest` params | `Array`<`any`> |
**Returns:** `Observable`<`T`>
___
<a id="rawstorage"></a>
## rawStorage
▸ **rawStorage**<`T`>(key: *`StorageFunction`*, ...params: *`Array`<`any`>*): `Observable`<`T`>
*Defined in [Base.ts:52](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Base.ts#L52)*
**Type parameters:**
#### T
**Parameters:**
| Param | Type |
| ------ | ------ |
| key | `StorageFunction` |
| `Rest` params | `Array`<`any`> |
**Returns:** `Observable`<`T`>
___
<a id="rawstoragemulti"></a>
## rawStorageMulti
▸ **rawStorageMulti**<`T`>(...keys: *`Array`< [`StorageFunction`] &#124; [`StorageFunction`, `any`]>*): `Observable`<`T`>
*Defined in [Base.ts:63](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Base.ts#L63)*
**Type parameters:**
#### T
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Rest` keys | `Array`< [`StorageFunction`] &#124; [`StorageFunction`, `any`]> |
**Returns:** `Observable`<`T`>
___
docs/api-observable/classes/_calls_.apicalls.md
+612
View File
@@ -0,0 +1,612 @@
# Hierarchy
↳ [ApiQueries](_queries_.apiqueries.md)
**↳ ApiCalls**
↳ [ApiCombined](_combined_.apicombined.md)
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new ApiCalls**(api: *`RxApiInterface`*): [ApiCalls](_calls_.apicalls.md)
*Inherited from [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Base.ts#L22)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| api | `RxApiInterface` |
**Returns:** [ApiCalls](_calls_.apicalls.md)
___
# Properties
<a id="api"></a>
## `<Protected>` api
**● api**: *`RxApiInterface`*
*Inherited from [ApiBase](_base_.apibase.md).[api](_base_.apibase.md#api)*
*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Base.ts#L22)*
___
# Methods
<a id="bestnumber"></a>
## bestNumber
▸ **bestNumber**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Calls.ts#L13)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
___
<a id="chaingetblock"></a>
## chainGetBlock
▸ **chainGetBlock**(hash: *`Uint8Array`*): `Observable`< `SignedBlock` &#124; `undefined`>
*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Calls.ts#L25)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| hash | `Uint8Array` |
**Returns:** `Observable`< `SignedBlock` &#124; `undefined`>
___
<a id="chainnewhead"></a>
## chainNewHead
▸ **chainNewHead**(): `Observable`< `Header` &#124; `undefined`>
*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Calls.ts#L29)*
**Returns:** `Observable`< `Header` &#124; `undefined`>
___
<a id="combine"></a>
## `<Protected>` combine
▸ **combine**<`T`,`R`>(observables: *`Array`<`Observable`<`any`>>*, mapfn?: *`MapFn`<`R`, `T`>*): `Observable`<`T`>
*Inherited from [ApiBase](_base_.apibase.md).[combine](_base_.apibase.md#combine)*
*Defined in [Base.ts:28](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Base.ts#L28)*
**Type parameters:**
#### T
#### R
**Parameters:**
| Param | Type | Default value |
| ------ | ------ | ------ |
| observables | `Array`<`Observable`<`any`>> | - |
| `Default value` mapfn | `MapFn`<`R`, `T`> | defaultMapFn |
**Returns:** `Observable`<`T`>
___
<a id="democacyvoteof"></a>
## democacyVoteOf
▸ **democacyVoteOf**(index: * `ReferendumIndex` &#124; `BN` &#124; `number`*, address: * `AccountId` &#124; `string`*): `Observable`<`Bool`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democacyVoteOf](_queries_.apiqueries.md#democacyvoteof)*
*Defined in [Queries.ts:76](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L76)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| index | `ReferendumIndex` &#124; `BN` &#124; `number`|
| address | `AccountId` &#124; `string`|
**Returns:** `Observable`<`Bool`>
___
<a id="democacyvotersfor"></a>
## democacyVotersFor
▸ **democacyVotersFor**(index: * `ReferendumIndex` &#124; `BN` &#124; `number`*): `Observable`<`Array`<`AccountId`>>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democacyVotersFor](_queries_.apiqueries.md#democacyvotersfor)*
*Defined in [Queries.ts:80](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L80)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| index | `ReferendumIndex` &#124; `BN` &#124; `number`|
**Returns:** `Observable`<`Array`<`AccountId`>>
___
<a id="democracylaunchperiod"></a>
## democracyLaunchPeriod
▸ **democracyLaunchPeriod**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyLaunchPeriod](_queries_.apiqueries.md#democracylaunchperiod)*
*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L19)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
___
<a id="democracynexttally"></a>
## democracyNextTally
▸ **democracyNextTally**(): `Observable`< `ReferendumIndex` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyNextTally](_queries_.apiqueries.md#democracynexttally)*
*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L23)*
**Returns:** `Observable`< `ReferendumIndex` &#124; `undefined`>
___
<a id="democracyproposaldeposits"></a>
## democracyProposalDeposits
▸ **democracyProposalDeposits**(proposalId: * `PropIndex` &#124; `BN` &#124; `number`*): `Observable`< [RxProposalDeposits](_classes_.rxproposaldeposits.md) &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyProposalDeposits](_queries_.apiqueries.md#democracyproposaldeposits)*
*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L27)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| proposalId | `PropIndex` &#124; `BN` &#124; `number`|
**Returns:** `Observable`< [RxProposalDeposits](_classes_.rxproposaldeposits.md) &#124; `undefined`>
___
<a id="democracypublicproposals"></a>
## democracyPublicProposals
▸ **democracyPublicProposals**(): `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyPublicProposals](_queries_.apiqueries.md#democracypublicproposals)*
*Defined in [Queries.ts:40](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L40)*
**Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>>
___
<a id="democracyreferendumcount"></a>
## democracyReferendumCount
▸ **democracyReferendumCount**(): `Observable`< `ReferendumIndex` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyReferendumCount](_queries_.apiqueries.md#democracyreferendumcount)*
*Defined in [Queries.ts:59](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L59)*
**Returns:** `Observable`< `ReferendumIndex` &#124; `undefined`>
___
<a id="democracyreferenduminfoof"></a>
## democracyReferendumInfoOf
▸ **democracyReferendumInfoOf**(referendumId: * `ReferendumIndex` &#124; `BN` &#124; `number`*): `Observable`< [RxReferendum](_classes_.rxreferendum.md) &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyReferendumInfoOf](_queries_.apiqueries.md#democracyreferenduminfoof)*
*Defined in [Queries.ts:63](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L63)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| referendumId | `ReferendumIndex` &#124; `BN` &#124; `number`|
**Returns:** `Observable`< [RxReferendum](_classes_.rxreferendum.md) &#124; `undefined`>
___
<a id="democracyvotingperiod"></a>
## democracyVotingPeriod
▸ **democracyVotingPeriod**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyVotingPeriod](_queries_.apiqueries.md#democracyvotingperiod)*
*Defined in [Queries.ts:91](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L91)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
___
<a id="eralastlengthchange"></a>
## eraLastLengthChange
▸ **eraLastLengthChange**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[eraLastLengthChange](_queries_.apiqueries.md#eralastlengthchange)*
*Defined in [Queries.ts:116](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L116)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
___
<a id="fees"></a>
## fees
▸ **fees**(): `Observable`<[RxFees](../modules/_types_d_.md#rxfees)>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[fees](_queries_.apiqueries.md#fees)*
*Defined in [Queries.ts:95](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L95)*
**Returns:** `Observable`<[RxFees](../modules/_types_d_.md#rxfees)>
___
<a id="isconnected"></a>
## isConnected
▸ **isConnected**(): `Observable`<`boolean`>
*Inherited from [ApiBase](_base_.apibase.md).[isConnected](_base_.apibase.md#isconnected)*
*Defined in [Base.ts:36](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Base.ts#L36)*
**Returns:** `Observable`<`boolean`>
___
<a id="rawcall"></a>
## rawCall
▸ **rawCall**<`T`>(__namedParameters: *`object`*, ...params: *`Array`<`any`>*): `Observable`<`T`>
*Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)*
*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Base.ts#L40)*
**Type parameters:**
#### T
**Parameters:**
| Param | Type |
| ------ | ------ |
| __namedParameters | `object` |
| `Rest` params | `Array`<`any`> |
**Returns:** `Observable`<`T`>
___
<a id="rawstorage"></a>
## rawStorage
▸ **rawStorage**<`T`>(key: *`StorageFunction`*, ...params: *`Array`<`any`>*): `Observable`<`T`>
*Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)*
*Defined in [Base.ts:52](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Base.ts#L52)*
**Type parameters:**
#### T
**Parameters:**
| Param | Type |
| ------ | ------ |
| key | `StorageFunction` |
| `Rest` params | `Array`<`any`> |
**Returns:** `Observable`<`T`>
___
<a id="rawstoragemulti"></a>
## rawStorageMulti
▸ **rawStorageMulti**<`T`>(...keys: *`Array`< [`StorageFunction`] &#124; [`StorageFunction`, `any`]>*): `Observable`<`T`>
*Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)*
*Defined in [Base.ts:63](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Base.ts#L63)*
**Type parameters:**
#### T
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Rest` keys | `Array`< [`StorageFunction`] &#124; [`StorageFunction`, `any`]> |
**Returns:** `Observable`<`T`>
___
<a id="sessioncurrentindex"></a>
## sessionCurrentIndex
▸ **sessionCurrentIndex**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentIndex](_queries_.apiqueries.md#sessioncurrentindex)*
*Defined in [Queries.ts:128](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L128)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
___
<a id="sessioncurrentstart"></a>
## sessionCurrentStart
▸ **sessionCurrentStart**(): `Observable`< `Moment` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentStart](_queries_.apiqueries.md#sessioncurrentstart)*
*Defined in [Queries.ts:132](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L132)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
___
<a id="sessionlastlengthchange"></a>
## sessionLastLengthChange
▸ **sessionLastLengthChange**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLastLengthChange](_queries_.apiqueries.md#sessionlastlengthchange)*
*Defined in [Queries.ts:136](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L136)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
___
<a id="sessionlength"></a>
## sessionLength
▸ **sessionLength**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLength](_queries_.apiqueries.md#sessionlength)*
*Defined in [Queries.ts:140](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L140)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
___
<a id="sessionreward"></a>
## sessionReward
▸ **sessionReward**(): `Observable`< `Perbill` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionReward](_queries_.apiqueries.md#sessionreward)*
*Defined in [Queries.ts:120](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L120)*
**Returns:** `Observable`< `Perbill` &#124; `undefined`>
___
<a id="sessionrewardcurrent"></a>
## sessionRewardCurrent
▸ **sessionRewardCurrent**(): `Observable`< `Balance` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionRewardCurrent](_queries_.apiqueries.md#sessionrewardcurrent)*
*Defined in [Queries.ts:124](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L124)*
**Returns:** `Observable`< `Balance` &#124; `undefined`>
___
<a id="sessionvalidators"></a>
## sessionValidators
▸ **sessionValidators**(): `Observable`<`Array`<`AccountId`>>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionValidators](_queries_.apiqueries.md#sessionvalidators)*
*Defined in [Queries.ts:148](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L148)*
**Returns:** `Observable`<`Array`<`AccountId`>>
___
<a id="sessionsperera"></a>
## sessionsPerEra
▸ **sessionsPerEra**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionsPerEra](_queries_.apiqueries.md#sessionsperera)*
*Defined in [Queries.ts:144](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L144)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
___
<a id="stakingfreebalanceof"></a>
## stakingFreeBalanceOf
▸ **stakingFreeBalanceOf**(address: * `AccountId` &#124; `string`*): `Observable`< `Balance` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingFreeBalanceOf](_queries_.apiqueries.md#stakingfreebalanceof)*
*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L171)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| address | `AccountId` &#124; `string`|
**Returns:** `Observable`< `Balance` &#124; `undefined`>
___
<a id="stakingintentions"></a>
## stakingIntentions
▸ **stakingIntentions**(): `Observable`<`Array`<`AccountId`>>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingIntentions](_queries_.apiqueries.md#stakingintentions)*
*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L159)*
**Returns:** `Observable`<`Array`<`AccountId`>>
___
<a id="stakingnominating"></a>
## stakingNominating
▸ **stakingNominating**(address: * `AccountId` &#124; `string`*): `Observable`< `AccountId` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominating](_queries_.apiqueries.md#stakingnominating)*
*Defined in [Queries.ts:186](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L186)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| address | `AccountId` &#124; `string`|
**Returns:** `Observable`< `AccountId` &#124; `undefined`>
___
<a id="stakingnominatorsfor"></a>
## stakingNominatorsFor
▸ **stakingNominatorsFor**(address: * `AccountId` &#124; `string`*): `Observable`<`Array`<`AccountId`>>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominatorsFor](_queries_.apiqueries.md#stakingnominatorsfor)*
*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L175)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| address | `AccountId` &#124; `string`|
**Returns:** `Observable`<`Array`<`AccountId`>>
___
<a id="stakingreservedbalanceof"></a>
## stakingReservedBalanceOf
▸ **stakingReservedBalanceOf**(address: * `AccountId` &#124; `string`*): `Observable`< `Balance` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingReservedBalanceOf](_queries_.apiqueries.md#stakingreservedbalanceof)*
*Defined in [Queries.ts:191](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L191)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| address | `AccountId` &#124; `string`|
**Returns:** `Observable`< `Balance` &#124; `undefined`>
___
<a id="systemaccountindexof"></a>
## systemAccountIndexOf
▸ **systemAccountIndexOf**(address: * `AccountId` &#124; `string`*): `Observable`< `Index` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[systemAccountIndexOf](_queries_.apiqueries.md#systemaccountindexof)*
*Defined in [Queries.ts:203](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L203)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| address | `AccountId` &#124; `string`|
**Returns:** `Observable`< `Index` &#124; `undefined`>
___
<a id="timestampblockperiod"></a>
## timestampBlockPeriod
▸ **timestampBlockPeriod**(): `Observable`< `Moment` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[timestampBlockPeriod](_queries_.apiqueries.md#timestampblockperiod)*
*Defined in [Queries.ts:195](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L195)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
___
<a id="timestampnow"></a>
## timestampNow
▸ **timestampNow**(): `Observable`< `Moment` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[timestampNow](_queries_.apiqueries.md#timestampnow)*
*Defined in [Queries.ts:199](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L199)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
___
<a id="validatorcount"></a>
## validatorCount
▸ **validatorCount**(): `Observable`<`u32`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[validatorCount](_queries_.apiqueries.md#validatorcount)*
*Defined in [Queries.ts:207](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L207)*
**Returns:** `Observable`<`u32`>
___
docs/api-observable/classes/_classes_.rxproposal.md
+324
View File
@@ -0,0 +1,324 @@
# Type parameters
#### S
#### T
#### V
#### E
# Hierarchy
`Struct`
**↳ RxProposal**
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new RxProposal**(value: *`Tuple`*): [RxProposal](_classes_.rxproposal.md)
*Overrides Struct.__constructor*
*Defined in [classes.ts:9](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/classes.ts#L9)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| value | `Tuple` |
**Returns:** [RxProposal](_classes_.rxproposal.md)
___
# Properties
<a id="_types"></a>
## `<Protected>` _Types
**● _Types**: *`E`*
*Inherited from Struct._Types*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/782bb80/packages/api-codec/src/codec/Struct.ts#L27)*
___
<a id="_jsonmap"></a>
## `<Protected>` _jsonMap
**● _jsonMap**: *`Map`<`keyof S`, `string`>*
*Inherited from Struct._jsonMap*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/782bb80/packages/api-codec/src/codec/Struct.ts#L26)*
___
<a id="raw"></a>
## raw
**● raw**: *`T`*
*Inherited from Base.raw*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Base.ts:19](https://github.com/polkadot-js/api/blob/782bb80/packages/api-codec/src/codec/Base.ts#L19)*
___
# Accessors
<a id="type"></a>
## Type
getType(): `E`
*Inherited from Struct.Type*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/782bb80/packages/api-codec/src/codec/Struct.ts#L76)*
**Returns:** `E`
___
<a id="address"></a>
## address
getaddress(): `AccountId`
*Defined in [classes.ts:18](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/classes.ts#L18)*
**Returns:** `AccountId`
___
<a id="id"></a>
## id
getid(): `PropIndex`
*Defined in [classes.ts:22](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/classes.ts#L22)*
**Returns:** `PropIndex`
___
<a id="proposal"></a>
## proposal
getproposal(): `Proposal`
*Defined in [classes.ts:26](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/classes.ts#L26)*
**Returns:** `Proposal`
___
# Methods
<a id="bytelength"></a>
## byteLength
▸ **byteLength**(): `number`
*Inherited from Struct.byteLength*
*Overrides Base.byteLength*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/782bb80/packages/api-codec/src/codec/Struct.ts#L80)*
**Returns:** `number`
___
<a id="fromjson"></a>
## fromJSON
▸ **fromJSON**(input: *`any`*): `Struct`<`S`, `T`, `V`, `E`>
*Inherited from Struct.fromJSON*
*Overrides Base.fromJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/782bb80/packages/api-codec/src/codec/Struct.ts#L86)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `any` |
**Returns:** `Struct`<`S`, `T`, `V`, `E`>
___
<a id="fromu8a"></a>
## fromU8a
▸ **fromU8a**(input: *`Uint8Array`*): `Struct`<`S`, `T`, `V`, `E`>
*Inherited from Struct.fromU8a*
*Overrides Base.fromU8a*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/782bb80/packages/api-codec/src/codec/Struct.ts#L101)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** `Struct`<`S`, `T`, `V`, `E`>
___
<a id="get"></a>
## get
▸ **get**(index: *`number`*): `Base`
*Inherited from Struct.get*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/782bb80/packages/api-codec/src/codec/Struct.ts#L111)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| index | `number` |
**Returns:** `Base`
___
<a id="keys"></a>
## keys
▸ **keys**(): `Array`<`string`>
*Inherited from Struct.keys*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/782bb80/packages/api-codec/src/codec/Struct.ts#L126)*
**Returns:** `Array`<`string`>
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Inherited from Struct.toJSON*
*Overrides Base.toJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/782bb80/packages/api-codec/src/codec/Struct.ts#L115)*
**Returns:** `any`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Inherited from Struct.toString*
*Overrides Base.toString*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/782bb80/packages/api-codec/src/codec/Struct.ts#L138)*
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Inherited from Struct.toU8a*
*Overrides Base.toU8a*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/782bb80/packages/api-codec/src/codec/Struct.ts#L130)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
**Returns:** `Uint8Array`
___
<a id="values"></a>
## values
▸ **values**(): `Array`<`Base`>
*Inherited from Struct.values*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/782bb80/packages/api-codec/src/codec/Struct.ts#L147)*
**Returns:** `Array`<`Base`>
___
<a id="decode"></a>
## `<Static>` decode
▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` &#124; `Array`<`any`>*, isTuple: *`boolean`*): `T`
*Inherited from Struct.decode*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/782bb80/packages/api-codec/src/codec/Struct.ts#L45)*
**Type parameters:**
#### S
#### V
#### T
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
| value | `V` &#124; `Array`<`any`>|
| isTuple | `boolean` |
**Returns:** `T`
___
<a id="with"></a>
## `<Static>` with
▸ **with**<`S`>(Types: *`S`*): `object`
*Inherited from Struct.with*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/782bb80/packages/api-codec/src/codec/Struct.ts#L66)*
**Type parameters:**
#### S
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
**Returns:** `object`
___
docs/api-observable/classes/_classes_.rxproposaldeposits.md
+313
View File
@@ -0,0 +1,313 @@
# Type parameters
#### S
#### T
#### V
#### E
# Hierarchy
`Struct`
**↳ RxProposalDeposits**
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new RxProposalDeposits**(value: *`Tuple`*): [RxProposalDeposits](_classes_.rxproposaldeposits.md)
*Overrides Struct.__constructor*
*Defined in [classes.ts:31](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/classes.ts#L31)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| value | `Tuple` |
**Returns:** [RxProposalDeposits](_classes_.rxproposaldeposits.md)
___
# Properties
<a id="_types"></a>
## `<Protected>` _Types
**● _Types**: *`E`*
*Inherited from Struct._Types*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/782bb80/packages/api-codec/src/codec/Struct.ts#L27)*
___
<a id="_jsonmap"></a>
## `<Protected>` _jsonMap
**● _jsonMap**: *`Map`<`keyof S`, `string`>*
*Inherited from Struct._jsonMap*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/782bb80/packages/api-codec/src/codec/Struct.ts#L26)*
___
<a id="raw"></a>
## raw
**● raw**: *`T`*
*Inherited from Base.raw*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Base.ts:19](https://github.com/polkadot-js/api/blob/782bb80/packages/api-codec/src/codec/Base.ts#L19)*
___
# Accessors
<a id="type"></a>
## Type
getType(): `E`
*Inherited from Struct.Type*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/782bb80/packages/api-codec/src/codec/Struct.ts#L76)*
**Returns:** `E`
___
<a id="addresses"></a>
## addresses
getaddresses(): `Vector`<`AccountId`>
*Defined in [classes.ts:39](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/classes.ts#L39)*
**Returns:** `Vector`<`AccountId`>
___
<a id="balance"></a>
## balance
getbalance(): `Balance`
*Defined in [classes.ts:43](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/classes.ts#L43)*
**Returns:** `Balance`
___
# Methods
<a id="bytelength"></a>
## byteLength
▸ **byteLength**(): `number`
*Inherited from Struct.byteLength*
*Overrides Base.byteLength*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/782bb80/packages/api-codec/src/codec/Struct.ts#L80)*
**Returns:** `number`
___
<a id="fromjson"></a>
## fromJSON
▸ **fromJSON**(input: *`any`*): `Struct`<`S`, `T`, `V`, `E`>
*Inherited from Struct.fromJSON*
*Overrides Base.fromJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/782bb80/packages/api-codec/src/codec/Struct.ts#L86)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `any` |
**Returns:** `Struct`<`S`, `T`, `V`, `E`>
___
<a id="fromu8a"></a>
## fromU8a
▸ **fromU8a**(input: *`Uint8Array`*): `Struct`<`S`, `T`, `V`, `E`>
*Inherited from Struct.fromU8a*
*Overrides Base.fromU8a*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/782bb80/packages/api-codec/src/codec/Struct.ts#L101)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** `Struct`<`S`, `T`, `V`, `E`>
___
<a id="get"></a>
## get
▸ **get**(index: *`number`*): `Base`
*Inherited from Struct.get*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/782bb80/packages/api-codec/src/codec/Struct.ts#L111)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| index | `number` |
**Returns:** `Base`
___
<a id="keys"></a>
## keys
▸ **keys**(): `Array`<`string`>
*Inherited from Struct.keys*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/782bb80/packages/api-codec/src/codec/Struct.ts#L126)*
**Returns:** `Array`<`string`>
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Inherited from Struct.toJSON*
*Overrides Base.toJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/782bb80/packages/api-codec/src/codec/Struct.ts#L115)*
**Returns:** `any`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Inherited from Struct.toString*
*Overrides Base.toString*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/782bb80/packages/api-codec/src/codec/Struct.ts#L138)*
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Inherited from Struct.toU8a*
*Overrides Base.toU8a*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/782bb80/packages/api-codec/src/codec/Struct.ts#L130)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
**Returns:** `Uint8Array`
___
<a id="values"></a>
## values
▸ **values**(): `Array`<`Base`>
*Inherited from Struct.values*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/782bb80/packages/api-codec/src/codec/Struct.ts#L147)*
**Returns:** `Array`<`Base`>
___
<a id="decode"></a>
## `<Static>` decode
▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` &#124; `Array`<`any`>*, isTuple: *`boolean`*): `T`
*Inherited from Struct.decode*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/782bb80/packages/api-codec/src/codec/Struct.ts#L45)*
**Type parameters:**
#### S
#### V
#### T
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
| value | `V` &#124; `Array`<`any`>|
| isTuple | `boolean` |
**Returns:** `T`
___
<a id="with"></a>
## `<Static>` with
▸ **with**<`S`>(Types: *`S`*): `object`
*Inherited from Struct.with*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/782bb80/packages/api-codec/src/codec/Struct.ts#L66)*
**Type parameters:**
#### S
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
**Returns:** `object`
___
docs/api-observable/classes/_classes_.rxreferendum.md
+336
View File
@@ -0,0 +1,336 @@
# Type parameters
#### S
#### T
#### V
#### E
# Hierarchy
`Struct`
**↳ RxReferendum**
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new RxReferendum**(value: *`Tuple`*, id: * `ReferendumIndex` &#124; `BN` &#124; `number`*): [RxReferendum](_classes_.rxreferendum.md)
*Overrides Struct.__constructor*
*Defined in [classes.ts:48](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/classes.ts#L48)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| value | `Tuple` |
| id | `ReferendumIndex` &#124; `BN` &#124; `number`|
**Returns:** [RxReferendum](_classes_.rxreferendum.md)
___
# Properties
<a id="_types"></a>
## `<Protected>` _Types
**● _Types**: *`E`*
*Inherited from Struct._Types*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/782bb80/packages/api-codec/src/codec/Struct.ts#L27)*
___
<a id="_jsonmap"></a>
## `<Protected>` _jsonMap
**● _jsonMap**: *`Map`<`keyof S`, `string`>*
*Inherited from Struct._jsonMap*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/782bb80/packages/api-codec/src/codec/Struct.ts#L26)*
___
<a id="raw"></a>
## raw
**● raw**: *`T`*
*Inherited from Base.raw*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Base.ts:19](https://github.com/polkadot-js/api/blob/782bb80/packages/api-codec/src/codec/Base.ts#L19)*
___
# Accessors
<a id="type"></a>
## Type
getType(): `E`
*Inherited from Struct.Type*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/782bb80/packages/api-codec/src/codec/Struct.ts#L76)*
**Returns:** `E`
___
<a id="blocknumber"></a>
## blockNumber
getblockNumber(): `BlockNumber`
*Defined in [classes.ts:58](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/classes.ts#L58)*
**Returns:** `BlockNumber`
___
<a id="id"></a>
## id
getid(): `ReferendumIndex`
*Defined in [classes.ts:62](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/classes.ts#L62)*
**Returns:** `ReferendumIndex`
___
<a id="proposal"></a>
## proposal
getproposal(): `Proposal`
*Defined in [classes.ts:66](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/classes.ts#L66)*
**Returns:** `Proposal`
___
<a id="votethreshold"></a>
## voteThreshold
getvoteThreshold(): `VoteThreshold`
*Defined in [classes.ts:70](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/classes.ts#L70)*
**Returns:** `VoteThreshold`
___
# Methods
<a id="bytelength"></a>
## byteLength
▸ **byteLength**(): `number`
*Inherited from Struct.byteLength*
*Overrides Base.byteLength*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/782bb80/packages/api-codec/src/codec/Struct.ts#L80)*
**Returns:** `number`
___
<a id="fromjson"></a>
## fromJSON
▸ **fromJSON**(input: *`any`*): `Struct`<`S`, `T`, `V`, `E`>
*Inherited from Struct.fromJSON*
*Overrides Base.fromJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/782bb80/packages/api-codec/src/codec/Struct.ts#L86)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `any` |
**Returns:** `Struct`<`S`, `T`, `V`, `E`>
___
<a id="fromu8a"></a>
## fromU8a
▸ **fromU8a**(input: *`Uint8Array`*): `Struct`<`S`, `T`, `V`, `E`>
*Inherited from Struct.fromU8a*
*Overrides Base.fromU8a*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/782bb80/packages/api-codec/src/codec/Struct.ts#L101)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** `Struct`<`S`, `T`, `V`, `E`>
___
<a id="get"></a>
## get
▸ **get**(index: *`number`*): `Base`
*Inherited from Struct.get*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/782bb80/packages/api-codec/src/codec/Struct.ts#L111)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| index | `number` |
**Returns:** `Base`
___
<a id="keys"></a>
## keys
▸ **keys**(): `Array`<`string`>
*Inherited from Struct.keys*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/782bb80/packages/api-codec/src/codec/Struct.ts#L126)*
**Returns:** `Array`<`string`>
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Inherited from Struct.toJSON*
*Overrides Base.toJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/782bb80/packages/api-codec/src/codec/Struct.ts#L115)*
**Returns:** `any`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Inherited from Struct.toString*
*Overrides Base.toString*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/782bb80/packages/api-codec/src/codec/Struct.ts#L138)*
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Inherited from Struct.toU8a*
*Overrides Base.toU8a*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/782bb80/packages/api-codec/src/codec/Struct.ts#L130)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
**Returns:** `Uint8Array`
___
<a id="values"></a>
## values
▸ **values**(): `Array`<`Base`>
*Inherited from Struct.values*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/782bb80/packages/api-codec/src/codec/Struct.ts#L147)*
**Returns:** `Array`<`Base`>
___
<a id="decode"></a>
## `<Static>` decode
▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` &#124; `Array`<`any`>*, isTuple: *`boolean`*): `T`
*Inherited from Struct.decode*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/782bb80/packages/api-codec/src/codec/Struct.ts#L45)*
**Type parameters:**
#### S
#### V
#### T
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
| value | `V` &#124; `Array`<`any`>|
| isTuple | `boolean` |
**Returns:** `T`
___
<a id="with"></a>
## `<Static>` with
▸ **with**<`S`>(Types: *`S`*): `object`
*Inherited from Struct.with*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/782bb80/packages/api-codec/src/codec/Struct.ts#L66)*
**Type parameters:**
#### S
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
**Returns:** `object`
___
docs/api-observable/classes/_combined_.apicombined.md
+899
View File
@@ -0,0 +1,899 @@
# Hierarchy
↳ [ApiCalls](_calls_.apicalls.md)
**↳ ApiCombined**
↳ [Api](_index_.api.md)
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new ApiCombined**(api: *`RxApiInterface`*): [ApiCombined](_combined_.apicombined.md)
*Inherited from [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Base.ts#L22)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| api | `RxApiInterface` |
**Returns:** [ApiCombined](_combined_.apicombined.md)
___
# Properties
<a id="api"></a>
## `<Protected>` api
**● api**: *`RxApiInterface`*
*Inherited from [ApiBase](_base_.apibase.md).[api](_base_.apibase.md#api)*
*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Base.ts#L22)*
___
# Methods
<a id="bestnumber"></a>
## bestNumber
▸ **bestNumber**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Inherited from [ApiCalls](_calls_.apicalls.md).[bestNumber](_calls_.apicalls.md#bestnumber)*
*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Calls.ts#L13)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
___
<a id="chaingetblock"></a>
## chainGetBlock
▸ **chainGetBlock**(hash: *`Uint8Array`*): `Observable`< `SignedBlock` &#124; `undefined`>
*Inherited from [ApiCalls](_calls_.apicalls.md).[chainGetBlock](_calls_.apicalls.md#chaingetblock)*
*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Calls.ts#L25)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| hash | `Uint8Array` |
**Returns:** `Observable`< `SignedBlock` &#124; `undefined`>
___
<a id="chainnewhead"></a>
## chainNewHead
▸ **chainNewHead**(): `Observable`< `Header` &#124; `undefined`>
*Inherited from [ApiCalls](_calls_.apicalls.md).[chainNewHead](_calls_.apicalls.md#chainnewhead)*
*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Calls.ts#L29)*
**Returns:** `Observable`< `Header` &#124; `undefined`>
___
<a id="combine"></a>
## `<Protected>` combine
▸ **combine**<`T`,`R`>(observables: *`Array`<`Observable`<`any`>>*, mapfn?: *`MapFn`<`R`, `T`>*): `Observable`<`T`>
*Inherited from [ApiBase](_base_.apibase.md).[combine](_base_.apibase.md#combine)*
*Defined in [Base.ts:28](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Base.ts#L28)*
**Type parameters:**
#### T
#### R
**Parameters:**
| Param | Type | Default value |
| ------ | ------ | ------ |
| observables | `Array`<`Observable`<`any`>> | - |
| `Default value` mapfn | `MapFn`<`R`, `T`> | defaultMapFn |
**Returns:** `Observable`<`T`>
___
<a id="democacyvoteof"></a>
## democacyVoteOf
▸ **democacyVoteOf**(index: * `ReferendumIndex` &#124; `BN` &#124; `number`*, address: * `AccountId` &#124; `string`*): `Observable`<`Bool`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democacyVoteOf](_queries_.apiqueries.md#democacyvoteof)*
*Defined in [Queries.ts:76](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L76)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| index | `ReferendumIndex` &#124; `BN` &#124; `number`|
| address | `AccountId` &#124; `string`|
**Returns:** `Observable`<`Bool`>
___
<a id="democacyvotersfor"></a>
## democacyVotersFor
▸ **democacyVotersFor**(index: * `ReferendumIndex` &#124; `BN` &#124; `number`*): `Observable`<`Array`<`AccountId`>>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democacyVotersFor](_queries_.apiqueries.md#democacyvotersfor)*
*Defined in [Queries.ts:80](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L80)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| index | `ReferendumIndex` &#124; `BN` &#124; `number`|
**Returns:** `Observable`<`Array`<`AccountId`>>
___
<a id="democracylaunchperiod"></a>
## democracyLaunchPeriod
▸ **democracyLaunchPeriod**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyLaunchPeriod](_queries_.apiqueries.md#democracylaunchperiod)*
*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L19)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
___
<a id="democracynexttally"></a>
## democracyNextTally
▸ **democracyNextTally**(): `Observable`< `ReferendumIndex` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyNextTally](_queries_.apiqueries.md#democracynexttally)*
*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L23)*
**Returns:** `Observable`< `ReferendumIndex` &#124; `undefined`>
___
<a id="democracyproposalcount"></a>
## democracyProposalCount
▸ **democracyProposalCount**(): `Observable`<`number`>
*Defined in [Combined.ts:20](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Combined.ts#L20)*
**Returns:** `Observable`<`number`>
___
<a id="democracyproposaldeposits"></a>
## democracyProposalDeposits
▸ **democracyProposalDeposits**(proposalId: * `PropIndex` &#124; `BN` &#124; `number`*): `Observable`< [RxProposalDeposits](_classes_.rxproposaldeposits.md) &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyProposalDeposits](_queries_.apiqueries.md#democracyproposaldeposits)*
*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L27)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| proposalId | `PropIndex` &#124; `BN` &#124; `number`|
**Returns:** `Observable`< [RxProposalDeposits](_classes_.rxproposaldeposits.md) &#124; `undefined`>
___
<a id="democracypublicproposals"></a>
## democracyPublicProposals
▸ **democracyPublicProposals**(): `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyPublicProposals](_queries_.apiqueries.md#democracypublicproposals)*
*Defined in [Queries.ts:40](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L40)*
**Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>>
___
<a id="democracyreferendumcount"></a>
## democracyReferendumCount
▸ **democracyReferendumCount**(): `Observable`< `ReferendumIndex` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyReferendumCount](_queries_.apiqueries.md#democracyreferendumcount)*
*Defined in [Queries.ts:59](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L59)*
**Returns:** `Observable`< `ReferendumIndex` &#124; `undefined`>
___
<a id="democracyreferenduminfoof"></a>
## democracyReferendumInfoOf
▸ **democracyReferendumInfoOf**(referendumId: * `ReferendumIndex` &#124; `BN` &#124; `number`*): `Observable`< [RxReferendum](_classes_.rxreferendum.md) &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyReferendumInfoOf](_queries_.apiqueries.md#democracyreferenduminfoof)*
*Defined in [Queries.ts:63](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L63)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| referendumId | `ReferendumIndex` &#124; `BN` &#124; `number`|
**Returns:** `Observable`< [RxReferendum](_classes_.rxreferendum.md) &#124; `undefined`>
___
<a id="democracyreferenduminfos"></a>
## democracyReferendumInfos
▸ **democracyReferendumInfos**(referendumIds: *`Array`< `ReferendumIndex` &#124; `BN` &#124; `number`>*): `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>>
*Defined in [Combined.ts:30](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Combined.ts#L30)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| referendumIds | `Array`< `ReferendumIndex` &#124; `BN` &#124; `number`> |
**Returns:** `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>>
___
<a id="democracyreferendumvoters"></a>
## democracyReferendumVoters
▸ **democracyReferendumVoters**(referendumId: * `ReferendumIndex` &#124; `BN` &#124; `number`*): `Observable`<`Array`<[RxReferendumVote](../modules/_types_d_.md#rxreferendumvote)>>
*Defined in [Combined.ts:42](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Combined.ts#L42)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| referendumId | `ReferendumIndex` &#124; `BN` &#124; `number`|
**Returns:** `Observable`<`Array`<[RxReferendumVote](../modules/_types_d_.md#rxreferendumvote)>>
___
<a id="democracyreferendums"></a>
## democracyReferendums
▸ **democracyReferendums**(): `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>>
*Defined in [Combined.ts:58](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Combined.ts#L58)*
**Returns:** `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>>
___
<a id="democracyvotersbalancesof"></a>
## democracyVotersBalancesOf
▸ **democracyVotersBalancesOf**(referendumId: * `ReferendumIndex` &#124; `BN` &#124; `number`*): `Observable`<`Array`<`Balance`>>
*Defined in [Combined.ts:87](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Combined.ts#L87)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| referendumId | `ReferendumIndex` &#124; `BN` &#124; `number`|
**Returns:** `Observable`<`Array`<`Balance`>>
___
<a id="democracyvotersvotesof"></a>
## democracyVotersVotesOf
▸ **democracyVotersVotesOf**(referendumId: * `ReferendumIndex` &#124; `BN` &#124; `number`*): `Observable`<`Array`<`Bool`>>
*Defined in [Combined.ts:103](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Combined.ts#L103)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| referendumId | `ReferendumIndex` &#124; `BN` &#124; `number`|
**Returns:** `Observable`<`Array`<`Bool`>>
___
<a id="democracyvotesof"></a>
## democracyVotesOf
▸ **democracyVotesOf**(index: * `ReferendumIndex` &#124; `BN` &#124; `number`*, addresses: *`Array`< `AccountId` &#124; `string`>*): `Observable`<`boolean`>
*Defined in [Combined.ts:79](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Combined.ts#L79)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| index | `ReferendumIndex` &#124; `BN` &#124; `number`|
| addresses | `Array`< `AccountId` &#124; `string`> |
**Returns:** `Observable`<`boolean`>
___
<a id="democracyvotingperiod"></a>
## democracyVotingPeriod
▸ **democracyVotingPeriod**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyVotingPeriod](_queries_.apiqueries.md#democracyvotingperiod)*
*Defined in [Queries.ts:91](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L91)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
___
<a id="erablocklength"></a>
## eraBlockLength
▸ **eraBlockLength**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Combined.ts:114](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Combined.ts#L114)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
___
<a id="erablockprogress"></a>
## eraBlockProgress
▸ **eraBlockProgress**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Combined.ts:129](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Combined.ts#L129)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
___
<a id="erablockremaining"></a>
## eraBlockRemaining
▸ **eraBlockRemaining**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Combined.ts:151](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Combined.ts#L151)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
___
<a id="eralastlengthchange"></a>
## eraLastLengthChange
▸ **eraLastLengthChange**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[eraLastLengthChange](_queries_.apiqueries.md#eralastlengthchange)*
*Defined in [Queries.ts:116](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L116)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
___
<a id="fees"></a>
## fees
▸ **fees**(): `Observable`<[RxFees](../modules/_types_d_.md#rxfees)>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[fees](_queries_.apiqueries.md#fees)*
*Defined in [Queries.ts:95](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L95)*
**Returns:** `Observable`<[RxFees](../modules/_types_d_.md#rxfees)>
___
<a id="isconnected"></a>
## isConnected
▸ **isConnected**(): `Observable`<`boolean`>
*Inherited from [ApiBase](_base_.apibase.md).[isConnected](_base_.apibase.md#isconnected)*
*Defined in [Base.ts:36](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Base.ts#L36)*
**Returns:** `Observable`<`boolean`>
___
<a id="rawcall"></a>
## rawCall
▸ **rawCall**<`T`>(__namedParameters: *`object`*, ...params: *`Array`<`any`>*): `Observable`<`T`>
*Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)*
*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Base.ts#L40)*
**Type parameters:**
#### T
**Parameters:**
| Param | Type |
| ------ | ------ |
| __namedParameters | `object` |
| `Rest` params | `Array`<`any`> |
**Returns:** `Observable`<`T`>
___
<a id="rawstorage"></a>
## rawStorage
▸ **rawStorage**<`T`>(key: *`StorageFunction`*, ...params: *`Array`<`any`>*): `Observable`<`T`>
*Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)*
*Defined in [Base.ts:52](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Base.ts#L52)*
**Type parameters:**
#### T
**Parameters:**
| Param | Type |
| ------ | ------ |
| key | `StorageFunction` |
| `Rest` params | `Array`<`any`> |
**Returns:** `Observable`<`T`>
___
<a id="rawstoragemulti"></a>
## rawStorageMulti
▸ **rawStorageMulti**<`T`>(...keys: *`Array`< [`StorageFunction`] &#124; [`StorageFunction`, `any`]>*): `Observable`<`T`>
*Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)*
*Defined in [Base.ts:63](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Base.ts#L63)*
**Type parameters:**
#### T
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Rest` keys | `Array`< [`StorageFunction`] &#124; [`StorageFunction`, `any`]> |
**Returns:** `Observable`<`T`>
___
<a id="sessionblockprogress"></a>
## sessionBlockProgress
▸ **sessionBlockProgress**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Combined.ts:166](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Combined.ts#L166)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
___
<a id="sessionblockremaining"></a>
## sessionBlockRemaining
▸ **sessionBlockRemaining**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Combined.ts:185](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Combined.ts#L185)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
___
<a id="sessionbrokenvalue"></a>
## sessionBrokenValue
▸ **sessionBrokenValue**(): `Observable`< `Moment` &#124; `undefined`>
*Defined in [Combined.ts:200](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Combined.ts#L200)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
___
<a id="sessioncurrentindex"></a>
## sessionCurrentIndex
▸ **sessionCurrentIndex**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentIndex](_queries_.apiqueries.md#sessioncurrentindex)*
*Defined in [Queries.ts:128](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L128)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
___
<a id="sessioncurrentstart"></a>
## sessionCurrentStart
▸ **sessionCurrentStart**(): `Observable`< `Moment` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentStart](_queries_.apiqueries.md#sessioncurrentstart)*
*Defined in [Queries.ts:132](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L132)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
___
<a id="sessionlastlengthchange"></a>
## sessionLastLengthChange
▸ **sessionLastLengthChange**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLastLengthChange](_queries_.apiqueries.md#sessionlastlengthchange)*
*Defined in [Queries.ts:136](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L136)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
___
<a id="sessionlength"></a>
## sessionLength
▸ **sessionLength**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLength](_queries_.apiqueries.md#sessionlength)*
*Defined in [Queries.ts:140](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L140)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
___
<a id="sessionreward"></a>
## sessionReward
▸ **sessionReward**(): `Observable`< `Perbill` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionReward](_queries_.apiqueries.md#sessionreward)*
*Defined in [Queries.ts:120](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L120)*
**Returns:** `Observable`< `Perbill` &#124; `undefined`>
___
<a id="sessionrewardcurrent"></a>
## sessionRewardCurrent
▸ **sessionRewardCurrent**(): `Observable`< `Balance` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionRewardCurrent](_queries_.apiqueries.md#sessionrewardcurrent)*
*Defined in [Queries.ts:124](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L124)*
**Returns:** `Observable`< `Balance` &#124; `undefined`>
___
<a id="sessiontimeexpected"></a>
## sessionTimeExpected
▸ **sessionTimeExpected**(): `Observable`< `Moment` &#124; `undefined`>
*Defined in [Combined.ts:219](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Combined.ts#L219)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
___
<a id="sessiontimeremaining"></a>
## sessionTimeRemaining
▸ **sessionTimeRemaining**(): `Observable`< `Moment` &#124; `undefined`>
*Defined in [Combined.ts:234](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Combined.ts#L234)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
___
<a id="sessionvalidators"></a>
## sessionValidators
▸ **sessionValidators**(): `Observable`<`Array`<`AccountId`>>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionValidators](_queries_.apiqueries.md#sessionvalidators)*
*Defined in [Queries.ts:148](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L148)*
**Returns:** `Observable`<`Array`<`AccountId`>>
___
<a id="sessionsperera"></a>
## sessionsPerEra
▸ **sessionsPerEra**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionsPerEra](_queries_.apiqueries.md#sessionsperera)*
*Defined in [Queries.ts:144](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L144)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
___
<a id="stakingfreebalanceof"></a>
## stakingFreeBalanceOf
▸ **stakingFreeBalanceOf**(address: * `AccountId` &#124; `string`*): `Observable`< `Balance` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingFreeBalanceOf](_queries_.apiqueries.md#stakingfreebalanceof)*
*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L171)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| address | `AccountId` &#124; `string`|
**Returns:** `Observable`< `Balance` &#124; `undefined`>
___
<a id="stakingintentions"></a>
## stakingIntentions
▸ **stakingIntentions**(): `Observable`<`Array`<`AccountId`>>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingIntentions](_queries_.apiqueries.md#stakingintentions)*
*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L159)*
**Returns:** `Observable`<`Array`<`AccountId`>>
___
<a id="stakingnominating"></a>
## stakingNominating
▸ **stakingNominating**(address: * `AccountId` &#124; `string`*): `Observable`< `AccountId` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominating](_queries_.apiqueries.md#stakingnominating)*
*Defined in [Queries.ts:186](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L186)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| address | `AccountId` &#124; `string`|
**Returns:** `Observable`< `AccountId` &#124; `undefined`>
___
<a id="stakingnominatorsfor"></a>
## stakingNominatorsFor
▸ **stakingNominatorsFor**(address: * `AccountId` &#124; `string`*): `Observable`<`Array`<`AccountId`>>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominatorsFor](_queries_.apiqueries.md#stakingnominatorsfor)*
*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L175)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| address | `AccountId` &#124; `string`|
**Returns:** `Observable`<`Array`<`AccountId`>>
___
<a id="stakingreservedbalanceof"></a>
## stakingReservedBalanceOf
▸ **stakingReservedBalanceOf**(address: * `AccountId` &#124; `string`*): `Observable`< `Balance` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingReservedBalanceOf](_queries_.apiqueries.md#stakingreservedbalanceof)*
*Defined in [Queries.ts:191](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L191)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| address | `AccountId` &#124; `string`|
**Returns:** `Observable`< `Balance` &#124; `undefined`>
___
<a id="systemaccountindexof"></a>
## systemAccountIndexOf
▸ **systemAccountIndexOf**(address: * `AccountId` &#124; `string`*): `Observable`< `Index` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[systemAccountIndexOf](_queries_.apiqueries.md#systemaccountindexof)*
*Defined in [Queries.ts:203](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L203)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| address | `AccountId` &#124; `string`|
**Returns:** `Observable`< `Index` &#124; `undefined`>
___
<a id="timestampblockperiod"></a>
## timestampBlockPeriod
▸ **timestampBlockPeriod**(): `Observable`< `Moment` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[timestampBlockPeriod](_queries_.apiqueries.md#timestampblockperiod)*
*Defined in [Queries.ts:195](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L195)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
___
<a id="timestampnow"></a>
## timestampNow
▸ **timestampNow**(): `Observable`< `Moment` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[timestampNow](_queries_.apiqueries.md#timestampnow)*
*Defined in [Queries.ts:199](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L199)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
___
<a id="validatingbalance"></a>
## validatingBalance
▸ **validatingBalance**(address: * `AccountId` &#124; `string`*): `Observable`<[RxBalance](../modules/_types_d_.md#rxbalance)>
*Defined in [Combined.ts:249](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Combined.ts#L249)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| address | `AccountId` &#124; `string`|
**Returns:** `Observable`<[RxBalance](../modules/_types_d_.md#rxbalance)>
___
<a id="validatingbalances"></a>
## validatingBalances
▸ **validatingBalances**(...addresses: *`Array`< `AccountId` &#124; `string`>*): `Observable`<[RxBalanceMap](../modules/_types_d_.md#rxbalancemap)>
*Defined in [Combined.ts:274](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Combined.ts#L274)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Rest` addresses | `Array`< `AccountId` &#124; `string`> |
**Returns:** `Observable`<[RxBalanceMap](../modules/_types_d_.md#rxbalancemap)>
___
<a id="validatorcount"></a>
## validatorCount
▸ **validatorCount**(): `Observable`<`u32`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[validatorCount](_queries_.apiqueries.md#validatorcount)*
*Defined in [Queries.ts:207](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L207)*
**Returns:** `Observable`<`u32`>
___
<a id="votingbalance"></a>
## votingBalance
▸ **votingBalance**(_address: * `AccountId` &#124; `string`*): `Observable`<[RxBalance](../modules/_types_d_.md#rxbalance)>
*Defined in [Combined.ts:288](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Combined.ts#L288)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| _address | `AccountId` &#124; `string`|
**Returns:** `Observable`<[RxBalance](../modules/_types_d_.md#rxbalance)>
___
<a id="votingbalances"></a>
## votingBalances
▸ **votingBalances**(...addresses: *`Array`< `AccountId` &#124; `string`>*): `Observable`<[RxBalance](../modules/_types_d_.md#rxbalance)[]>
*Defined in [Combined.ts:322](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Combined.ts#L322)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Rest` addresses | `Array`< `AccountId` &#124; `string`> |
**Returns:** `Observable`<[RxBalance](../modules/_types_d_.md#rxbalance)[]>
___
<a id="votingbalancesnominatorsfor"></a>
## votingBalancesNominatorsFor
▸ **votingBalancesNominatorsFor**(address: * `AccountId` &#124; `string`*): `Observable`<`any`>
*Defined in [Combined.ts:311](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Combined.ts#L311)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| address | `AccountId` &#124; `string`|
**Returns:** `Observable`<`any`>
___
docs/api-observable/classes/_index_.api.md
+937
View File
@@ -0,0 +1,937 @@
# Hierarchy
↳ [ApiCombined](_combined_.apicombined.md)
**↳ Api**
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new Api**(api: *`RxApiInterface`*): [Api](_index_.api.md)
*Inherited from [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Base.ts#L22)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| api | `RxApiInterface` |
**Returns:** [Api](_index_.api.md)
___
# Properties
<a id="api"></a>
## `<Protected>` api
**● api**: *`RxApiInterface`*
*Inherited from [ApiBase](_base_.apibase.md).[api](_base_.apibase.md#api)*
*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Base.ts#L22)*
___
# Methods
<a id="bestnumber"></a>
## bestNumber
▸ **bestNumber**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Inherited from [ApiCalls](_calls_.apicalls.md).[bestNumber](_calls_.apicalls.md#bestnumber)*
*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Calls.ts#L13)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
___
<a id="chaingetblock"></a>
## chainGetBlock
▸ **chainGetBlock**(hash: *`Uint8Array`*): `Observable`< `SignedBlock` &#124; `undefined`>
*Inherited from [ApiCalls](_calls_.apicalls.md).[chainGetBlock](_calls_.apicalls.md#chaingetblock)*
*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Calls.ts#L25)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| hash | `Uint8Array` |
**Returns:** `Observable`< `SignedBlock` &#124; `undefined`>
___
<a id="chainnewhead"></a>
## chainNewHead
▸ **chainNewHead**(): `Observable`< `Header` &#124; `undefined`>
*Inherited from [ApiCalls](_calls_.apicalls.md).[chainNewHead](_calls_.apicalls.md#chainnewhead)*
*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Calls.ts#L29)*
**Returns:** `Observable`< `Header` &#124; `undefined`>
___
<a id="combine"></a>
## `<Protected>` combine
▸ **combine**<`T`,`R`>(observables: *`Array`<`Observable`<`any`>>*, mapfn?: *`MapFn`<`R`, `T`>*): `Observable`<`T`>
*Inherited from [ApiBase](_base_.apibase.md).[combine](_base_.apibase.md#combine)*
*Defined in [Base.ts:28](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Base.ts#L28)*
**Type parameters:**
#### T
#### R
**Parameters:**
| Param | Type | Default value |
| ------ | ------ | ------ |
| observables | `Array`<`Observable`<`any`>> | - |
| `Default value` mapfn | `MapFn`<`R`, `T`> | defaultMapFn |
**Returns:** `Observable`<`T`>
___
<a id="democacyvoteof"></a>
## democacyVoteOf
▸ **democacyVoteOf**(index: * `ReferendumIndex` &#124; `BN` &#124; `number`*, address: * `AccountId` &#124; `string`*): `Observable`<`Bool`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democacyVoteOf](_queries_.apiqueries.md#democacyvoteof)*
*Defined in [Queries.ts:76](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L76)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| index | `ReferendumIndex` &#124; `BN` &#124; `number`|
| address | `AccountId` &#124; `string`|
**Returns:** `Observable`<`Bool`>
___
<a id="democacyvotersfor"></a>
## democacyVotersFor
▸ **democacyVotersFor**(index: * `ReferendumIndex` &#124; `BN` &#124; `number`*): `Observable`<`Array`<`AccountId`>>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democacyVotersFor](_queries_.apiqueries.md#democacyvotersfor)*
*Defined in [Queries.ts:80](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L80)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| index | `ReferendumIndex` &#124; `BN` &#124; `number`|
**Returns:** `Observable`<`Array`<`AccountId`>>
___
<a id="democracylaunchperiod"></a>
## democracyLaunchPeriod
▸ **democracyLaunchPeriod**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyLaunchPeriod](_queries_.apiqueries.md#democracylaunchperiod)*
*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L19)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
___
<a id="democracynexttally"></a>
## democracyNextTally
▸ **democracyNextTally**(): `Observable`< `ReferendumIndex` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyNextTally](_queries_.apiqueries.md#democracynexttally)*
*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L23)*
**Returns:** `Observable`< `ReferendumIndex` &#124; `undefined`>
___
<a id="democracyproposalcount"></a>
## democracyProposalCount
▸ **democracyProposalCount**(): `Observable`<`number`>
*Inherited from [ApiCombined](_combined_.apicombined.md).[democracyProposalCount](_combined_.apicombined.md#democracyproposalcount)*
*Defined in [Combined.ts:20](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Combined.ts#L20)*
**Returns:** `Observable`<`number`>
___
<a id="democracyproposaldeposits"></a>
## democracyProposalDeposits
▸ **democracyProposalDeposits**(proposalId: * `PropIndex` &#124; `BN` &#124; `number`*): `Observable`< [RxProposalDeposits](_classes_.rxproposaldeposits.md) &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyProposalDeposits](_queries_.apiqueries.md#democracyproposaldeposits)*
*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L27)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| proposalId | `PropIndex` &#124; `BN` &#124; `number`|
**Returns:** `Observable`< [RxProposalDeposits](_classes_.rxproposaldeposits.md) &#124; `undefined`>
___
<a id="democracypublicproposals"></a>
## democracyPublicProposals
▸ **democracyPublicProposals**(): `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyPublicProposals](_queries_.apiqueries.md#democracypublicproposals)*
*Defined in [Queries.ts:40](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L40)*
**Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>>
___
<a id="democracyreferendumcount"></a>
## democracyReferendumCount
▸ **democracyReferendumCount**(): `Observable`< `ReferendumIndex` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyReferendumCount](_queries_.apiqueries.md#democracyreferendumcount)*
*Defined in [Queries.ts:59](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L59)*
**Returns:** `Observable`< `ReferendumIndex` &#124; `undefined`>
___
<a id="democracyreferenduminfoof"></a>
## democracyReferendumInfoOf
▸ **democracyReferendumInfoOf**(referendumId: * `ReferendumIndex` &#124; `BN` &#124; `number`*): `Observable`< [RxReferendum](_classes_.rxreferendum.md) &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyReferendumInfoOf](_queries_.apiqueries.md#democracyreferenduminfoof)*
*Defined in [Queries.ts:63](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L63)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| referendumId | `ReferendumIndex` &#124; `BN` &#124; `number`|
**Returns:** `Observable`< [RxReferendum](_classes_.rxreferendum.md) &#124; `undefined`>
___
<a id="democracyreferenduminfos"></a>
## democracyReferendumInfos
▸ **democracyReferendumInfos**(referendumIds: *`Array`< `ReferendumIndex` &#124; `BN` &#124; `number`>*): `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>>
*Inherited from [ApiCombined](_combined_.apicombined.md).[democracyReferendumInfos](_combined_.apicombined.md#democracyreferenduminfos)*
*Defined in [Combined.ts:30](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Combined.ts#L30)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| referendumIds | `Array`< `ReferendumIndex` &#124; `BN` &#124; `number`> |
**Returns:** `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>>
___
<a id="democracyreferendumvoters"></a>
## democracyReferendumVoters
▸ **democracyReferendumVoters**(referendumId: * `ReferendumIndex` &#124; `BN` &#124; `number`*): `Observable`<`Array`<[RxReferendumVote](../modules/_types_d_.md#rxreferendumvote)>>
*Inherited from [ApiCombined](_combined_.apicombined.md).[democracyReferendumVoters](_combined_.apicombined.md#democracyreferendumvoters)*
*Defined in [Combined.ts:42](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Combined.ts#L42)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| referendumId | `ReferendumIndex` &#124; `BN` &#124; `number`|
**Returns:** `Observable`<`Array`<[RxReferendumVote](../modules/_types_d_.md#rxreferendumvote)>>
___
<a id="democracyreferendums"></a>
## democracyReferendums
▸ **democracyReferendums**(): `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>>
*Inherited from [ApiCombined](_combined_.apicombined.md).[democracyReferendums](_combined_.apicombined.md#democracyreferendums)*
*Defined in [Combined.ts:58](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Combined.ts#L58)*
**Returns:** `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>>
___
<a id="democracyvotersbalancesof"></a>
## democracyVotersBalancesOf
▸ **democracyVotersBalancesOf**(referendumId: * `ReferendumIndex` &#124; `BN` &#124; `number`*): `Observable`<`Array`<`Balance`>>
*Inherited from [ApiCombined](_combined_.apicombined.md).[democracyVotersBalancesOf](_combined_.apicombined.md#democracyvotersbalancesof)*
*Defined in [Combined.ts:87](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Combined.ts#L87)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| referendumId | `ReferendumIndex` &#124; `BN` &#124; `number`|
**Returns:** `Observable`<`Array`<`Balance`>>
___
<a id="democracyvotersvotesof"></a>
## democracyVotersVotesOf
▸ **democracyVotersVotesOf**(referendumId: * `ReferendumIndex` &#124; `BN` &#124; `number`*): `Observable`<`Array`<`Bool`>>
*Inherited from [ApiCombined](_combined_.apicombined.md).[democracyVotersVotesOf](_combined_.apicombined.md#democracyvotersvotesof)*
*Defined in [Combined.ts:103](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Combined.ts#L103)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| referendumId | `ReferendumIndex` &#124; `BN` &#124; `number`|
**Returns:** `Observable`<`Array`<`Bool`>>
___
<a id="democracyvotesof"></a>
## democracyVotesOf
▸ **democracyVotesOf**(index: * `ReferendumIndex` &#124; `BN` &#124; `number`*, addresses: *`Array`< `AccountId` &#124; `string`>*): `Observable`<`boolean`>
*Inherited from [ApiCombined](_combined_.apicombined.md).[democracyVotesOf](_combined_.apicombined.md#democracyvotesof)*
*Defined in [Combined.ts:79](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Combined.ts#L79)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| index | `ReferendumIndex` &#124; `BN` &#124; `number`|
| addresses | `Array`< `AccountId` &#124; `string`> |
**Returns:** `Observable`<`boolean`>
___
<a id="democracyvotingperiod"></a>
## democracyVotingPeriod
▸ **democracyVotingPeriod**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyVotingPeriod](_queries_.apiqueries.md#democracyvotingperiod)*
*Defined in [Queries.ts:91](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L91)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
___
<a id="erablocklength"></a>
## eraBlockLength
▸ **eraBlockLength**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Inherited from [ApiCombined](_combined_.apicombined.md).[eraBlockLength](_combined_.apicombined.md#erablocklength)*
*Defined in [Combined.ts:114](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Combined.ts#L114)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
___
<a id="erablockprogress"></a>
## eraBlockProgress
▸ **eraBlockProgress**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Inherited from [ApiCombined](_combined_.apicombined.md).[eraBlockProgress](_combined_.apicombined.md#erablockprogress)*
*Defined in [Combined.ts:129](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Combined.ts#L129)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
___
<a id="erablockremaining"></a>
## eraBlockRemaining
▸ **eraBlockRemaining**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Inherited from [ApiCombined](_combined_.apicombined.md).[eraBlockRemaining](_combined_.apicombined.md#erablockremaining)*
*Defined in [Combined.ts:151](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Combined.ts#L151)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
___
<a id="eralastlengthchange"></a>
## eraLastLengthChange
▸ **eraLastLengthChange**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[eraLastLengthChange](_queries_.apiqueries.md#eralastlengthchange)*
*Defined in [Queries.ts:116](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L116)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
___
<a id="fees"></a>
## fees
▸ **fees**(): `Observable`<[RxFees](../modules/_types_d_.md#rxfees)>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[fees](_queries_.apiqueries.md#fees)*
*Defined in [Queries.ts:95](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L95)*
**Returns:** `Observable`<[RxFees](../modules/_types_d_.md#rxfees)>
___
<a id="isconnected"></a>
## isConnected
▸ **isConnected**(): `Observable`<`boolean`>
*Inherited from [ApiBase](_base_.apibase.md).[isConnected](_base_.apibase.md#isconnected)*
*Defined in [Base.ts:36](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Base.ts#L36)*
**Returns:** `Observable`<`boolean`>
___
<a id="rawcall"></a>
## rawCall
▸ **rawCall**<`T`>(__namedParameters: *`object`*, ...params: *`Array`<`any`>*): `Observable`<`T`>
*Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)*
*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Base.ts#L40)*
**Type parameters:**
#### T
**Parameters:**
| Param | Type |
| ------ | ------ |
| __namedParameters | `object` |
| `Rest` params | `Array`<`any`> |
**Returns:** `Observable`<`T`>
___
<a id="rawstorage"></a>
## rawStorage
▸ **rawStorage**<`T`>(key: *`StorageFunction`*, ...params: *`Array`<`any`>*): `Observable`<`T`>
*Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)*
*Defined in [Base.ts:52](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Base.ts#L52)*
**Type parameters:**
#### T
**Parameters:**
| Param | Type |
| ------ | ------ |
| key | `StorageFunction` |
| `Rest` params | `Array`<`any`> |
**Returns:** `Observable`<`T`>
___
<a id="rawstoragemulti"></a>
## rawStorageMulti
▸ **rawStorageMulti**<`T`>(...keys: *`Array`< [`StorageFunction`] &#124; [`StorageFunction`, `any`]>*): `Observable`<`T`>
*Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)*
*Defined in [Base.ts:63](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Base.ts#L63)*
**Type parameters:**
#### T
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Rest` keys | `Array`< [`StorageFunction`] &#124; [`StorageFunction`, `any`]> |
**Returns:** `Observable`<`T`>
___
<a id="sessionblockprogress"></a>
## sessionBlockProgress
▸ **sessionBlockProgress**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Inherited from [ApiCombined](_combined_.apicombined.md).[sessionBlockProgress](_combined_.apicombined.md#sessionblockprogress)*
*Defined in [Combined.ts:166](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Combined.ts#L166)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
___
<a id="sessionblockremaining"></a>
## sessionBlockRemaining
▸ **sessionBlockRemaining**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Inherited from [ApiCombined](_combined_.apicombined.md).[sessionBlockRemaining](_combined_.apicombined.md#sessionblockremaining)*
*Defined in [Combined.ts:185](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Combined.ts#L185)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
___
<a id="sessionbrokenvalue"></a>
## sessionBrokenValue
▸ **sessionBrokenValue**(): `Observable`< `Moment` &#124; `undefined`>
*Inherited from [ApiCombined](_combined_.apicombined.md).[sessionBrokenValue](_combined_.apicombined.md#sessionbrokenvalue)*
*Defined in [Combined.ts:200](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Combined.ts#L200)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
___
<a id="sessioncurrentindex"></a>
## sessionCurrentIndex
▸ **sessionCurrentIndex**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentIndex](_queries_.apiqueries.md#sessioncurrentindex)*
*Defined in [Queries.ts:128](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L128)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
___
<a id="sessioncurrentstart"></a>
## sessionCurrentStart
▸ **sessionCurrentStart**(): `Observable`< `Moment` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentStart](_queries_.apiqueries.md#sessioncurrentstart)*
*Defined in [Queries.ts:132](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L132)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
___
<a id="sessionlastlengthchange"></a>
## sessionLastLengthChange
▸ **sessionLastLengthChange**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLastLengthChange](_queries_.apiqueries.md#sessionlastlengthchange)*
*Defined in [Queries.ts:136](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L136)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
___
<a id="sessionlength"></a>
## sessionLength
▸ **sessionLength**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLength](_queries_.apiqueries.md#sessionlength)*
*Defined in [Queries.ts:140](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L140)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
___
<a id="sessionreward"></a>
## sessionReward
▸ **sessionReward**(): `Observable`< `Perbill` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionReward](_queries_.apiqueries.md#sessionreward)*
*Defined in [Queries.ts:120](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L120)*
**Returns:** `Observable`< `Perbill` &#124; `undefined`>
___
<a id="sessionrewardcurrent"></a>
## sessionRewardCurrent
▸ **sessionRewardCurrent**(): `Observable`< `Balance` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionRewardCurrent](_queries_.apiqueries.md#sessionrewardcurrent)*
*Defined in [Queries.ts:124](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L124)*
**Returns:** `Observable`< `Balance` &#124; `undefined`>
___
<a id="sessiontimeexpected"></a>
## sessionTimeExpected
▸ **sessionTimeExpected**(): `Observable`< `Moment` &#124; `undefined`>
*Inherited from [ApiCombined](_combined_.apicombined.md).[sessionTimeExpected](_combined_.apicombined.md#sessiontimeexpected)*
*Defined in [Combined.ts:219](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Combined.ts#L219)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
___
<a id="sessiontimeremaining"></a>
## sessionTimeRemaining
▸ **sessionTimeRemaining**(): `Observable`< `Moment` &#124; `undefined`>
*Inherited from [ApiCombined](_combined_.apicombined.md).[sessionTimeRemaining](_combined_.apicombined.md#sessiontimeremaining)*
*Defined in [Combined.ts:234](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Combined.ts#L234)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
___
<a id="sessionvalidators"></a>
## sessionValidators
▸ **sessionValidators**(): `Observable`<`Array`<`AccountId`>>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionValidators](_queries_.apiqueries.md#sessionvalidators)*
*Defined in [Queries.ts:148](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L148)*
**Returns:** `Observable`<`Array`<`AccountId`>>
___
<a id="sessionsperera"></a>
## sessionsPerEra
▸ **sessionsPerEra**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionsPerEra](_queries_.apiqueries.md#sessionsperera)*
*Defined in [Queries.ts:144](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L144)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
___
<a id="stakingfreebalanceof"></a>
## stakingFreeBalanceOf
▸ **stakingFreeBalanceOf**(address: * `AccountId` &#124; `string`*): `Observable`< `Balance` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingFreeBalanceOf](_queries_.apiqueries.md#stakingfreebalanceof)*
*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L171)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| address | `AccountId` &#124; `string`|
**Returns:** `Observable`< `Balance` &#124; `undefined`>
___
<a id="stakingintentions"></a>
## stakingIntentions
▸ **stakingIntentions**(): `Observable`<`Array`<`AccountId`>>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingIntentions](_queries_.apiqueries.md#stakingintentions)*
*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L159)*
**Returns:** `Observable`<`Array`<`AccountId`>>
___
<a id="stakingnominating"></a>
## stakingNominating
▸ **stakingNominating**(address: * `AccountId` &#124; `string`*): `Observable`< `AccountId` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominating](_queries_.apiqueries.md#stakingnominating)*
*Defined in [Queries.ts:186](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L186)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| address | `AccountId` &#124; `string`|
**Returns:** `Observable`< `AccountId` &#124; `undefined`>
___
<a id="stakingnominatorsfor"></a>
## stakingNominatorsFor
▸ **stakingNominatorsFor**(address: * `AccountId` &#124; `string`*): `Observable`<`Array`<`AccountId`>>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominatorsFor](_queries_.apiqueries.md#stakingnominatorsfor)*
*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L175)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| address | `AccountId` &#124; `string`|
**Returns:** `Observable`<`Array`<`AccountId`>>
___
<a id="stakingreservedbalanceof"></a>
## stakingReservedBalanceOf
▸ **stakingReservedBalanceOf**(address: * `AccountId` &#124; `string`*): `Observable`< `Balance` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingReservedBalanceOf](_queries_.apiqueries.md#stakingreservedbalanceof)*
*Defined in [Queries.ts:191](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L191)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| address | `AccountId` &#124; `string`|
**Returns:** `Observable`< `Balance` &#124; `undefined`>
___
<a id="systemaccountindexof"></a>
## systemAccountIndexOf
▸ **systemAccountIndexOf**(address: * `AccountId` &#124; `string`*): `Observable`< `Index` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[systemAccountIndexOf](_queries_.apiqueries.md#systemaccountindexof)*
*Defined in [Queries.ts:203](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L203)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| address | `AccountId` &#124; `string`|
**Returns:** `Observable`< `Index` &#124; `undefined`>
___
<a id="timestampblockperiod"></a>
## timestampBlockPeriod
▸ **timestampBlockPeriod**(): `Observable`< `Moment` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[timestampBlockPeriod](_queries_.apiqueries.md#timestampblockperiod)*
*Defined in [Queries.ts:195](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L195)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
___
<a id="timestampnow"></a>
## timestampNow
▸ **timestampNow**(): `Observable`< `Moment` &#124; `undefined`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[timestampNow](_queries_.apiqueries.md#timestampnow)*
*Defined in [Queries.ts:199](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L199)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
___
<a id="validatingbalance"></a>
## validatingBalance
▸ **validatingBalance**(address: * `AccountId` &#124; `string`*): `Observable`<[RxBalance](../modules/_types_d_.md#rxbalance)>
*Inherited from [ApiCombined](_combined_.apicombined.md).[validatingBalance](_combined_.apicombined.md#validatingbalance)*
*Defined in [Combined.ts:249](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Combined.ts#L249)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| address | `AccountId` &#124; `string`|
**Returns:** `Observable`<[RxBalance](../modules/_types_d_.md#rxbalance)>
___
<a id="validatingbalances"></a>
## validatingBalances
▸ **validatingBalances**(...addresses: *`Array`< `AccountId` &#124; `string`>*): `Observable`<[RxBalanceMap](../modules/_types_d_.md#rxbalancemap)>
*Inherited from [ApiCombined](_combined_.apicombined.md).[validatingBalances](_combined_.apicombined.md#validatingbalances)*
*Defined in [Combined.ts:274](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Combined.ts#L274)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Rest` addresses | `Array`< `AccountId` &#124; `string`> |
**Returns:** `Observable`<[RxBalanceMap](../modules/_types_d_.md#rxbalancemap)>
___
<a id="validatorcount"></a>
## validatorCount
▸ **validatorCount**(): `Observable`<`u32`>
*Inherited from [ApiQueries](_queries_.apiqueries.md).[validatorCount](_queries_.apiqueries.md#validatorcount)*
*Defined in [Queries.ts:207](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L207)*
**Returns:** `Observable`<`u32`>
___
<a id="votingbalance"></a>
## votingBalance
▸ **votingBalance**(_address: * `AccountId` &#124; `string`*): `Observable`<[RxBalance](../modules/_types_d_.md#rxbalance)>
*Inherited from [ApiCombined](_combined_.apicombined.md).[votingBalance](_combined_.apicombined.md#votingbalance)*
*Defined in [Combined.ts:288](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Combined.ts#L288)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| _address | `AccountId` &#124; `string`|
**Returns:** `Observable`<[RxBalance](../modules/_types_d_.md#rxbalance)>
___
<a id="votingbalances"></a>
## votingBalances
▸ **votingBalances**(...addresses: *`Array`< `AccountId` &#124; `string`>*): `Observable`<[RxBalance](../modules/_types_d_.md#rxbalance)[]>
*Inherited from [ApiCombined](_combined_.apicombined.md).[votingBalances](_combined_.apicombined.md#votingbalances)*
*Defined in [Combined.ts:322](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Combined.ts#L322)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Rest` addresses | `Array`< `AccountId` &#124; `string`> |
**Returns:** `Observable`<[RxBalance](../modules/_types_d_.md#rxbalance)[]>
___
<a id="votingbalancesnominatorsfor"></a>
## votingBalancesNominatorsFor
▸ **votingBalancesNominatorsFor**(address: * `AccountId` &#124; `string`*): `Observable`<`any`>
*Inherited from [ApiCombined](_combined_.apicombined.md).[votingBalancesNominatorsFor](_combined_.apicombined.md#votingbalancesnominatorsfor)*
*Defined in [Combined.ts:311](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Combined.ts#L311)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| address | `AccountId` &#124; `string`|
**Returns:** `Observable`<`any`>
___
docs/api-observable/classes/_queries_.apiqueries.md
+517
View File
@@ -0,0 +1,517 @@
# Hierarchy
[ApiBase](_base_.apibase.md)
**↳ ApiQueries**
↳ [ApiCalls](_calls_.apicalls.md)
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new ApiQueries**(api: *`RxApiInterface`*): [ApiQueries](_queries_.apiqueries.md)
*Inherited from [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Base.ts#L22)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| api | `RxApiInterface` |
**Returns:** [ApiQueries](_queries_.apiqueries.md)
___
# Properties
<a id="api"></a>
## `<Protected>` api
**● api**: *`RxApiInterface`*
*Inherited from [ApiBase](_base_.apibase.md).[api](_base_.apibase.md#api)*
*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Base.ts#L22)*
___
# Methods
<a id="combine"></a>
## `<Protected>` combine
▸ **combine**<`T`,`R`>(observables: *`Array`<`Observable`<`any`>>*, mapfn?: *`MapFn`<`R`, `T`>*): `Observable`<`T`>
*Inherited from [ApiBase](_base_.apibase.md).[combine](_base_.apibase.md#combine)*
*Defined in [Base.ts:28](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Base.ts#L28)*
**Type parameters:**
#### T
#### R
**Parameters:**
| Param | Type | Default value |
| ------ | ------ | ------ |
| observables | `Array`<`Observable`<`any`>> | - |
| `Default value` mapfn | `MapFn`<`R`, `T`> | defaultMapFn |
**Returns:** `Observable`<`T`>
___
<a id="democacyvoteof"></a>
## democacyVoteOf
▸ **democacyVoteOf**(index: * `ReferendumIndex` &#124; `BN` &#124; `number`*, address: * `AccountId` &#124; `string`*): `Observable`<`Bool`>
*Defined in [Queries.ts:76](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L76)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| index | `ReferendumIndex` &#124; `BN` &#124; `number`|
| address | `AccountId` &#124; `string`|
**Returns:** `Observable`<`Bool`>
___
<a id="democacyvotersfor"></a>
## democacyVotersFor
▸ **democacyVotersFor**(index: * `ReferendumIndex` &#124; `BN` &#124; `number`*): `Observable`<`Array`<`AccountId`>>
*Defined in [Queries.ts:80](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L80)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| index | `ReferendumIndex` &#124; `BN` &#124; `number`|
**Returns:** `Observable`<`Array`<`AccountId`>>
___
<a id="democracylaunchperiod"></a>
## democracyLaunchPeriod
▸ **democracyLaunchPeriod**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L19)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
___
<a id="democracynexttally"></a>
## democracyNextTally
▸ **democracyNextTally**(): `Observable`< `ReferendumIndex` &#124; `undefined`>
*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L23)*
**Returns:** `Observable`< `ReferendumIndex` &#124; `undefined`>
___
<a id="democracyproposaldeposits"></a>
## democracyProposalDeposits
▸ **democracyProposalDeposits**(proposalId: * `PropIndex` &#124; `BN` &#124; `number`*): `Observable`< [RxProposalDeposits](_classes_.rxproposaldeposits.md) &#124; `undefined`>
*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L27)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| proposalId | `PropIndex` &#124; `BN` &#124; `number`|
**Returns:** `Observable`< [RxProposalDeposits](_classes_.rxproposaldeposits.md) &#124; `undefined`>
___
<a id="democracypublicproposals"></a>
## democracyPublicProposals
▸ **democracyPublicProposals**(): `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>>
*Defined in [Queries.ts:40](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L40)*
**Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>>
___
<a id="democracyreferendumcount"></a>
## democracyReferendumCount
▸ **democracyReferendumCount**(): `Observable`< `ReferendumIndex` &#124; `undefined`>
*Defined in [Queries.ts:59](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L59)*
**Returns:** `Observable`< `ReferendumIndex` &#124; `undefined`>
___
<a id="democracyreferenduminfoof"></a>
## democracyReferendumInfoOf
▸ **democracyReferendumInfoOf**(referendumId: * `ReferendumIndex` &#124; `BN` &#124; `number`*): `Observable`< [RxReferendum](_classes_.rxreferendum.md) &#124; `undefined`>
*Defined in [Queries.ts:63](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L63)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| referendumId | `ReferendumIndex` &#124; `BN` &#124; `number`|
**Returns:** `Observable`< [RxReferendum](_classes_.rxreferendum.md) &#124; `undefined`>
___
<a id="democracyvotingperiod"></a>
## democracyVotingPeriod
▸ **democracyVotingPeriod**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Queries.ts:91](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L91)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
___
<a id="eralastlengthchange"></a>
## eraLastLengthChange
▸ **eraLastLengthChange**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Queries.ts:116](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L116)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
___
<a id="fees"></a>
## fees
▸ **fees**(): `Observable`<[RxFees](../modules/_types_d_.md#rxfees)>
*Defined in [Queries.ts:95](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L95)*
**Returns:** `Observable`<[RxFees](../modules/_types_d_.md#rxfees)>
___
<a id="isconnected"></a>
## isConnected
▸ **isConnected**(): `Observable`<`boolean`>
*Inherited from [ApiBase](_base_.apibase.md).[isConnected](_base_.apibase.md#isconnected)*
*Defined in [Base.ts:36](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Base.ts#L36)*
**Returns:** `Observable`<`boolean`>
___
<a id="rawcall"></a>
## rawCall
▸ **rawCall**<`T`>(__namedParameters: *`object`*, ...params: *`Array`<`any`>*): `Observable`<`T`>
*Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)*
*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Base.ts#L40)*
**Type parameters:**
#### T
**Parameters:**
| Param | Type |
| ------ | ------ |
| __namedParameters | `object` |
| `Rest` params | `Array`<`any`> |
**Returns:** `Observable`<`T`>
___
<a id="rawstorage"></a>
## rawStorage
▸ **rawStorage**<`T`>(key: *`StorageFunction`*, ...params: *`Array`<`any`>*): `Observable`<`T`>
*Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)*
*Defined in [Base.ts:52](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Base.ts#L52)*
**Type parameters:**
#### T
**Parameters:**
| Param | Type |
| ------ | ------ |
| key | `StorageFunction` |
| `Rest` params | `Array`<`any`> |
**Returns:** `Observable`<`T`>
___
<a id="rawstoragemulti"></a>
## rawStorageMulti
▸ **rawStorageMulti**<`T`>(...keys: *`Array`< [`StorageFunction`] &#124; [`StorageFunction`, `any`]>*): `Observable`<`T`>
*Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)*
*Defined in [Base.ts:63](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Base.ts#L63)*
**Type parameters:**
#### T
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Rest` keys | `Array`< [`StorageFunction`] &#124; [`StorageFunction`, `any`]> |
**Returns:** `Observable`<`T`>
___
<a id="sessioncurrentindex"></a>
## sessionCurrentIndex
▸ **sessionCurrentIndex**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Queries.ts:128](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L128)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
___
<a id="sessioncurrentstart"></a>
## sessionCurrentStart
▸ **sessionCurrentStart**(): `Observable`< `Moment` &#124; `undefined`>
*Defined in [Queries.ts:132](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L132)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
___
<a id="sessionlastlengthchange"></a>
## sessionLastLengthChange
▸ **sessionLastLengthChange**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Queries.ts:136](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L136)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
___
<a id="sessionlength"></a>
## sessionLength
▸ **sessionLength**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Queries.ts:140](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L140)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
___
<a id="sessionreward"></a>
## sessionReward
▸ **sessionReward**(): `Observable`< `Perbill` &#124; `undefined`>
*Defined in [Queries.ts:120](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L120)*
**Returns:** `Observable`< `Perbill` &#124; `undefined`>
___
<a id="sessionrewardcurrent"></a>
## sessionRewardCurrent
▸ **sessionRewardCurrent**(): `Observable`< `Balance` &#124; `undefined`>
*Defined in [Queries.ts:124](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L124)*
**Returns:** `Observable`< `Balance` &#124; `undefined`>
___
<a id="sessionvalidators"></a>
## sessionValidators
▸ **sessionValidators**(): `Observable`<`Array`<`AccountId`>>
*Defined in [Queries.ts:148](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L148)*
**Returns:** `Observable`<`Array`<`AccountId`>>
___
<a id="sessionsperera"></a>
## sessionsPerEra
▸ **sessionsPerEra**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Queries.ts:144](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L144)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
___
<a id="stakingfreebalanceof"></a>
## stakingFreeBalanceOf
▸ **stakingFreeBalanceOf**(address: * `AccountId` &#124; `string`*): `Observable`< `Balance` &#124; `undefined`>
*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L171)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| address | `AccountId` &#124; `string`|
**Returns:** `Observable`< `Balance` &#124; `undefined`>
___
<a id="stakingintentions"></a>
## stakingIntentions
▸ **stakingIntentions**(): `Observable`<`Array`<`AccountId`>>
*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L159)*
**Returns:** `Observable`<`Array`<`AccountId`>>
___
<a id="stakingnominating"></a>
## stakingNominating
▸ **stakingNominating**(address: * `AccountId` &#124; `string`*): `Observable`< `AccountId` &#124; `undefined`>
*Defined in [Queries.ts:186](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L186)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| address | `AccountId` &#124; `string`|
**Returns:** `Observable`< `AccountId` &#124; `undefined`>
___
<a id="stakingnominatorsfor"></a>
## stakingNominatorsFor
▸ **stakingNominatorsFor**(address: * `AccountId` &#124; `string`*): `Observable`<`Array`<`AccountId`>>
*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L175)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| address | `AccountId` &#124; `string`|
**Returns:** `Observable`<`Array`<`AccountId`>>
___
<a id="stakingreservedbalanceof"></a>
## stakingReservedBalanceOf
▸ **stakingReservedBalanceOf**(address: * `AccountId` &#124; `string`*): `Observable`< `Balance` &#124; `undefined`>
*Defined in [Queries.ts:191](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L191)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| address | `AccountId` &#124; `string`|
**Returns:** `Observable`< `Balance` &#124; `undefined`>
___
<a id="systemaccountindexof"></a>
## systemAccountIndexOf
▸ **systemAccountIndexOf**(address: * `AccountId` &#124; `string`*): `Observable`< `Index` &#124; `undefined`>
*Defined in [Queries.ts:203](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L203)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| address | `AccountId` &#124; `string`|
**Returns:** `Observable`< `Index` &#124; `undefined`>
___
<a id="timestampblockperiod"></a>
## timestampBlockPeriod
▸ **timestampBlockPeriod**(): `Observable`< `Moment` &#124; `undefined`>
*Defined in [Queries.ts:195](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L195)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
___
<a id="timestampnow"></a>
## timestampNow
▸ **timestampNow**(): `Observable`< `Moment` &#124; `undefined`>
*Defined in [Queries.ts:199](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L199)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
___
<a id="validatorcount"></a>
## validatorCount
▸ **validatorCount**(): `Observable`<`u32`>
*Defined in [Queries.ts:207](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/Queries.ts#L207)*
**Returns:** `Observable`<`u32`>
___
docs/api-observable/modules/_base_.md
+10
View File
@@ -0,0 +1,10 @@
# Index
### Classes
* [ApiBase](../classes/_base_.apibase.md)
---
docs/api-observable/modules/_calls_.md
+10
View File
@@ -0,0 +1,10 @@
# Index
### Classes
* [ApiCalls](../classes/_calls_.apicalls.md)
---
docs/api-observable/modules/_classes_.md
+12
View File
@@ -0,0 +1,12 @@
# Index
### Classes
* [RxProposal](../classes/_classes_.rxproposal.md)
* [RxProposalDeposits](../classes/_classes_.rxproposaldeposits.md)
* [RxReferendum](../classes/_classes_.rxreferendum.md)
---
docs/api-observable/modules/_combined_.md
+10
View File
@@ -0,0 +1,10 @@
# Index
### Classes
* [ApiCombined](../classes/_combined_.apicombined.md)
---
docs/api-observable/modules/_index_.md
+10
View File
@@ -0,0 +1,10 @@
# Index
### Classes
* [Api](../classes/_index_.api.md)
---
docs/api-observable/modules/_queries_.md
+10
View File
@@ -0,0 +1,10 @@
# Index
### Classes
* [ApiQueries](../classes/_queries_.apiqueries.md)
---
docs/api-observable/modules/_types_d_.md
+61
View File
@@ -0,0 +1,61 @@
# Type aliases
<a id="apifunctions"></a>
## ApiFunctions
**Ƭ ApiFunctions**: * `keyof ApiBase` &#124; `keyof ApiCalls` &#124; `keyof ApiCombined` &#124; `keyof ApiQueries`
*
*Defined in [types.d.ts:14](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/types.d.ts#L14)*
___
<a id="rxbalance"></a>
## RxBalance
**Ƭ RxBalance**: *`object`*
*Defined in [types.d.ts:16](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/types.d.ts#L16)*
#### Type declaration
___
<a id="rxbalancemap"></a>
## RxBalanceMap
**Ƭ RxBalanceMap**: *`object`*
*Defined in [types.d.ts:40](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/types.d.ts#L40)*
#### Type declaration
[index: `string`]: [RxBalance](_types_d_.md#rxbalance)
___
<a id="rxfees"></a>
## RxFees
**Ƭ RxFees**: *`object`*
*Defined in [types.d.ts:26](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/types.d.ts#L26)*
#### Type declaration
___
<a id="rxreferendumvote"></a>
## RxReferendumVote
**Ƭ RxReferendumVote**: *`object`*
*Defined in [types.d.ts:34](https://github.com/polkadot-js/api/blob/782bb80/packages/api-observable/src/types.d.ts#L34)*
#### Type declaration
___