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

[CI Skip] 0.33.2

Browse Source
This commit is contained in:
Travis CI
2018-12-06 11:17:30 +00:00
parent b52a86eab0
commit 477ad7e444
334 changed files with 360179 additions and 2024 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/GLOSSARY.html
+1529 -1
View File
File diff suppressed because it is too large Load Diff
docs/METHODS_EVENTS.html
+1529 -1
View File
File diff suppressed because it is too large Load Diff
docs/METHODS_EXTRINSICS.html
+1529 -1
View File
File diff suppressed because it is too large Load Diff
docs/METHODS_RPC.html
+1529 -1
View File
File diff suppressed because it is too large Load Diff
docs/METHODS_STORAGE.html
+1529 -1
View File
File diff suppressed because it is too large Load Diff
docs/api-observable/classes/_base_.apibase.md
+9 -9
View File
@@ -14,7 +14,7 @@
⊕ **new ApiBase**(api: *`RpcRxInterface`*): [ApiBase](_base_.apibase.md)
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Base.ts#L33)*
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Base.ts#L33)*
**Parameters:**
@@ -34,7 +34,7 @@ ___
**● whenReady**: *`Observable`<`boolean`>*
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Base.ts#L33)*
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Base.ts#L33)*
___
<a id="extrinsics"></a>
@@ -43,7 +43,7 @@ ___
**● extrinsics**: *`Extrinsics`* = extrinsicsStatic
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Base.ts#L41)*
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Base.ts#L41)*
___
<a id="storage"></a>
@@ -52,7 +52,7 @@ ___
**● storage**: *`Storage`* = storageStatic
*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Base.ts#L42)*
*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Base.ts#L42)*
___
@@ -64,7 +64,7 @@ ___
getgenesisHash(): `Hash`
*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Base.ts#L87)*
*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Base.ts#L87)*
**Returns:** `Hash`
@@ -78,7 +78,7 @@ ___
▸ **isConnected**(): `Observable`<`boolean`>
*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Base.ts#L91)*
*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Base.ts#L91)*
**Returns:** `Observable`<`boolean`>
@@ -89,7 +89,7 @@ ___
▸ **rawCall**<`T`>(__namedParameters: *`object`*, ...params: *`Array`<`any`>*): `Observable`<`T`>
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Base.ts#L95)*
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Base.ts#L95)*
**Type parameters:**
@@ -110,7 +110,7 @@ ___
▸ **rawStorage**<`T`>(key: * `Uint8Array` &#124; `StorageFunction`*, ...params: *`Array`<`any`>*): `Observable`< `T` &#124; `undefined`>
*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Base.ts#L108)*
*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Base.ts#L108)*
**Type parameters:**
@@ -131,7 +131,7 @@ ___
▸ **rawStorageMulti**<`T`>(...keys: *`Array`< `Uint8Array` &#124; [`StorageFunction`] &#124; [`StorageFunction`, `any`]>*): `Observable`<`T`>
*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Base.ts#L123)*
*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Base.ts#L123)*
**Type parameters:**
docs/api-observable/classes/_calls_.apicalls.md
+48 -48
View File
@@ -18,7 +18,7 @@
*Inherited from [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Base.ts#L33)*
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Base.ts#L33)*
**Parameters:**
@@ -40,7 +40,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[whenReady](_base_.apibase.md#whenready)*
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Base.ts#L33)*
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Base.ts#L33)*
___
<a id="extrinsics"></a>
@@ -51,7 +51,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[extrinsics](_base_.apibase.md#extrinsics)*
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Base.ts#L41)*
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Base.ts#L41)*
___
<a id="storage"></a>
@@ -62,7 +62,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[storage](_base_.apibase.md#storage)*
*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Base.ts#L42)*
*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Base.ts#L42)*
___
@@ -76,7 +76,7 @@ getgenesisHash(): `Hash`
*Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)*
*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Base.ts#L87)*
*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Base.ts#L87)*
**Returns:** `Hash`
@@ -92,7 +92,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[accountNonce](_queries_.apiqueries.md#accountnonce)*
*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L19)*
*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L19)*
**Parameters:**
@@ -111,7 +111,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceFree](_queries_.apiqueries.md#balancefree)*
*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L23)*
*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L23)*
**Parameters:**
@@ -130,7 +130,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceReserved](_queries_.apiqueries.md#balancereserved)*
*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L27)*
*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L27)*
**Parameters:**
@@ -147,7 +147,7 @@ ___
▸ **bestNumber**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Calls.ts#L13)*
*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Calls.ts#L13)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -160,7 +160,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[blockNow](_queries_.apiqueries.md#blocknow)*
*Defined in [Queries.ts:35](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L35)*
*Defined in [Queries.ts:35](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L35)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -173,7 +173,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[blockPeriod](_queries_.apiqueries.md#blockperiod)*
*Defined in [Queries.ts:31](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L31)*
*Defined in [Queries.ts:31](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L31)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -184,7 +184,7 @@ ___
▸ **chain**(): `Observable`< `Text` &#124; `undefined`>
*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Calls.ts#L25)*
*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Calls.ts#L25)*
**Returns:** `Observable`< `Text` &#124; `undefined`>
@@ -197,7 +197,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyLaunchPeriod](_queries_.apiqueries.md#democracylaunchperiod)*
*Defined in [Queries.ts:39](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L39)*
*Defined in [Queries.ts:39](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L39)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -210,7 +210,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyNextTally](_queries_.apiqueries.md#democracynexttally)*
*Defined in [Queries.ts:43](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L43)*
*Defined in [Queries.ts:43](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L43)*
**Returns:** `Observable`< `ReferendumIndex` &#124; `undefined`>
@@ -223,7 +223,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyVotingPeriod](_queries_.apiqueries.md#democracyvotingperiod)*
*Defined in [Queries.ts:126](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L126)*
*Defined in [Queries.ts:126](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L126)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -236,7 +236,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[eraLastLengthChange](_queries_.apiqueries.md#eralastlengthchange)*
*Defined in [Queries.ts:151](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L151)*
*Defined in [Queries.ts:151](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L151)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -249,7 +249,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[fees](_queries_.apiqueries.md#fees)*
*Defined in [Queries.ts:130](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L130)*
*Defined in [Queries.ts:130](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L130)*
**Returns:** `Observable`<[RxFees](../modules/_types_.md#rxfees)>
@@ -262,7 +262,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[getAccountEnumSet](_queries_.apiqueries.md#getaccountenumset)*
*Defined in [Queries.ts:47](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L47)*
*Defined in [Queries.ts:47](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L47)*
**Parameters:**
@@ -279,7 +279,7 @@ ___
▸ **getBlock**(hash: *`Uint8Array`*): `Observable`< `SignedBlock` &#124; `undefined`>
*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Calls.ts#L29)*
*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Calls.ts#L29)*
**Parameters:**
@@ -298,7 +298,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[isConnected](_base_.apibase.md#isconnected)*
*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Base.ts#L91)*
*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Base.ts#L91)*
**Returns:** `Observable`<`boolean`>
@@ -311,7 +311,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[nextAccountEnumSet](_queries_.apiqueries.md#nextaccountenumset)*
*Defined in [Queries.ts:58](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L58)*
*Defined in [Queries.ts:58](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L58)*
**Returns:** `Observable`< `AccountIndex` &#124; `undefined`>
@@ -324,7 +324,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[proposalDeposits](_queries_.apiqueries.md#proposaldeposits)*
*Defined in [Queries.ts:62](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L62)*
*Defined in [Queries.ts:62](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L62)*
**Parameters:**
@@ -343,7 +343,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[publicProposals](_queries_.apiqueries.md#publicproposals)*
*Defined in [Queries.ts:75](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L75)*
*Defined in [Queries.ts:75](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L75)*
**Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>>
@@ -356,7 +356,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)*
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Base.ts#L95)*
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Base.ts#L95)*
**Type parameters:**
@@ -379,7 +379,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)*
*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Base.ts#L108)*
*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Base.ts#L108)*
**Type parameters:**
@@ -402,7 +402,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)*
*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Base.ts#L123)*
*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Base.ts#L123)*
**Type parameters:**
@@ -424,7 +424,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumCount](_queries_.apiqueries.md#referendumcount)*
*Defined in [Queries.ts:94](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L94)*
*Defined in [Queries.ts:94](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L94)*
**Returns:** `Observable`< `ReferendumIndex` &#124; `undefined`>
@@ -437,7 +437,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumInfo](_queries_.apiqueries.md#referenduminfo)*
*Defined in [Queries.ts:98](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L98)*
*Defined in [Queries.ts:98](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L98)*
**Parameters:**
@@ -456,7 +456,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVote](_queries_.apiqueries.md#referendumvote)*
*Defined in [Queries.ts:111](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L111)*
*Defined in [Queries.ts:111](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L111)*
**Parameters:**
@@ -476,7 +476,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVoters](_queries_.apiqueries.md#referendumvoters)*
*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L115)*
*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L115)*
**Parameters:**
@@ -495,7 +495,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentIndex](_queries_.apiqueries.md#sessioncurrentindex)*
*Defined in [Queries.ts:163](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L163)*
*Defined in [Queries.ts:163](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L163)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -508,7 +508,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentStart](_queries_.apiqueries.md#sessioncurrentstart)*
*Defined in [Queries.ts:167](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L167)*
*Defined in [Queries.ts:167](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L167)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -521,7 +521,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLastLengthChange](_queries_.apiqueries.md#sessionlastlengthchange)*
*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L171)*
*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L171)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -534,7 +534,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLength](_queries_.apiqueries.md#sessionlength)*
*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L175)*
*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L175)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -547,7 +547,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionReward](_queries_.apiqueries.md#sessionreward)*
*Defined in [Queries.ts:155](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L155)*
*Defined in [Queries.ts:155](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L155)*
**Returns:** `Observable`< `Perbill` &#124; `undefined`>
@@ -560,7 +560,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionRewardCurrent](_queries_.apiqueries.md#sessionrewardcurrent)*
*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L159)*
*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L159)*
**Returns:** `Observable`< `Balance` &#124; `undefined`>
@@ -573,7 +573,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionValidators](_queries_.apiqueries.md#sessionvalidators)*
*Defined in [Queries.ts:183](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L183)*
*Defined in [Queries.ts:183](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L183)*
**Returns:** `Observable`<`Array`<`AccountId`>>
@@ -586,7 +586,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionsPerEra](_queries_.apiqueries.md#sessionsperera)*
*Defined in [Queries.ts:179](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L179)*
*Defined in [Queries.ts:179](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L179)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -599,7 +599,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingIntentions](_queries_.apiqueries.md#stakingintentions)*
*Defined in [Queries.ts:194](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L194)*
*Defined in [Queries.ts:194](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L194)*
**Returns:** `Observable`<`Array`<`AccountId`>>
@@ -612,7 +612,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominating](_queries_.apiqueries.md#stakingnominating)*
*Defined in [Queries.ts:216](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L216)*
*Defined in [Queries.ts:216](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L216)*
**Parameters:**
@@ -631,7 +631,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominatorsFor](_queries_.apiqueries.md#stakingnominatorsfor)*
*Defined in [Queries.ts:205](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L205)*
*Defined in [Queries.ts:205](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L205)*
**Parameters:**
@@ -648,7 +648,7 @@ ___
▸ **submitAndWatchExtrinsic**(extrinsic: *`Extrinsic`*): `Observable`< `ExtrinsicStatus` &#124; `undefined`>
*Defined in [Calls.ts:51](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Calls.ts#L51)*
*Defined in [Calls.ts:51](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Calls.ts#L51)*
**Parameters:**
@@ -665,7 +665,7 @@ ___
▸ **submitExtrinsic**(extrinsic: *`Extrinsic`*): `Observable`< `Hash` &#124; `undefined`>
*Defined in [Calls.ts:47](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Calls.ts#L47)*
*Defined in [Calls.ts:47](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Calls.ts#L47)*
**Parameters:**
@@ -682,7 +682,7 @@ ___
▸ **subscribeNewHead**(): `Observable`< `Header` &#124; `undefined`>
*Defined in [Calls.ts:33](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Calls.ts#L33)*
*Defined in [Calls.ts:33](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Calls.ts#L33)*
**Returns:** `Observable`< `Header` &#124; `undefined`>
@@ -695,7 +695,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[systemEvents](_queries_.apiqueries.md#systemevents)*
*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L220)*
*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L220)*
**Returns:** `Observable`<`Array`<`EventRecord`>>
@@ -706,7 +706,7 @@ ___
▸ **systemName**(): `Observable`< `Text` &#124; `undefined`>
*Defined in [Calls.ts:39](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Calls.ts#L39)*
*Defined in [Calls.ts:39](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Calls.ts#L39)*
**Returns:** `Observable`< `Text` &#124; `undefined`>
@@ -717,7 +717,7 @@ ___
▸ **systemVersion**(): `Observable`< `Text` &#124; `undefined`>
*Defined in [Calls.ts:43](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Calls.ts#L43)*
*Defined in [Calls.ts:43](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Calls.ts#L43)*
**Returns:** `Observable`< `Text` &#124; `undefined`>
@@ -730,7 +730,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[validatorCount](_queries_.apiqueries.md#validatorcount)*
*Defined in [Queries.ts:231](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L231)*
*Defined in [Queries.ts:231](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L231)*
**Returns:** `Observable`< `u32` &#124; `undefined`>
docs/api-observable/classes/_classes_.rxproposal.md
+14 -14
View File
@@ -25,7 +25,7 @@
*Overrides Struct.__constructor*
*Defined in [classes.ts:12](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/classes.ts#L12)*
*Defined in [classes.ts:12](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/classes.ts#L12)*
**Parameters:**
@@ -72,7 +72,7 @@ getType(): `E`
*Inherited from Struct.Type*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L133)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L133)*
*__description__*: Returns the Type description to sthe structure
@@ -85,7 +85,7 @@ ___
getaddress(): `AccountId`
*Defined in [classes.ts:21](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/classes.ts#L21)*
*Defined in [classes.ts:21](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/classes.ts#L21)*
**Returns:** `AccountId`
@@ -98,7 +98,7 @@ getencodedLength(): `number`
*Inherited from Struct.encodedLength*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L140)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L140)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -111,7 +111,7 @@ ___
getid(): `PropIndex`
*Defined in [classes.ts:25](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/classes.ts#L25)*
*Defined in [classes.ts:25](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/classes.ts#L25)*
**Returns:** `PropIndex`
@@ -122,7 +122,7 @@ ___
getproposal(): `Proposal`
*Defined in [classes.ts:29](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/classes.ts#L29)*
*Defined in [classes.ts:29](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/classes.ts#L29)*
**Returns:** `Proposal`
@@ -222,7 +222,7 @@ ___
*Overrides Map.get*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:150](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L150)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:150](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L150)*
*__description__*: Returns a specific names entry in the structure
@@ -243,7 +243,7 @@ ___
*Inherited from Struct.getAtIndex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:157](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L157)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:157](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L157)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
@@ -318,7 +318,7 @@ ___
*Inherited from Struct.toArray*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:164](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L164)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:164](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L164)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -333,7 +333,7 @@ ___
*Inherited from Struct.toHex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:171](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L171)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:171](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L171)*
*__description__*: Returns a hex string representation of the value
@@ -348,7 +348,7 @@ ___
*Inherited from Struct.toJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:178](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L178)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:178](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L178)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -363,7 +363,7 @@ ___
*Inherited from Struct.toString*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:192](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L192)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:192](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L192)*
*__description__*: Returns the string representation of the value
@@ -378,7 +378,7 @@ ___
*Inherited from Struct.toU8a*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:200](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L200)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:200](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L200)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -414,7 +414,7 @@ ___
*Inherited from Struct.with*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L113)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L113)*
**Type parameters:**
docs/api-observable/classes/_classes_.rxproposaldeposits.md
+13 -13
View File
@@ -25,7 +25,7 @@
*Overrides Struct.__constructor*
*Defined in [classes.ts:36](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/classes.ts#L36)*
*Defined in [classes.ts:36](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/classes.ts#L36)*
**Parameters:**
@@ -72,7 +72,7 @@ getType(): `E`
*Inherited from Struct.Type*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L133)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L133)*
*__description__*: Returns the Type description to sthe structure
@@ -85,7 +85,7 @@ ___
getaddresses(): `Vector`<`AccountId`>
*Defined in [classes.ts:44](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/classes.ts#L44)*
*Defined in [classes.ts:44](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/classes.ts#L44)*
**Returns:** `Vector`<`AccountId`>
@@ -96,7 +96,7 @@ ___
getbalance(): `Balance`
*Defined in [classes.ts:48](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/classes.ts#L48)*
*Defined in [classes.ts:48](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/classes.ts#L48)*
**Returns:** `Balance`
@@ -109,7 +109,7 @@ getencodedLength(): `number`
*Inherited from Struct.encodedLength*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L140)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L140)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -211,7 +211,7 @@ ___
*Overrides Map.get*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:150](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L150)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:150](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L150)*
*__description__*: Returns a specific names entry in the structure
@@ -232,7 +232,7 @@ ___
*Inherited from Struct.getAtIndex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:157](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L157)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:157](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L157)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
@@ -307,7 +307,7 @@ ___
*Inherited from Struct.toArray*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:164](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L164)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:164](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L164)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -322,7 +322,7 @@ ___
*Inherited from Struct.toHex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:171](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L171)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:171](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L171)*
*__description__*: Returns a hex string representation of the value
@@ -337,7 +337,7 @@ ___
*Inherited from Struct.toJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:178](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L178)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:178](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L178)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -352,7 +352,7 @@ ___
*Inherited from Struct.toString*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:192](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L192)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:192](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L192)*
*__description__*: Returns the string representation of the value
@@ -367,7 +367,7 @@ ___
*Inherited from Struct.toU8a*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:200](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L200)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:200](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L200)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -403,7 +403,7 @@ ___
*Inherited from Struct.with*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L113)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L113)*
**Type parameters:**
docs/api-observable/classes/_classes_.rxreferendum.md
+15 -15
View File
@@ -25,7 +25,7 @@
*Overrides Struct.__constructor*
*Defined in [classes.ts:55](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/classes.ts#L55)*
*Defined in [classes.ts:55](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/classes.ts#L55)*
**Parameters:**
@@ -73,7 +73,7 @@ getType(): `E`
*Inherited from Struct.Type*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L133)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L133)*
*__description__*: Returns the Type description to sthe structure
@@ -86,7 +86,7 @@ ___
getblockNumber(): `BlockNumber`
*Defined in [classes.ts:65](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/classes.ts#L65)*
*Defined in [classes.ts:65](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/classes.ts#L65)*
**Returns:** `BlockNumber`
@@ -99,7 +99,7 @@ getencodedLength(): `number`
*Inherited from Struct.encodedLength*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L140)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L140)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -112,7 +112,7 @@ ___
getid(): `ReferendumIndex`
*Defined in [classes.ts:69](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/classes.ts#L69)*
*Defined in [classes.ts:69](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/classes.ts#L69)*
**Returns:** `ReferendumIndex`
@@ -123,7 +123,7 @@ ___
getproposal(): `Proposal`
*Defined in [classes.ts:73](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/classes.ts#L73)*
*Defined in [classes.ts:73](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/classes.ts#L73)*
**Returns:** `Proposal`
@@ -134,7 +134,7 @@ ___
getvoteThreshold(): `VoteThreshold`
*Defined in [classes.ts:77](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/classes.ts#L77)*
*Defined in [classes.ts:77](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/classes.ts#L77)*
**Returns:** `VoteThreshold`
@@ -234,7 +234,7 @@ ___
*Overrides Map.get*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:150](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L150)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:150](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L150)*
*__description__*: Returns a specific names entry in the structure
@@ -255,7 +255,7 @@ ___
*Inherited from Struct.getAtIndex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:157](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L157)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:157](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L157)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
@@ -330,7 +330,7 @@ ___
*Inherited from Struct.toArray*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:164](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L164)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:164](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L164)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -345,7 +345,7 @@ ___
*Inherited from Struct.toHex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:171](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L171)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:171](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L171)*
*__description__*: Returns a hex string representation of the value
@@ -360,7 +360,7 @@ ___
*Inherited from Struct.toJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:178](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L178)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:178](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L178)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -375,7 +375,7 @@ ___
*Inherited from Struct.toString*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:192](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L192)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:192](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L192)*
*__description__*: Returns the string representation of the value
@@ -390,7 +390,7 @@ ___
*Inherited from Struct.toU8a*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:200](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L200)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:200](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L200)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -426,7 +426,7 @@ ___
*Inherited from Struct.with*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L113)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L113)*
**Type parameters:**
docs/api-observable/classes/_combined_.apicombined.md
+72 -72
View File
@@ -18,7 +18,7 @@
*Inherited from [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Base.ts#L33)*
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Base.ts#L33)*
**Parameters:**
@@ -40,7 +40,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[whenReady](_base_.apibase.md#whenready)*
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Base.ts#L33)*
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Base.ts#L33)*
___
<a id="extrinsics"></a>
@@ -51,7 +51,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[extrinsics](_base_.apibase.md#extrinsics)*
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Base.ts#L41)*
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Base.ts#L41)*
___
<a id="storage"></a>
@@ -62,7 +62,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[storage](_base_.apibase.md#storage)*
*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Base.ts#L42)*
*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Base.ts#L42)*
___
@@ -76,7 +76,7 @@ getgenesisHash(): `Hash`
*Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)*
*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Base.ts#L87)*
*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Base.ts#L87)*
**Returns:** `Hash`
@@ -90,7 +90,7 @@ ___
▸ **accountIdAndIndex**(address?: * `AccountId` &#124; `AccountIndex` &#124; `string` &#124; `null`*): `Observable`<[`AccountId` &#124; `undefined`, `AccountIndex` &#124; `undefined`]>
*Defined in [Combined.ts:79](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Combined.ts#L79)*
*Defined in [Combined.ts:79](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Combined.ts#L79)*
**Parameters:**
@@ -107,7 +107,7 @@ ___
▸ **accountIdFromIndex**(_accountIndex: * `AccountIndex` &#124; `string`*): `Observable`< `AccountId` &#124; `undefined`>
*Defined in [Combined.ts:53](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Combined.ts#L53)*
*Defined in [Combined.ts:53](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Combined.ts#L53)*
**Parameters:**
@@ -124,7 +124,7 @@ ___
▸ **accountIndexFromId**(accountId: * `AccountId` &#124; `string`*): `Observable`< `AccountIndex` &#124; `undefined`>
*Defined in [Combined.ts:68](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Combined.ts#L68)*
*Defined in [Combined.ts:68](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Combined.ts#L68)*
**Parameters:**
@@ -141,7 +141,7 @@ ___
▸ **accountIndexes**(): `Observable`<`object`>
*Defined in [Combined.ts:23](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Combined.ts#L23)*
*Defined in [Combined.ts:23](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Combined.ts#L23)*
**Returns:** `Observable`<`object`>
@@ -154,7 +154,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[accountNonce](_queries_.apiqueries.md#accountnonce)*
*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L19)*
*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L19)*
**Parameters:**
@@ -173,7 +173,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceFree](_queries_.apiqueries.md#balancefree)*
*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L23)*
*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L23)*
**Parameters:**
@@ -192,7 +192,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceReserved](_queries_.apiqueries.md#balancereserved)*
*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L27)*
*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L27)*
**Parameters:**
@@ -211,7 +211,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[bestNumber](_calls_.apicalls.md#bestnumber)*
*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Calls.ts#L13)*
*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Calls.ts#L13)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -224,7 +224,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[blockNow](_queries_.apiqueries.md#blocknow)*
*Defined in [Queries.ts:35](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L35)*
*Defined in [Queries.ts:35](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L35)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -237,7 +237,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[blockPeriod](_queries_.apiqueries.md#blockperiod)*
*Defined in [Queries.ts:31](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L31)*
*Defined in [Queries.ts:31](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L31)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -250,7 +250,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[chain](_calls_.apicalls.md#chain)*
*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Calls.ts#L25)*
*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Calls.ts#L25)*
**Returns:** `Observable`< `Text` &#124; `undefined`>
@@ -263,7 +263,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyLaunchPeriod](_queries_.apiqueries.md#democracylaunchperiod)*
*Defined in [Queries.ts:39](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L39)*
*Defined in [Queries.ts:39](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L39)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -276,7 +276,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyNextTally](_queries_.apiqueries.md#democracynexttally)*
*Defined in [Queries.ts:43](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L43)*
*Defined in [Queries.ts:43](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L43)*
**Returns:** `Observable`< `ReferendumIndex` &#124; `undefined`>
@@ -287,7 +287,7 @@ ___
▸ **democracyReferendumVoters**(referendumId: * `ReferendumIndex` &#124; `BN` &#124; `number`*): `Observable`<`Array`<[RxReferendumVote](../modules/_types_.md#rxreferendumvote)>>
*Defined in [Combined.ts:137](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Combined.ts#L137)*
*Defined in [Combined.ts:137](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Combined.ts#L137)*
**Parameters:**
@@ -304,7 +304,7 @@ ___
▸ **democracyVotersBalancesOf**(referendumId: * `ReferendumIndex` &#124; `BN` &#124; `number`*): `Observable`<`Array`<`Balance`>>
*Defined in [Combined.ts:182](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Combined.ts#L182)*
*Defined in [Combined.ts:182](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Combined.ts#L182)*
**Parameters:**
@@ -321,7 +321,7 @@ ___
▸ **democracyVotersVotesOf**(referendumId: * `ReferendumIndex` &#124; `BN` &#124; `number`*): `Observable`<`Array`<`Bool`>>
*Defined in [Combined.ts:198](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Combined.ts#L198)*
*Defined in [Combined.ts:198](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Combined.ts#L198)*
**Parameters:**
@@ -340,7 +340,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyVotingPeriod](_queries_.apiqueries.md#democracyvotingperiod)*
*Defined in [Queries.ts:126](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L126)*
*Defined in [Queries.ts:126](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L126)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -351,7 +351,7 @@ ___
▸ **eraBlockLength**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Combined.ts:209](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Combined.ts#L209)*
*Defined in [Combined.ts:209](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Combined.ts#L209)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -362,7 +362,7 @@ ___
▸ **eraBlockProgress**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Combined.ts:224](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Combined.ts#L224)*
*Defined in [Combined.ts:224](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Combined.ts#L224)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -373,7 +373,7 @@ ___
▸ **eraBlockRemaining**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Combined.ts:247](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Combined.ts#L247)*
*Defined in [Combined.ts:247](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Combined.ts#L247)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -386,7 +386,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[eraLastLengthChange](_queries_.apiqueries.md#eralastlengthchange)*
*Defined in [Queries.ts:151](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L151)*
*Defined in [Queries.ts:151](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L151)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -399,7 +399,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[fees](_queries_.apiqueries.md#fees)*
*Defined in [Queries.ts:130](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L130)*
*Defined in [Queries.ts:130](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L130)*
**Returns:** `Observable`<[RxFees](../modules/_types_.md#rxfees)>
@@ -412,7 +412,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[getAccountEnumSet](_queries_.apiqueries.md#getaccountenumset)*
*Defined in [Queries.ts:47](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L47)*
*Defined in [Queries.ts:47](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L47)*
**Parameters:**
@@ -431,7 +431,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[getBlock](_calls_.apicalls.md#getblock)*
*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Calls.ts#L29)*
*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Calls.ts#L29)*
**Parameters:**
@@ -450,7 +450,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[isConnected](_base_.apibase.md#isconnected)*
*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Base.ts#L91)*
*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Base.ts#L91)*
**Returns:** `Observable`<`boolean`>
@@ -463,7 +463,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[nextAccountEnumSet](_queries_.apiqueries.md#nextaccountenumset)*
*Defined in [Queries.ts:58](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L58)*
*Defined in [Queries.ts:58](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L58)*
**Returns:** `Observable`< `AccountIndex` &#124; `undefined`>
@@ -476,7 +476,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[proposalDeposits](_queries_.apiqueries.md#proposaldeposits)*
*Defined in [Queries.ts:62](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L62)*
*Defined in [Queries.ts:62](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L62)*
**Parameters:**
@@ -493,7 +493,7 @@ ___
▸ **publicProposalCount**(): `Observable`<`number`>
*Defined in [Combined.ts:115](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Combined.ts#L115)*
*Defined in [Combined.ts:115](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Combined.ts#L115)*
**Returns:** `Observable`<`number`>
@@ -506,7 +506,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[publicProposals](_queries_.apiqueries.md#publicproposals)*
*Defined in [Queries.ts:75](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L75)*
*Defined in [Queries.ts:75](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L75)*
**Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>>
@@ -519,7 +519,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)*
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Base.ts#L95)*
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Base.ts#L95)*
**Type parameters:**
@@ -542,7 +542,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)*
*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Base.ts#L108)*
*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Base.ts#L108)*
**Type parameters:**
@@ -565,7 +565,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)*
*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Base.ts#L123)*
*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Base.ts#L123)*
**Type parameters:**
@@ -587,7 +587,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumCount](_queries_.apiqueries.md#referendumcount)*
*Defined in [Queries.ts:94](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L94)*
*Defined in [Queries.ts:94](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L94)*
**Returns:** `Observable`< `ReferendumIndex` &#124; `undefined`>
@@ -600,7 +600,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumInfo](_queries_.apiqueries.md#referenduminfo)*
*Defined in [Queries.ts:98](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L98)*
*Defined in [Queries.ts:98](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L98)*
**Parameters:**
@@ -619,7 +619,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVote](_queries_.apiqueries.md#referendumvote)*
*Defined in [Queries.ts:111](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L111)*
*Defined in [Queries.ts:111](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L111)*
**Parameters:**
@@ -639,7 +639,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVoters](_queries_.apiqueries.md#referendumvoters)*
*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L115)*
*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L115)*
**Parameters:**
@@ -656,7 +656,7 @@ ___
▸ **referendumVotes**(index: * `ReferendumIndex` &#124; `BN` &#124; `number`*, addresses: *`Array`< `AccountId` &#124; `string`>*): `Observable`<`boolean`>
*Defined in [Combined.ts:174](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Combined.ts#L174)*
*Defined in [Combined.ts:174](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Combined.ts#L174)*
**Parameters:**
@@ -674,7 +674,7 @@ ___
▸ **referendums**(): `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>>
*Defined in [Combined.ts:153](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Combined.ts#L153)*
*Defined in [Combined.ts:153](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Combined.ts#L153)*
**Returns:** `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>>
@@ -685,7 +685,7 @@ ___
▸ **referendumsInfo**(referendumIds: *`Array`< `ReferendumIndex` &#124; `BN` &#124; `number`>*): `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>>
*Defined in [Combined.ts:125](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Combined.ts#L125)*
*Defined in [Combined.ts:125](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Combined.ts#L125)*
**Parameters:**
@@ -702,7 +702,7 @@ ___
▸ **sessionBlockProgress**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Combined.ts:262](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Combined.ts#L262)*
*Defined in [Combined.ts:262](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Combined.ts#L262)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -713,7 +713,7 @@ ___
▸ **sessionBlockRemaining**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Combined.ts:282](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Combined.ts#L282)*
*Defined in [Combined.ts:282](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Combined.ts#L282)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -724,7 +724,7 @@ ___
▸ **sessionBrokenValue**(): `Observable`< `Moment` &#124; `undefined`>
*Defined in [Combined.ts:297](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Combined.ts#L297)*
*Defined in [Combined.ts:297](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Combined.ts#L297)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -737,7 +737,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentIndex](_queries_.apiqueries.md#sessioncurrentindex)*
*Defined in [Queries.ts:163](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L163)*
*Defined in [Queries.ts:163](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L163)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -750,7 +750,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentStart](_queries_.apiqueries.md#sessioncurrentstart)*
*Defined in [Queries.ts:167](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L167)*
*Defined in [Queries.ts:167](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L167)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -763,7 +763,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLastLengthChange](_queries_.apiqueries.md#sessionlastlengthchange)*
*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L171)*
*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L171)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -776,7 +776,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLength](_queries_.apiqueries.md#sessionlength)*
*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L175)*
*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L175)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -789,7 +789,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionReward](_queries_.apiqueries.md#sessionreward)*
*Defined in [Queries.ts:155](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L155)*
*Defined in [Queries.ts:155](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L155)*
**Returns:** `Observable`< `Perbill` &#124; `undefined`>
@@ -802,7 +802,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionRewardCurrent](_queries_.apiqueries.md#sessionrewardcurrent)*
*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L159)*
*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L159)*
**Returns:** `Observable`< `Balance` &#124; `undefined`>
@@ -813,7 +813,7 @@ ___
▸ **sessionTimeExpected**(): `Observable`< `Moment` &#124; `undefined`>
*Defined in [Combined.ts:316](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Combined.ts#L316)*
*Defined in [Combined.ts:316](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Combined.ts#L316)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -824,7 +824,7 @@ ___
▸ **sessionTimeRemaining**(): `Observable`< `Moment` &#124; `undefined`>
*Defined in [Combined.ts:331](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Combined.ts#L331)*
*Defined in [Combined.ts:331](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Combined.ts#L331)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -837,7 +837,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionValidators](_queries_.apiqueries.md#sessionvalidators)*
*Defined in [Queries.ts:183](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L183)*
*Defined in [Queries.ts:183](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L183)*
**Returns:** `Observable`<`Array`<`AccountId`>>
@@ -850,7 +850,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionsPerEra](_queries_.apiqueries.md#sessionsperera)*
*Defined in [Queries.ts:179](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L179)*
*Defined in [Queries.ts:179](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L179)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -863,7 +863,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingIntentions](_queries_.apiqueries.md#stakingintentions)*
*Defined in [Queries.ts:194](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L194)*
*Defined in [Queries.ts:194](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L194)*
**Returns:** `Observable`<`Array`<`AccountId`>>
@@ -876,7 +876,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominating](_queries_.apiqueries.md#stakingnominating)*
*Defined in [Queries.ts:216](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L216)*
*Defined in [Queries.ts:216](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L216)*
**Parameters:**
@@ -895,7 +895,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominatorsFor](_queries_.apiqueries.md#stakingnominatorsfor)*
*Defined in [Queries.ts:205](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L205)*
*Defined in [Queries.ts:205](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L205)*
**Parameters:**
@@ -914,7 +914,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[submitAndWatchExtrinsic](_calls_.apicalls.md#submitandwatchextrinsic)*
*Defined in [Calls.ts:51](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Calls.ts#L51)*
*Defined in [Calls.ts:51](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Calls.ts#L51)*
**Parameters:**
@@ -933,7 +933,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[submitExtrinsic](_calls_.apicalls.md#submitextrinsic)*
*Defined in [Calls.ts:47](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Calls.ts#L47)*
*Defined in [Calls.ts:47](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Calls.ts#L47)*
**Parameters:**
@@ -952,7 +952,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[subscribeNewHead](_calls_.apicalls.md#subscribenewhead)*
*Defined in [Calls.ts:33](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Calls.ts#L33)*
*Defined in [Calls.ts:33](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Calls.ts#L33)*
**Returns:** `Observable`< `Header` &#124; `undefined`>
@@ -965,7 +965,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[systemEvents](_queries_.apiqueries.md#systemevents)*
*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L220)*
*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L220)*
**Returns:** `Observable`<`Array`<`EventRecord`>>
@@ -978,7 +978,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[systemName](_calls_.apicalls.md#systemname)*
*Defined in [Calls.ts:39](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Calls.ts#L39)*
*Defined in [Calls.ts:39](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Calls.ts#L39)*
**Returns:** `Observable`< `Text` &#124; `undefined`>
@@ -991,7 +991,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[systemVersion](_calls_.apicalls.md#systemversion)*
*Defined in [Calls.ts:43](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Calls.ts#L43)*
*Defined in [Calls.ts:43](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Calls.ts#L43)*
**Returns:** `Observable`< `Text` &#124; `undefined`>
@@ -1002,7 +1002,7 @@ ___
▸ **validatingBalance**(address: * `AccountId` &#124; `string`*): `Observable`<[RxBalance](../modules/_types_.md#rxbalance)>
*Defined in [Combined.ts:346](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Combined.ts#L346)*
*Defined in [Combined.ts:346](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Combined.ts#L346)*
**Parameters:**
@@ -1019,7 +1019,7 @@ ___
▸ **validatingBalances**(...addresses: *`Array`< `AccountId` &#124; `string`>*): `Observable`<[RxBalanceMap](../modules/_types_.md#rxbalancemap)>
*Defined in [Combined.ts:371](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Combined.ts#L371)*
*Defined in [Combined.ts:371](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Combined.ts#L371)*
**Parameters:**
@@ -1038,7 +1038,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[validatorCount](_queries_.apiqueries.md#validatorcount)*
*Defined in [Queries.ts:231](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L231)*
*Defined in [Queries.ts:231](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L231)*
**Returns:** `Observable`< `u32` &#124; `undefined`>
@@ -1049,7 +1049,7 @@ ___
▸ **votingBalance**(address: * `AccountIndex` &#124; `AccountId` &#124; `string`*): `Observable`<[RxBalance](../modules/_types_.md#rxbalance)>
*Defined in [Combined.ts:385](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Combined.ts#L385)*
*Defined in [Combined.ts:385](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Combined.ts#L385)*
**Parameters:**
@@ -1066,7 +1066,7 @@ ___
▸ **votingBalances**(...addresses: *`Array`< `AccountId` &#124; `string`>*): `Observable`<[RxBalance](../modules/_types_.md#rxbalance)[]>
*Defined in [Combined.ts:425](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Combined.ts#L425)*
*Defined in [Combined.ts:425](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Combined.ts#L425)*
**Parameters:**
@@ -1083,7 +1083,7 @@ ___
▸ **votingBalancesNominatorsFor**(address: * `AccountId` &#124; `string`*): `Observable`<`any`>
*Defined in [Combined.ts:414](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Combined.ts#L414)*
*Defined in [Combined.ts:414](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Combined.ts#L414)*
**Parameters:**
docs/api-observable/classes/_index_.api.md
+72 -72
View File
@@ -16,7 +16,7 @@
*Inherited from [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Base.ts#L33)*
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Base.ts#L33)*
**Parameters:**
@@ -38,7 +38,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[whenReady](_base_.apibase.md#whenready)*
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Base.ts#L33)*
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Base.ts#L33)*
___
<a id="extrinsics"></a>
@@ -49,7 +49,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[extrinsics](_base_.apibase.md#extrinsics)*
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Base.ts#L41)*
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Base.ts#L41)*
___
<a id="storage"></a>
@@ -60,7 +60,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[storage](_base_.apibase.md#storage)*
*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Base.ts#L42)*
*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Base.ts#L42)*
___
@@ -74,7 +74,7 @@ getgenesisHash(): `Hash`
*Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)*
*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Base.ts#L87)*
*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Base.ts#L87)*
**Returns:** `Hash`
@@ -90,7 +90,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[accountIdAndIndex](_combined_.apicombined.md#accountidandindex)*
*Defined in [Combined.ts:79](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Combined.ts#L79)*
*Defined in [Combined.ts:79](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Combined.ts#L79)*
**Parameters:**
@@ -109,7 +109,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[accountIdFromIndex](_combined_.apicombined.md#accountidfromindex)*
*Defined in [Combined.ts:53](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Combined.ts#L53)*
*Defined in [Combined.ts:53](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Combined.ts#L53)*
**Parameters:**
@@ -128,7 +128,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[accountIndexFromId](_combined_.apicombined.md#accountindexfromid)*
*Defined in [Combined.ts:68](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Combined.ts#L68)*
*Defined in [Combined.ts:68](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Combined.ts#L68)*
**Parameters:**
@@ -147,7 +147,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[accountIndexes](_combined_.apicombined.md#accountindexes)*
*Defined in [Combined.ts:23](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Combined.ts#L23)*
*Defined in [Combined.ts:23](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Combined.ts#L23)*
**Returns:** `Observable`<`object`>
@@ -160,7 +160,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[accountNonce](_queries_.apiqueries.md#accountnonce)*
*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L19)*
*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L19)*
**Parameters:**
@@ -179,7 +179,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceFree](_queries_.apiqueries.md#balancefree)*
*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L23)*
*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L23)*
**Parameters:**
@@ -198,7 +198,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceReserved](_queries_.apiqueries.md#balancereserved)*
*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L27)*
*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L27)*
**Parameters:**
@@ -217,7 +217,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[bestNumber](_calls_.apicalls.md#bestnumber)*
*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Calls.ts#L13)*
*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Calls.ts#L13)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -230,7 +230,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[blockNow](_queries_.apiqueries.md#blocknow)*
*Defined in [Queries.ts:35](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L35)*
*Defined in [Queries.ts:35](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L35)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -243,7 +243,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[blockPeriod](_queries_.apiqueries.md#blockperiod)*
*Defined in [Queries.ts:31](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L31)*
*Defined in [Queries.ts:31](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L31)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -256,7 +256,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[chain](_calls_.apicalls.md#chain)*
*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Calls.ts#L25)*
*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Calls.ts#L25)*
**Returns:** `Observable`< `Text` &#124; `undefined`>
@@ -269,7 +269,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyLaunchPeriod](_queries_.apiqueries.md#democracylaunchperiod)*
*Defined in [Queries.ts:39](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L39)*
*Defined in [Queries.ts:39](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L39)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -282,7 +282,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyNextTally](_queries_.apiqueries.md#democracynexttally)*
*Defined in [Queries.ts:43](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L43)*
*Defined in [Queries.ts:43](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L43)*
**Returns:** `Observable`< `ReferendumIndex` &#124; `undefined`>
@@ -295,7 +295,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[democracyReferendumVoters](_combined_.apicombined.md#democracyreferendumvoters)*
*Defined in [Combined.ts:137](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Combined.ts#L137)*
*Defined in [Combined.ts:137](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Combined.ts#L137)*
**Parameters:**
@@ -314,7 +314,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[democracyVotersBalancesOf](_combined_.apicombined.md#democracyvotersbalancesof)*
*Defined in [Combined.ts:182](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Combined.ts#L182)*
*Defined in [Combined.ts:182](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Combined.ts#L182)*
**Parameters:**
@@ -333,7 +333,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[democracyVotersVotesOf](_combined_.apicombined.md#democracyvotersvotesof)*
*Defined in [Combined.ts:198](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Combined.ts#L198)*
*Defined in [Combined.ts:198](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Combined.ts#L198)*
**Parameters:**
@@ -352,7 +352,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyVotingPeriod](_queries_.apiqueries.md#democracyvotingperiod)*
*Defined in [Queries.ts:126](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L126)*
*Defined in [Queries.ts:126](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L126)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -365,7 +365,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[eraBlockLength](_combined_.apicombined.md#erablocklength)*
*Defined in [Combined.ts:209](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Combined.ts#L209)*
*Defined in [Combined.ts:209](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Combined.ts#L209)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -378,7 +378,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[eraBlockProgress](_combined_.apicombined.md#erablockprogress)*
*Defined in [Combined.ts:224](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Combined.ts#L224)*
*Defined in [Combined.ts:224](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Combined.ts#L224)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -391,7 +391,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[eraBlockRemaining](_combined_.apicombined.md#erablockremaining)*
*Defined in [Combined.ts:247](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Combined.ts#L247)*
*Defined in [Combined.ts:247](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Combined.ts#L247)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -404,7 +404,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[eraLastLengthChange](_queries_.apiqueries.md#eralastlengthchange)*
*Defined in [Queries.ts:151](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L151)*
*Defined in [Queries.ts:151](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L151)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -417,7 +417,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[fees](_queries_.apiqueries.md#fees)*
*Defined in [Queries.ts:130](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L130)*
*Defined in [Queries.ts:130](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L130)*
**Returns:** `Observable`<[RxFees](../modules/_types_.md#rxfees)>
@@ -430,7 +430,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[getAccountEnumSet](_queries_.apiqueries.md#getaccountenumset)*
*Defined in [Queries.ts:47](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L47)*
*Defined in [Queries.ts:47](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L47)*
**Parameters:**
@@ -449,7 +449,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[getBlock](_calls_.apicalls.md#getblock)*
*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Calls.ts#L29)*
*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Calls.ts#L29)*
**Parameters:**
@@ -468,7 +468,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[isConnected](_base_.apibase.md#isconnected)*
*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Base.ts#L91)*
*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Base.ts#L91)*
**Returns:** `Observable`<`boolean`>
@@ -481,7 +481,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[nextAccountEnumSet](_queries_.apiqueries.md#nextaccountenumset)*
*Defined in [Queries.ts:58](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L58)*
*Defined in [Queries.ts:58](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L58)*
**Returns:** `Observable`< `AccountIndex` &#124; `undefined`>
@@ -494,7 +494,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[proposalDeposits](_queries_.apiqueries.md#proposaldeposits)*
*Defined in [Queries.ts:62](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L62)*
*Defined in [Queries.ts:62](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L62)*
**Parameters:**
@@ -513,7 +513,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[publicProposalCount](_combined_.apicombined.md#publicproposalcount)*
*Defined in [Combined.ts:115](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Combined.ts#L115)*
*Defined in [Combined.ts:115](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Combined.ts#L115)*
**Returns:** `Observable`<`number`>
@@ -526,7 +526,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[publicProposals](_queries_.apiqueries.md#publicproposals)*
*Defined in [Queries.ts:75](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L75)*
*Defined in [Queries.ts:75](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L75)*
**Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>>
@@ -539,7 +539,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)*
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Base.ts#L95)*
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Base.ts#L95)*
**Type parameters:**
@@ -562,7 +562,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)*
*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Base.ts#L108)*
*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Base.ts#L108)*
**Type parameters:**
@@ -585,7 +585,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)*
*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Base.ts#L123)*
*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Base.ts#L123)*
**Type parameters:**
@@ -607,7 +607,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumCount](_queries_.apiqueries.md#referendumcount)*
*Defined in [Queries.ts:94](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L94)*
*Defined in [Queries.ts:94](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L94)*
**Returns:** `Observable`< `ReferendumIndex` &#124; `undefined`>
@@ -620,7 +620,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumInfo](_queries_.apiqueries.md#referenduminfo)*
*Defined in [Queries.ts:98](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L98)*
*Defined in [Queries.ts:98](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L98)*
**Parameters:**
@@ -639,7 +639,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVote](_queries_.apiqueries.md#referendumvote)*
*Defined in [Queries.ts:111](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L111)*
*Defined in [Queries.ts:111](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L111)*
**Parameters:**
@@ -659,7 +659,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVoters](_queries_.apiqueries.md#referendumvoters)*
*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L115)*
*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L115)*
**Parameters:**
@@ -678,7 +678,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[referendumVotes](_combined_.apicombined.md#referendumvotes)*
*Defined in [Combined.ts:174](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Combined.ts#L174)*
*Defined in [Combined.ts:174](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Combined.ts#L174)*
**Parameters:**
@@ -698,7 +698,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[referendums](_combined_.apicombined.md#referendums)*
*Defined in [Combined.ts:153](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Combined.ts#L153)*
*Defined in [Combined.ts:153](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Combined.ts#L153)*
**Returns:** `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>>
@@ -711,7 +711,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[referendumsInfo](_combined_.apicombined.md#referendumsinfo)*
*Defined in [Combined.ts:125](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Combined.ts#L125)*
*Defined in [Combined.ts:125](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Combined.ts#L125)*
**Parameters:**
@@ -730,7 +730,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[sessionBlockProgress](_combined_.apicombined.md#sessionblockprogress)*
*Defined in [Combined.ts:262](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Combined.ts#L262)*
*Defined in [Combined.ts:262](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Combined.ts#L262)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -743,7 +743,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[sessionBlockRemaining](_combined_.apicombined.md#sessionblockremaining)*
*Defined in [Combined.ts:282](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Combined.ts#L282)*
*Defined in [Combined.ts:282](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Combined.ts#L282)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -756,7 +756,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[sessionBrokenValue](_combined_.apicombined.md#sessionbrokenvalue)*
*Defined in [Combined.ts:297](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Combined.ts#L297)*
*Defined in [Combined.ts:297](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Combined.ts#L297)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -769,7 +769,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentIndex](_queries_.apiqueries.md#sessioncurrentindex)*
*Defined in [Queries.ts:163](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L163)*
*Defined in [Queries.ts:163](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L163)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -782,7 +782,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentStart](_queries_.apiqueries.md#sessioncurrentstart)*
*Defined in [Queries.ts:167](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L167)*
*Defined in [Queries.ts:167](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L167)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -795,7 +795,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLastLengthChange](_queries_.apiqueries.md#sessionlastlengthchange)*
*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L171)*
*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L171)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -808,7 +808,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLength](_queries_.apiqueries.md#sessionlength)*
*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L175)*
*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L175)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -821,7 +821,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionReward](_queries_.apiqueries.md#sessionreward)*
*Defined in [Queries.ts:155](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L155)*
*Defined in [Queries.ts:155](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L155)*
**Returns:** `Observable`< `Perbill` &#124; `undefined`>
@@ -834,7 +834,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionRewardCurrent](_queries_.apiqueries.md#sessionrewardcurrent)*
*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L159)*
*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L159)*
**Returns:** `Observable`< `Balance` &#124; `undefined`>
@@ -847,7 +847,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[sessionTimeExpected](_combined_.apicombined.md#sessiontimeexpected)*
*Defined in [Combined.ts:316](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Combined.ts#L316)*
*Defined in [Combined.ts:316](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Combined.ts#L316)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -860,7 +860,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[sessionTimeRemaining](_combined_.apicombined.md#sessiontimeremaining)*
*Defined in [Combined.ts:331](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Combined.ts#L331)*
*Defined in [Combined.ts:331](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Combined.ts#L331)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -873,7 +873,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionValidators](_queries_.apiqueries.md#sessionvalidators)*
*Defined in [Queries.ts:183](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L183)*
*Defined in [Queries.ts:183](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L183)*
**Returns:** `Observable`<`Array`<`AccountId`>>
@@ -886,7 +886,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionsPerEra](_queries_.apiqueries.md#sessionsperera)*
*Defined in [Queries.ts:179](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L179)*
*Defined in [Queries.ts:179](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L179)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -899,7 +899,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingIntentions](_queries_.apiqueries.md#stakingintentions)*
*Defined in [Queries.ts:194](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L194)*
*Defined in [Queries.ts:194](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L194)*
**Returns:** `Observable`<`Array`<`AccountId`>>
@@ -912,7 +912,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominating](_queries_.apiqueries.md#stakingnominating)*
*Defined in [Queries.ts:216](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L216)*
*Defined in [Queries.ts:216](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L216)*
**Parameters:**
@@ -931,7 +931,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominatorsFor](_queries_.apiqueries.md#stakingnominatorsfor)*
*Defined in [Queries.ts:205](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L205)*
*Defined in [Queries.ts:205](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L205)*
**Parameters:**
@@ -950,7 +950,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[submitAndWatchExtrinsic](_calls_.apicalls.md#submitandwatchextrinsic)*
*Defined in [Calls.ts:51](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Calls.ts#L51)*
*Defined in [Calls.ts:51](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Calls.ts#L51)*
**Parameters:**
@@ -969,7 +969,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[submitExtrinsic](_calls_.apicalls.md#submitextrinsic)*
*Defined in [Calls.ts:47](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Calls.ts#L47)*
*Defined in [Calls.ts:47](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Calls.ts#L47)*
**Parameters:**
@@ -988,7 +988,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[subscribeNewHead](_calls_.apicalls.md#subscribenewhead)*
*Defined in [Calls.ts:33](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Calls.ts#L33)*
*Defined in [Calls.ts:33](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Calls.ts#L33)*
**Returns:** `Observable`< `Header` &#124; `undefined`>
@@ -1001,7 +1001,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[systemEvents](_queries_.apiqueries.md#systemevents)*
*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L220)*
*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L220)*
**Returns:** `Observable`<`Array`<`EventRecord`>>
@@ -1014,7 +1014,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[systemName](_calls_.apicalls.md#systemname)*
*Defined in [Calls.ts:39](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Calls.ts#L39)*
*Defined in [Calls.ts:39](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Calls.ts#L39)*
**Returns:** `Observable`< `Text` &#124; `undefined`>
@@ -1027,7 +1027,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[systemVersion](_calls_.apicalls.md#systemversion)*
*Defined in [Calls.ts:43](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Calls.ts#L43)*
*Defined in [Calls.ts:43](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Calls.ts#L43)*
**Returns:** `Observable`< `Text` &#124; `undefined`>
@@ -1040,7 +1040,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[validatingBalance](_combined_.apicombined.md#validatingbalance)*
*Defined in [Combined.ts:346](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Combined.ts#L346)*
*Defined in [Combined.ts:346](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Combined.ts#L346)*
**Parameters:**
@@ -1059,7 +1059,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[validatingBalances](_combined_.apicombined.md#validatingbalances)*
*Defined in [Combined.ts:371](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Combined.ts#L371)*
*Defined in [Combined.ts:371](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Combined.ts#L371)*
**Parameters:**
@@ -1078,7 +1078,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[validatorCount](_queries_.apiqueries.md#validatorcount)*
*Defined in [Queries.ts:231](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L231)*
*Defined in [Queries.ts:231](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L231)*
**Returns:** `Observable`< `u32` &#124; `undefined`>
@@ -1091,7 +1091,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[votingBalance](_combined_.apicombined.md#votingbalance)*
*Defined in [Combined.ts:385](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Combined.ts#L385)*
*Defined in [Combined.ts:385](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Combined.ts#L385)*
**Parameters:**
@@ -1110,7 +1110,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[votingBalances](_combined_.apicombined.md#votingbalances)*
*Defined in [Combined.ts:425](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Combined.ts#L425)*
*Defined in [Combined.ts:425](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Combined.ts#L425)*
**Parameters:**
@@ -1129,7 +1129,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[votingBalancesNominatorsFor](_combined_.apicombined.md#votingbalancesnominatorsfor)*
*Defined in [Combined.ts:414](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Combined.ts#L414)*
*Defined in [Combined.ts:414](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Combined.ts#L414)*
**Parameters:**
docs/api-observable/classes/_queries_.apiqueries.md
+40 -40
View File
@@ -18,7 +18,7 @@
*Inherited from [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Base.ts#L33)*
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Base.ts#L33)*
**Parameters:**
@@ -40,7 +40,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[whenReady](_base_.apibase.md#whenready)*
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Base.ts#L33)*
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Base.ts#L33)*
___
<a id="extrinsics"></a>
@@ -51,7 +51,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[extrinsics](_base_.apibase.md#extrinsics)*
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Base.ts#L41)*
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Base.ts#L41)*
___
<a id="storage"></a>
@@ -62,7 +62,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[storage](_base_.apibase.md#storage)*
*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Base.ts#L42)*
*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Base.ts#L42)*
___
@@ -76,7 +76,7 @@ getgenesisHash(): `Hash`
*Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)*
*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Base.ts#L87)*
*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Base.ts#L87)*
**Returns:** `Hash`
@@ -90,7 +90,7 @@ ___
▸ **accountNonce**(address: * `AccountId` &#124; `string`*): `Observable`< `Index` &#124; `undefined`>
*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L19)*
*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L19)*
**Parameters:**
@@ -107,7 +107,7 @@ ___
▸ **balanceFree**(address: * `AccountId` &#124; `string`*): `Observable`< `Balance` &#124; `undefined`>
*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L23)*
*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L23)*
**Parameters:**
@@ -124,7 +124,7 @@ ___
▸ **balanceReserved**(address: * `AccountId` &#124; `string`*): `Observable`< `Balance` &#124; `undefined`>
*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L27)*
*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L27)*
**Parameters:**
@@ -141,7 +141,7 @@ ___
▸ **blockNow**(): `Observable`< `Moment` &#124; `undefined`>
*Defined in [Queries.ts:35](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L35)*
*Defined in [Queries.ts:35](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L35)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -152,7 +152,7 @@ ___
▸ **blockPeriod**(): `Observable`< `Moment` &#124; `undefined`>
*Defined in [Queries.ts:31](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L31)*
*Defined in [Queries.ts:31](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L31)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -163,7 +163,7 @@ ___
▸ **democracyLaunchPeriod**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Queries.ts:39](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L39)*
*Defined in [Queries.ts:39](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L39)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -174,7 +174,7 @@ ___
▸ **democracyNextTally**(): `Observable`< `ReferendumIndex` &#124; `undefined`>
*Defined in [Queries.ts:43](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L43)*
*Defined in [Queries.ts:43](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L43)*
**Returns:** `Observable`< `ReferendumIndex` &#124; `undefined`>
@@ -185,7 +185,7 @@ ___
▸ **democracyVotingPeriod**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Queries.ts:126](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L126)*
*Defined in [Queries.ts:126](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L126)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -196,7 +196,7 @@ ___
▸ **eraLastLengthChange**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Queries.ts:151](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L151)*
*Defined in [Queries.ts:151](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L151)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -207,7 +207,7 @@ ___
▸ **fees**(): `Observable`<[RxFees](../modules/_types_.md#rxfees)>
*Defined in [Queries.ts:130](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L130)*
*Defined in [Queries.ts:130](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L130)*
**Returns:** `Observable`<[RxFees](../modules/_types_.md#rxfees)>
@@ -218,7 +218,7 @@ ___
▸ **getAccountEnumSet**(index: * `AccountIndex` &#124; `BN` &#124; `number`*): `Observable`< `Array`<`AccountId`> &#124; `undefined`>
*Defined in [Queries.ts:47](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L47)*
*Defined in [Queries.ts:47](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L47)*
**Parameters:**
@@ -237,7 +237,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[isConnected](_base_.apibase.md#isconnected)*
*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Base.ts#L91)*
*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Base.ts#L91)*
**Returns:** `Observable`<`boolean`>
@@ -248,7 +248,7 @@ ___
▸ **nextAccountEnumSet**(): `Observable`< `AccountIndex` &#124; `undefined`>
*Defined in [Queries.ts:58](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L58)*
*Defined in [Queries.ts:58](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L58)*
**Returns:** `Observable`< `AccountIndex` &#124; `undefined`>
@@ -259,7 +259,7 @@ ___
▸ **proposalDeposits**(proposalId: * `PropIndex` &#124; `BN` &#124; `number`*): `Observable`< [RxProposalDeposits](_classes_.rxproposaldeposits.md) &#124; `undefined`>
*Defined in [Queries.ts:62](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L62)*
*Defined in [Queries.ts:62](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L62)*
**Parameters:**
@@ -276,7 +276,7 @@ ___
▸ **publicProposals**(): `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>>
*Defined in [Queries.ts:75](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L75)*
*Defined in [Queries.ts:75](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L75)*
**Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>>
@@ -289,7 +289,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)*
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Base.ts#L95)*
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Base.ts#L95)*
**Type parameters:**
@@ -312,7 +312,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)*
*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Base.ts#L108)*
*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Base.ts#L108)*
**Type parameters:**
@@ -335,7 +335,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)*
*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Base.ts#L123)*
*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Base.ts#L123)*
**Type parameters:**
@@ -355,7 +355,7 @@ ___
▸ **referendumCount**(): `Observable`< `ReferendumIndex` &#124; `undefined`>
*Defined in [Queries.ts:94](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L94)*
*Defined in [Queries.ts:94](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L94)*
**Returns:** `Observable`< `ReferendumIndex` &#124; `undefined`>
@@ -366,7 +366,7 @@ ___
▸ **referendumInfo**(referendumId: * `ReferendumIndex` &#124; `BN` &#124; `number`*): `Observable`< [RxReferendum](_classes_.rxreferendum.md) &#124; `undefined`>
*Defined in [Queries.ts:98](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L98)*
*Defined in [Queries.ts:98](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L98)*
**Parameters:**
@@ -383,7 +383,7 @@ ___
▸ **referendumVote**(index: * `ReferendumIndex` &#124; `BN` &#124; `number`*, address: * `AccountId` &#124; `string`*): `Observable`< `Bool` &#124; `undefined`>
*Defined in [Queries.ts:111](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L111)*
*Defined in [Queries.ts:111](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L111)*
**Parameters:**
@@ -401,7 +401,7 @@ ___
▸ **referendumVoters**(index: * `ReferendumIndex` &#124; `BN` &#124; `number`*): `Observable`<`Array`<`AccountId`>>
*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L115)*
*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L115)*
**Parameters:**
@@ -418,7 +418,7 @@ ___
▸ **sessionCurrentIndex**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Queries.ts:163](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L163)*
*Defined in [Queries.ts:163](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L163)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -429,7 +429,7 @@ ___
▸ **sessionCurrentStart**(): `Observable`< `Moment` &#124; `undefined`>
*Defined in [Queries.ts:167](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L167)*
*Defined in [Queries.ts:167](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L167)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -440,7 +440,7 @@ ___
▸ **sessionLastLengthChange**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L171)*
*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L171)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -451,7 +451,7 @@ ___
▸ **sessionLength**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L175)*
*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L175)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -462,7 +462,7 @@ ___
▸ **sessionReward**(): `Observable`< `Perbill` &#124; `undefined`>
*Defined in [Queries.ts:155](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L155)*
*Defined in [Queries.ts:155](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L155)*
**Returns:** `Observable`< `Perbill` &#124; `undefined`>
@@ -473,7 +473,7 @@ ___
▸ **sessionRewardCurrent**(): `Observable`< `Balance` &#124; `undefined`>
*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L159)*
*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L159)*
**Returns:** `Observable`< `Balance` &#124; `undefined`>
@@ -484,7 +484,7 @@ ___
▸ **sessionValidators**(): `Observable`<`Array`<`AccountId`>>
*Defined in [Queries.ts:183](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L183)*
*Defined in [Queries.ts:183](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L183)*
**Returns:** `Observable`<`Array`<`AccountId`>>
@@ -495,7 +495,7 @@ ___
▸ **sessionsPerEra**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Queries.ts:179](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L179)*
*Defined in [Queries.ts:179](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L179)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -506,7 +506,7 @@ ___
▸ **stakingIntentions**(): `Observable`<`Array`<`AccountId`>>
*Defined in [Queries.ts:194](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L194)*
*Defined in [Queries.ts:194](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L194)*
**Returns:** `Observable`<`Array`<`AccountId`>>
@@ -517,7 +517,7 @@ ___
▸ **stakingNominating**(address: * `AccountId` &#124; `string`*): `Observable`< `AccountId` &#124; `undefined`>
*Defined in [Queries.ts:216](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L216)*
*Defined in [Queries.ts:216](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L216)*
**Parameters:**
@@ -534,7 +534,7 @@ ___
▸ **stakingNominatorsFor**(address: * `AccountId` &#124; `string`*): `Observable`<`Array`<`AccountId`>>
*Defined in [Queries.ts:205](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L205)*
*Defined in [Queries.ts:205](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L205)*
**Parameters:**
@@ -551,7 +551,7 @@ ___
▸ **systemEvents**(): `Observable`<`Array`<`EventRecord`>>
*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L220)*
*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L220)*
**Returns:** `Observable`<`Array`<`EventRecord`>>
@@ -562,7 +562,7 @@ ___
▸ **validatorCount**(): `Observable`< `u32` &#124; `undefined`>
*Defined in [Queries.ts:231](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/Queries.ts#L231)*
*Defined in [Queries.ts:231](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/Queries.ts#L231)*
**Returns:** `Observable`< `u32` &#124; `undefined`>
docs/api-observable/modules/_types_.md
+5 -5
View File
@@ -9,7 +9,7 @@
**Ƭ ApiFunctions**: * `keyof ApiBase` &#124; `keyof ApiCalls` &#124; `keyof ApiCombined` &#124; `keyof ApiQueries`
*
*Defined in [types.ts:12](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/types.ts#L12)*
*Defined in [types.ts:12](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/types.ts#L12)*
___
<a id="rxbalance"></a>
@@ -18,7 +18,7 @@ ___
**Ƭ RxBalance**: *`object`*
*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/types.ts#L14)*
*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/types.ts#L14)*
#### Type declaration
@@ -29,7 +29,7 @@ ___
**Ƭ RxBalanceMap**: *`object`*
*Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/types.ts#L38)*
*Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/types.ts#L38)*
#### Type declaration
@@ -42,7 +42,7 @@ ___
**Ƭ RxFees**: *`object`*
*Defined in [types.ts:24](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/types.ts#L24)*
*Defined in [types.ts:24](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/types.ts#L24)*
#### Type declaration
@@ -53,7 +53,7 @@ ___
**Ƭ RxReferendumVote**: *`object`*
*Defined in [types.ts:32](https://github.com/polkadot-js/api/blob/69b05c7/packages/api-observable/src/types.ts#L32)*
*Defined in [types.ts:32](https://github.com/polkadot-js/api/blob/b52a86e/packages/api-observable/src/types.ts#L32)*
#### Type declaration
docs/api/classes/_base_.apibase.md
+9 -9
View File
@@ -24,7 +24,7 @@
⊕ **new ApiBase**(provider?: * [ApiOptions](../interfaces/_types_.apioptions.md) &#124; `ProviderInterface`*): [ApiBase](_base_.apibase.md)
*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/Base.ts#L40)*
*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/Base.ts#L40)*
*__description__*: Create an instance of the class
@@ -58,7 +58,7 @@ ___
getgenesisHash(): `Hash`
*Defined in [Base.ts:79](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/Base.ts#L79)*
*Defined in [Base.ts:79](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/Base.ts#L79)*
*__description__*: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions.
@@ -71,7 +71,7 @@ ___
gethasSubscriptions(): `boolean`
*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/Base.ts#L88)*
*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/Base.ts#L88)*
*__description__*: `true` when subscriptions are supported
@@ -84,7 +84,7 @@ ___
getquery(): `S`
*Defined in [Base.ts:124](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/Base.ts#L124)*
*Defined in [Base.ts:124](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/Base.ts#L124)*
*__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.
@@ -107,7 +107,7 @@ ___
getrpc(): `R`
*Defined in [Base.ts:144](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/Base.ts#L144)*
*Defined in [Base.ts:144](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/Base.ts#L144)*
*__description__*: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic `api.query` and `api.tx` sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime.
@@ -130,7 +130,7 @@ ___
getruntimeMetadata(): `RuntimeMetadata`
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/Base.ts#L95)*
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/Base.ts#L95)*
*__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.
@@ -143,7 +143,7 @@ ___
getruntimeVersion(): `RuntimeVersion`
*Defined in [Base.ts:104](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/Base.ts#L104)*
*Defined in [Base.ts:104](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/Base.ts#L104)*
*__description__*: Contains the version information for the current runtime.
@@ -156,7 +156,7 @@ ___
gettx(): `E`
*Defined in [Base.ts:163](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/Base.ts#L163)*
*Defined in [Base.ts:163](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/Base.ts#L163)*
*__description__*: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata.
@@ -183,7 +183,7 @@ ___
▸ **on**(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `void`
*Defined in [Base.ts:188](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/Base.ts#L188)*
*Defined in [Base.ts:188](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/Base.ts#L188)*
*__description__*: Attach an eventemitter handler to listen to a specific event
docs/api/classes/_promise_combinator_.combinator.md
+1 -1
View File
@@ -12,7 +12,7 @@
⊕ **new Combinator**(fns: *`Array`<[CombinatorFunction](../modules/_promise_combinator_.md#combinatorfunction)>*, callback: *[CombinatorCallback](../modules/_promise_combinator_.md#combinatorcallback)*): [Combinator](_promise_combinator_.combinator.md)
*Defined in [promise/Combinator.ts:14](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/promise/Combinator.ts#L14)*
*Defined in [promise/Combinator.ts:14](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/promise/Combinator.ts#L14)*
**Parameters:**
docs/api/classes/_promise_index_.apipromise.html
+1541 -13
View File
File diff suppressed because it is too large Load Diff
docs/api/classes/_promise_index_.apipromise.md
+12 -12
View File
@@ -106,7 +106,7 @@ ApiPromise.create().then((api) => {
*Overrides [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
*Defined in [promise/index.ts:132](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/promise/index.ts#L132)*
*Defined in [promise/index.ts:132](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/promise/index.ts#L132)*
*__description__*: Creates an instance of the ApiPromise class
@@ -142,7 +142,7 @@ getgenesisHash(): `Hash`
*Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)*
*Defined in [Base.ts:79](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/Base.ts#L79)*
*Defined in [Base.ts:79](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/Base.ts#L79)*
*__description__*: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions.
@@ -157,7 +157,7 @@ gethasSubscriptions(): `boolean`
*Inherited from [ApiBase](_base_.apibase.md).[hasSubscriptions](_base_.apibase.md#hassubscriptions)*
*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/Base.ts#L88)*
*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/Base.ts#L88)*
*__description__*: `true` when subscriptions are supported
@@ -170,7 +170,7 @@ ___
getisReady(): `Promise`<[ApiPromise](_promise_index_.apipromise.md)>
*Defined in [promise/index.ts:167](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/promise/index.ts#L167)*
*Defined in [promise/index.ts:167](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/promise/index.ts#L167)*
*__description__*: Promise that returns the first time we are connected and loaded
@@ -185,7 +185,7 @@ getquery(): [QueryableStorage](../interfaces/_promise_types_.queryablestorage.md
*Inherited from [ApiBase](_base_.apibase.md).[query](_base_.apibase.md#query)*
*Defined in [Base.ts:124](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/Base.ts#L124)*
*Defined in [Base.ts:124](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/Base.ts#L124)*
*__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.
@@ -210,7 +210,7 @@ getrpc(): `Rpc`
*Inherited from [ApiBase](_base_.apibase.md).[rpc](_base_.apibase.md#rpc)*
*Defined in [Base.ts:144](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/Base.ts#L144)*
*Defined in [Base.ts:144](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/Base.ts#L144)*
*__description__*: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic `api.query` and `api.tx` sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime.
@@ -235,7 +235,7 @@ getruntimeMetadata(): `RuntimeMetadata`
*Inherited from [ApiBase](_base_.apibase.md).[runtimeMetadata](_base_.apibase.md#runtimemetadata)*
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/Base.ts#L95)*
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/Base.ts#L95)*
*__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.
@@ -250,7 +250,7 @@ getruntimeVersion(): `RuntimeVersion`
*Inherited from [ApiBase](_base_.apibase.md).[runtimeVersion](_base_.apibase.md#runtimeversion)*
*Defined in [Base.ts:104](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/Base.ts#L104)*
*Defined in [Base.ts:104](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/Base.ts#L104)*
*__description__*: Contains the version information for the current runtime.
@@ -265,7 +265,7 @@ gettx(): [SubmittableExtrinsics](../interfaces/_promise_types_.submittableextrin
*Inherited from [ApiBase](_base_.apibase.md).[tx](_base_.apibase.md#tx)*
*Defined in [Base.ts:163](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/Base.ts#L163)*
*Defined in [Base.ts:163](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/Base.ts#L163)*
*__description__*: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata.
@@ -292,7 +292,7 @@ ___
▸ **combineLatest**(fns: *`Array`<[CombinatorFunction](../modules/_promise_combinator_.md#combinatorfunction)>*, callback: *[CombinatorCallback](../modules/_promise_combinator_.md#combinatorcallback)*): [Combinator](_promise_combinator_.combinator.md)
*Defined in [promise/index.ts:195](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/promise/index.ts#L195)*
*Defined in [promise/index.ts:195](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/promise/index.ts#L195)*
*__description__*: Creates a combinator that can be used to combine the latest results from multiple subscriptions
@@ -329,7 +329,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[on](_base_.apibase.md#on)*
*Defined in [Base.ts:188](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/Base.ts#L188)*
*Defined in [Base.ts:188](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/Base.ts#L188)*
*__description__*: Attach an eventemitter handler to listen to a specific event
@@ -361,7 +361,7 @@ ___
▸ **create**(options?: * [ApiOptions](../interfaces/_types_.apioptions.md) &#124; `ProviderInterface`*): `Promise`<[ApiPromise](_promise_index_.apipromise.md)>
*Defined in [promise/index.ts:130](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/promise/index.ts#L130)*
*Defined in [promise/index.ts:130](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/promise/index.ts#L130)*
*__description__*: Creates an ApiPromise instance using the supplied provider. Returns an Promise containing the actual Api instance.
docs/api/classes/_promise_submittableextrinsic_.submittableextrinsic.md
+24 -24
View File
@@ -25,7 +25,7 @@
*Overrides Extrinsic.__constructor*
*Defined in [promise/SubmittableExtrinsic.ts:12](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/promise/SubmittableExtrinsic.ts#L12)*
*Defined in [promise/SubmittableExtrinsic.ts:12](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/promise/SubmittableExtrinsic.ts#L12)*
**Parameters:**
@@ -73,7 +73,7 @@ getType(): `E`
*Inherited from Struct.Type*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L133)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L133)*
*__description__*: Returns the Type description to sthe structure
@@ -88,7 +88,7 @@ getargs(): `Array`<`Codec`>
*Inherited from Extrinsic.args*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:69](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Extrinsic.ts#L69)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:69](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Extrinsic.ts#L69)*
*__description__*: The arguments passed to for the call, exposes args so it is compatible with \[\[Method\]\]
@@ -103,7 +103,7 @@ getcallIndex(): `Uint8Array`
*Inherited from Extrinsic.callIndex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:76](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Extrinsic.ts#L76)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:76](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Extrinsic.ts#L76)*
*__description__*: The actual `[sectionIndex, methodIndex]` as used in the Method
@@ -118,7 +118,7 @@ getdata(): `Uint8Array`
*Inherited from Extrinsic.data*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:83](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Extrinsic.ts#L83)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:83](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Extrinsic.ts#L83)*
*__description__*: The actual data for the Method
@@ -135,7 +135,7 @@ getencodedLength(): `number`
*Overrides Struct.encodedLength*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:90](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Extrinsic.ts#L90)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:90](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Extrinsic.ts#L90)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -150,7 +150,7 @@ gethash(): `Hash`
*Inherited from Extrinsic.hash*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:99](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Extrinsic.ts#L99)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:99](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Extrinsic.ts#L99)*
*__description__*: Convernience function, encodes the extrinsic and returns the actual hash
@@ -165,7 +165,7 @@ getisSigned(): `boolean`
*Inherited from Extrinsic.isSigned*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:108](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Extrinsic.ts#L108)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:108](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Extrinsic.ts#L108)*
*__description__*: `true` id the extrinsic is signed
@@ -180,7 +180,7 @@ getlength(): `number`
*Inherited from Extrinsic.length*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:115](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Extrinsic.ts#L115)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:115](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Extrinsic.ts#L115)*
*__description__*: The length of the encoded value
@@ -195,7 +195,7 @@ getmeta(): `FunctionMetadata`
*Inherited from Extrinsic.meta*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:122](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Extrinsic.ts#L122)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:122](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Extrinsic.ts#L122)*
*__description__*: The \[\[FunctionMetadata\]\] that describes the extrinsic
@@ -210,7 +210,7 @@ getmethod(): `Method`
*Inherited from Extrinsic.method*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:129](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Extrinsic.ts#L129)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:129](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Extrinsic.ts#L129)*
*__description__*: The \[\[Method\]\] this extrinsic wraps
@@ -225,7 +225,7 @@ getsignature(): `ExtrinsicSignature`
*Inherited from Extrinsic.signature*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:136](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Extrinsic.ts#L136)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:136](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Extrinsic.ts#L136)*
*__description__*: The \[\[ExtrinsicSignature\]\]
@@ -258,7 +258,7 @@ ___
*Inherited from Extrinsic.addSignature*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:143](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Extrinsic.ts#L143)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:143](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Extrinsic.ts#L143)*
*__description__*: Add an \[\[ExtrinsicSignature\]\] to the extrinsic (already generated)
@@ -351,7 +351,7 @@ ___
*Overrides Map.get*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:150](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L150)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:150](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L150)*
*__description__*: Returns a specific names entry in the structure
@@ -372,7 +372,7 @@ ___
*Inherited from Struct.getAtIndex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:157](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L157)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:157](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L157)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
@@ -425,7 +425,7 @@ ___
▸ **send**(statusCb?: * `undefined` &#124; `function`*): `Promise`<`Hash`>
*Defined in [promise/SubmittableExtrinsic.ts:20](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/promise/SubmittableExtrinsic.ts#L20)*
*Defined in [promise/SubmittableExtrinsic.ts:20](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/promise/SubmittableExtrinsic.ts#L20)*
**Parameters:**
@@ -464,7 +464,7 @@ ___
*Overrides Extrinsic.sign*
*Defined in [promise/SubmittableExtrinsic.ts:28](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/promise/SubmittableExtrinsic.ts#L28)*
*Defined in [promise/SubmittableExtrinsic.ts:28](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/promise/SubmittableExtrinsic.ts#L28)*
**Parameters:**
@@ -485,7 +485,7 @@ ___
*Inherited from Struct.toArray*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:164](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L164)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:164](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L164)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -502,7 +502,7 @@ ___
*Overrides Struct.toHex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:161](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Extrinsic.ts#L161)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:161](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Extrinsic.ts#L161)*
*__description__*: Returns a hex string representation of the value
@@ -519,7 +519,7 @@ ___
*Overrides Struct.toJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:168](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Extrinsic.ts#L168)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:168](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Extrinsic.ts#L168)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -534,7 +534,7 @@ ___
*Inherited from Struct.toString*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:192](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L192)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:192](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L192)*
*__description__*: Returns the string representation of the value
@@ -551,7 +551,7 @@ ___
*Overrides Struct.toU8a*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:176](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Extrinsic.ts#L176)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:176](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Extrinsic.ts#L176)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -587,7 +587,7 @@ ___
*Inherited from Extrinsic.decodeExtrinsic*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:44](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Extrinsic.ts#L44)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:44](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Extrinsic.ts#L44)*
**Parameters:**
@@ -606,7 +606,7 @@ ___
*Inherited from Struct.with*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L113)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L113)*
**Type parameters:**
docs/api/classes/_rx_index_.apirx.html
+1541 -13
View File
File diff suppressed because it is too large Load Diff
docs/api/classes/_rx_index_.apirx.md
+12 -12
View File
@@ -117,7 +117,7 @@ api.query.system
*Overrides [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
*Defined in [rx/index.ts:144](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/rx/index.ts#L144)*
*Defined in [rx/index.ts:144](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/rx/index.ts#L144)*
*__description__*: Create an instance of the ApiRx class
@@ -153,7 +153,7 @@ getgenesisHash(): `Hash`
*Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)*
*Defined in [Base.ts:79](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/Base.ts#L79)*
*Defined in [Base.ts:79](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/Base.ts#L79)*
*__description__*: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions.
@@ -168,7 +168,7 @@ gethasSubscriptions(): `boolean`
*Inherited from [ApiBase](_base_.apibase.md).[hasSubscriptions](_base_.apibase.md#hassubscriptions)*
*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/Base.ts#L88)*
*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/Base.ts#L88)*
*__description__*: `true` when subscriptions are supported
@@ -181,7 +181,7 @@ ___
getisConnected(): `Observable`<`boolean`>
*Defined in [rx/index.ts:182](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/rx/index.ts#L182)*
*Defined in [rx/index.ts:182](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/rx/index.ts#L182)*
*__description__*: Observable that carries the connected state for the provider. Results in a boolean flag that is true/false based on the connectivity.
@@ -194,7 +194,7 @@ ___
getisReady(): `Observable`<[ApiRx](_rx_index_.apirx.md)>
*Defined in [rx/index.ts:189](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/rx/index.ts#L189)*
*Defined in [rx/index.ts:189](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/rx/index.ts#L189)*
*__description__*: Observable that returns the first time we are connected and loaded
@@ -209,7 +209,7 @@ getquery(): [QueryableStorage](../interfaces/_rx_types_.queryablestorage.md)
*Inherited from [ApiBase](_base_.apibase.md).[query](_base_.apibase.md#query)*
*Defined in [Base.ts:124](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/Base.ts#L124)*
*Defined in [Base.ts:124](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/Base.ts#L124)*
*__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.
@@ -234,7 +234,7 @@ getrpc(): `RpcRx`
*Inherited from [ApiBase](_base_.apibase.md).[rpc](_base_.apibase.md#rpc)*
*Defined in [Base.ts:144](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/Base.ts#L144)*
*Defined in [Base.ts:144](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/Base.ts#L144)*
*__description__*: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic `api.query` and `api.tx` sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime.
@@ -259,7 +259,7 @@ getruntimeMetadata(): `RuntimeMetadata`
*Inherited from [ApiBase](_base_.apibase.md).[runtimeMetadata](_base_.apibase.md#runtimemetadata)*
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/Base.ts#L95)*
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/Base.ts#L95)*
*__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.
@@ -274,7 +274,7 @@ getruntimeVersion(): `RuntimeVersion`
*Inherited from [ApiBase](_base_.apibase.md).[runtimeVersion](_base_.apibase.md#runtimeversion)*
*Defined in [Base.ts:104](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/Base.ts#L104)*
*Defined in [Base.ts:104](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/Base.ts#L104)*
*__description__*: Contains the version information for the current runtime.
@@ -289,7 +289,7 @@ gettx(): [SubmittableExtrinsics](../interfaces/_rx_types_.submittableextrinsics.
*Inherited from [ApiBase](_base_.apibase.md).[tx](_base_.apibase.md#tx)*
*Defined in [Base.ts:163](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/Base.ts#L163)*
*Defined in [Base.ts:163](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/Base.ts#L163)*
*__description__*: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata.
@@ -318,7 +318,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[on](_base_.apibase.md#on)*
*Defined in [Base.ts:188](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/Base.ts#L188)*
*Defined in [Base.ts:188](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/Base.ts#L188)*
*__description__*: Attach an eventemitter handler to listen to a specific event
@@ -350,7 +350,7 @@ ___
▸ **create**(options?: * [ApiOptions](../interfaces/_types_.apioptions.md) &#124; `ProviderInterface`*): `Observable`<[ApiRx](_rx_index_.apirx.md)>
*Defined in [rx/index.ts:142](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/rx/index.ts#L142)*
*Defined in [rx/index.ts:142](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/rx/index.ts#L142)*
*__description__*: Creates an ApiRx instance using the supplied provider. Returns an Observable containing the actual Api instance.
docs/api/classes/_rx_submittableextrinsic_.submittableextrinsic.md
+24 -24
View File
@@ -25,7 +25,7 @@
*Overrides Extrinsic.__constructor*
*Defined in [rx/SubmittableExtrinsic.ts:13](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/rx/SubmittableExtrinsic.ts#L13)*
*Defined in [rx/SubmittableExtrinsic.ts:13](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/rx/SubmittableExtrinsic.ts#L13)*
**Parameters:**
@@ -73,7 +73,7 @@ getType(): `E`
*Inherited from Struct.Type*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L133)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L133)*
*__description__*: Returns the Type description to sthe structure
@@ -88,7 +88,7 @@ getargs(): `Array`<`Codec`>
*Inherited from Extrinsic.args*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:69](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Extrinsic.ts#L69)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:69](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Extrinsic.ts#L69)*
*__description__*: The arguments passed to for the call, exposes args so it is compatible with \[\[Method\]\]
@@ -103,7 +103,7 @@ getcallIndex(): `Uint8Array`
*Inherited from Extrinsic.callIndex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:76](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Extrinsic.ts#L76)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:76](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Extrinsic.ts#L76)*
*__description__*: The actual `[sectionIndex, methodIndex]` as used in the Method
@@ -118,7 +118,7 @@ getdata(): `Uint8Array`
*Inherited from Extrinsic.data*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:83](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Extrinsic.ts#L83)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:83](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Extrinsic.ts#L83)*
*__description__*: The actual data for the Method
@@ -135,7 +135,7 @@ getencodedLength(): `number`
*Overrides Struct.encodedLength*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:90](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Extrinsic.ts#L90)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:90](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Extrinsic.ts#L90)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -150,7 +150,7 @@ gethash(): `Hash`
*Inherited from Extrinsic.hash*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:99](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Extrinsic.ts#L99)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:99](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Extrinsic.ts#L99)*
*__description__*: Convernience function, encodes the extrinsic and returns the actual hash
@@ -165,7 +165,7 @@ getisSigned(): `boolean`
*Inherited from Extrinsic.isSigned*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:108](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Extrinsic.ts#L108)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:108](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Extrinsic.ts#L108)*
*__description__*: `true` id the extrinsic is signed
@@ -180,7 +180,7 @@ getlength(): `number`
*Inherited from Extrinsic.length*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:115](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Extrinsic.ts#L115)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:115](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Extrinsic.ts#L115)*
*__description__*: The length of the encoded value
@@ -195,7 +195,7 @@ getmeta(): `FunctionMetadata`
*Inherited from Extrinsic.meta*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:122](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Extrinsic.ts#L122)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:122](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Extrinsic.ts#L122)*
*__description__*: The \[\[FunctionMetadata\]\] that describes the extrinsic
@@ -210,7 +210,7 @@ getmethod(): `Method`
*Inherited from Extrinsic.method*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:129](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Extrinsic.ts#L129)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:129](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Extrinsic.ts#L129)*
*__description__*: The \[\[Method\]\] this extrinsic wraps
@@ -225,7 +225,7 @@ getsignature(): `ExtrinsicSignature`
*Inherited from Extrinsic.signature*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:136](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Extrinsic.ts#L136)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:136](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Extrinsic.ts#L136)*
*__description__*: The \[\[ExtrinsicSignature\]\]
@@ -258,7 +258,7 @@ ___
*Inherited from Extrinsic.addSignature*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:143](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Extrinsic.ts#L143)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:143](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Extrinsic.ts#L143)*
*__description__*: Add an \[\[ExtrinsicSignature\]\] to the extrinsic (already generated)
@@ -351,7 +351,7 @@ ___
*Overrides Map.get*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:150](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L150)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:150](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L150)*
*__description__*: Returns a specific names entry in the structure
@@ -372,7 +372,7 @@ ___
*Inherited from Struct.getAtIndex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:157](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L157)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:157](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L157)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
@@ -425,7 +425,7 @@ ___
▸ **send**(): `Observable`<`ExtrinsicStatus`>
*Defined in [rx/SubmittableExtrinsic.ts:21](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/rx/SubmittableExtrinsic.ts#L21)*
*Defined in [rx/SubmittableExtrinsic.ts:21](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/rx/SubmittableExtrinsic.ts#L21)*
**Returns:** `Observable`<`ExtrinsicStatus`>
@@ -458,7 +458,7 @@ ___
*Overrides Extrinsic.sign*
*Defined in [rx/SubmittableExtrinsic.ts:25](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/rx/SubmittableExtrinsic.ts#L25)*
*Defined in [rx/SubmittableExtrinsic.ts:25](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/rx/SubmittableExtrinsic.ts#L25)*
**Parameters:**
@@ -479,7 +479,7 @@ ___
*Inherited from Struct.toArray*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:164](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L164)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:164](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L164)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -496,7 +496,7 @@ ___
*Overrides Struct.toHex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:161](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Extrinsic.ts#L161)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:161](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Extrinsic.ts#L161)*
*__description__*: Returns a hex string representation of the value
@@ -513,7 +513,7 @@ ___
*Overrides Struct.toJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:168](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Extrinsic.ts#L168)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:168](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Extrinsic.ts#L168)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -528,7 +528,7 @@ ___
*Inherited from Struct.toString*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:192](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L192)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:192](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L192)*
*__description__*: Returns the string representation of the value
@@ -545,7 +545,7 @@ ___
*Overrides Struct.toU8a*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:176](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Extrinsic.ts#L176)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:176](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Extrinsic.ts#L176)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -581,7 +581,7 @@ ___
*Inherited from Extrinsic.decodeExtrinsic*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:44](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Extrinsic.ts#L44)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:44](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Extrinsic.ts#L44)*
**Parameters:**
@@ -600,7 +600,7 @@ ___
*Inherited from Struct.with*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L113)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L113)*
**Type parameters:**
docs/api/index.html
+1529 -1
View File
File diff suppressed because it is too large Load Diff
docs/api/interfaces/_promise_types_.apipromiseinterface.md
+9 -9
View File
@@ -20,7 +20,7 @@
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[genesisHash](_types_.apibaseinterface.md#genesishash)*
*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/types.ts#L13)*
*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/types.ts#L13)*
___
<a id="hassubscriptions"></a>
@@ -31,7 +31,7 @@ ___
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[hasSubscriptions](_types_.apibaseinterface.md#hassubscriptions)*
*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/types.ts#L14)*
*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/types.ts#L14)*
___
<a id="isready"></a>
@@ -40,7 +40,7 @@ ___
**● isReady**: *`Promise`<[ApiPromiseInterface](_promise_types_.apipromiseinterface.md)>*
*Defined in [promise/types.ts:39](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/promise/types.ts#L39)*
*Defined in [promise/types.ts:39](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/promise/types.ts#L39)*
___
<a id="on"></a>
@@ -51,7 +51,7 @@ ___
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[on](_types_.apibaseinterface.md#on)*
*Defined in [types.ts:21](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/types.ts#L21)*
*Defined in [types.ts:21](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/types.ts#L21)*
#### Type declaration
▸(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `void`
@@ -74,7 +74,7 @@ ___
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[query](_types_.apibaseinterface.md#query)*
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/types.ts#L17)*
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/types.ts#L17)*
___
<a id="rpc"></a>
@@ -85,7 +85,7 @@ ___
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[rpc](_types_.apibaseinterface.md#rpc)*
*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/types.ts#L18)*
*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/types.ts#L18)*
___
<a id="runtimemetadata"></a>
@@ -96,7 +96,7 @@ ___
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[runtimeMetadata](_types_.apibaseinterface.md#runtimemetadata)*
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/types.ts#L15)*
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/types.ts#L15)*
___
<a id="runtimeversion"></a>
@@ -107,7 +107,7 @@ ___
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[runtimeVersion](_types_.apibaseinterface.md#runtimeversion)*
*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/types.ts#L16)*
*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/types.ts#L16)*
___
<a id="tx"></a>
@@ -118,7 +118,7 @@ ___
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[tx](_types_.apibaseinterface.md#tx)*
*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/types.ts#L19)*
*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/types.ts#L19)*
___
docs/api/interfaces/_promise_types_.queryablestoragefunction.md
+6 -6
View File
@@ -11,7 +11,7 @@
▸ **__call**(arg?: *`any`*): `Uint8Array`
*Defined in [promise/types.ts:14](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/promise/types.ts#L14)*
*Defined in [promise/types.ts:14](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/promise/types.ts#L14)*
**Parameters:**
@@ -21,7 +21,7 @@
**Returns:** `Promise`< `Codec` &#124; `null` &#124; `undefined`>
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:12](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/StorageKey.ts#L12)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:12](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/StorageKey.ts#L12)*
**Parameters:**
@@ -41,7 +41,7 @@
*Inherited from StorageFunction.meta*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:14](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/StorageKey.ts#L14)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:14](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/StorageKey.ts#L14)*
___
<a id="method"></a>
@@ -52,7 +52,7 @@ ___
*Inherited from StorageFunction.method*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:15](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/StorageKey.ts#L15)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:15](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/StorageKey.ts#L15)*
___
<a id="section"></a>
@@ -63,7 +63,7 @@ ___
*Inherited from StorageFunction.section*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:16](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/StorageKey.ts#L16)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:16](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/StorageKey.ts#L16)*
___
<a id="tojson"></a>
@@ -74,7 +74,7 @@ ___
*Inherited from StorageFunction.toJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:17](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/StorageKey.ts#L17)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:17](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/StorageKey.ts#L17)*
#### Type declaration
▸(): `any`
docs/api/interfaces/_promise_types_.submittableextrinsicfunction.md
+7 -7
View File
@@ -11,7 +11,7 @@
▸ **__call**(...args: *`any`[]*): `Extrinsic`
*Defined in [promise/types.ts:26](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/promise/types.ts#L26)*
*Defined in [promise/types.ts:26](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/promise/types.ts#L26)*
**Parameters:**
@@ -21,7 +21,7 @@
**Returns:** [SubmittableExtrinsic](../classes/_promise_submittableextrinsic_.submittableextrinsic.md)
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:34](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Method.ts#L34)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:34](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Method.ts#L34)*
**Parameters:**
@@ -41,7 +41,7 @@
*Inherited from ExtrinsicFunction.callIndex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:36](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Method.ts#L36)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:36](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Method.ts#L36)*
___
<a id="meta"></a>
@@ -52,7 +52,7 @@ ___
*Inherited from ExtrinsicFunction.meta*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:37](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Method.ts#L37)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:37](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Method.ts#L37)*
___
<a id="method"></a>
@@ -63,7 +63,7 @@ ___
*Inherited from ExtrinsicFunction.method*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:38](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Method.ts#L38)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:38](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Method.ts#L38)*
___
<a id="section"></a>
@@ -74,7 +74,7 @@ ___
*Inherited from ExtrinsicFunction.section*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:39](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Method.ts#L39)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:39](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Method.ts#L39)*
___
<a id="tojson"></a>
@@ -85,7 +85,7 @@ ___
*Inherited from ExtrinsicFunction.toJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:40](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Method.ts#L40)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:40](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Method.ts#L40)*
#### Type declaration
▸(): `any`
docs/api/interfaces/_rx_types_.apirxinterface.md
+10 -10
View File
@@ -20,7 +20,7 @@
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[genesisHash](_types_.apibaseinterface.md#genesishash)*
*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/types.ts#L13)*
*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/types.ts#L13)*
___
<a id="hassubscriptions"></a>
@@ -31,7 +31,7 @@ ___
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[hasSubscriptions](_types_.apibaseinterface.md#hassubscriptions)*
*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/types.ts#L14)*
*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/types.ts#L14)*
___
<a id="isconnected"></a>
@@ -40,7 +40,7 @@ ___
**● isConnected**: *`Observable`<`boolean`>*
*Defined in [rx/types.ts:40](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/rx/types.ts#L40)*
*Defined in [rx/types.ts:40](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/rx/types.ts#L40)*
___
<a id="isready"></a>
@@ -49,7 +49,7 @@ ___
**● isReady**: *`Observable`<[ApiRxInterface](_rx_types_.apirxinterface.md)>*
*Defined in [rx/types.ts:41](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/rx/types.ts#L41)*
*Defined in [rx/types.ts:41](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/rx/types.ts#L41)*
___
<a id="on"></a>
@@ -60,7 +60,7 @@ ___
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[on](_types_.apibaseinterface.md#on)*
*Defined in [types.ts:21](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/types.ts#L21)*
*Defined in [types.ts:21](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/types.ts#L21)*
#### Type declaration
▸(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `void`
@@ -83,7 +83,7 @@ ___
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[query](_types_.apibaseinterface.md#query)*
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/types.ts#L17)*
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/types.ts#L17)*
___
<a id="rpc"></a>
@@ -94,7 +94,7 @@ ___
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[rpc](_types_.apibaseinterface.md#rpc)*
*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/types.ts#L18)*
*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/types.ts#L18)*
___
<a id="runtimemetadata"></a>
@@ -105,7 +105,7 @@ ___
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[runtimeMetadata](_types_.apibaseinterface.md#runtimemetadata)*
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/types.ts#L15)*
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/types.ts#L15)*
___
<a id="runtimeversion"></a>
@@ -116,7 +116,7 @@ ___
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[runtimeVersion](_types_.apibaseinterface.md#runtimeversion)*
*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/types.ts#L16)*
*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/types.ts#L16)*
___
<a id="tx"></a>
@@ -127,7 +127,7 @@ ___
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[tx](_types_.apibaseinterface.md#tx)*
*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/types.ts#L19)*
*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/types.ts#L19)*
___
docs/api/interfaces/_rx_types_.queryablestoragefunction.md
+6 -6
View File
@@ -11,7 +11,7 @@
▸ **__call**(arg?: *`any`*): `Uint8Array`
*Defined in [rx/types.ts:15](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/rx/types.ts#L15)*
*Defined in [rx/types.ts:15](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/rx/types.ts#L15)*
**Parameters:**
@@ -21,7 +21,7 @@
**Returns:** `Observable`< `Codec` &#124; `null` &#124; `undefined`>
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:12](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/StorageKey.ts#L12)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:12](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/StorageKey.ts#L12)*
**Parameters:**
@@ -41,7 +41,7 @@
*Inherited from StorageFunction.meta*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:14](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/StorageKey.ts#L14)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:14](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/StorageKey.ts#L14)*
___
<a id="method"></a>
@@ -52,7 +52,7 @@ ___
*Inherited from StorageFunction.method*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:15](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/StorageKey.ts#L15)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:15](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/StorageKey.ts#L15)*
___
<a id="section"></a>
@@ -63,7 +63,7 @@ ___
*Inherited from StorageFunction.section*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:16](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/StorageKey.ts#L16)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:16](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/StorageKey.ts#L16)*
___
<a id="tojson"></a>
@@ -74,7 +74,7 @@ ___
*Inherited from StorageFunction.toJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:17](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/StorageKey.ts#L17)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:17](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/StorageKey.ts#L17)*
#### Type declaration
▸(): `any`
docs/api/interfaces/_rx_types_.submittableextrinsicfunction.md
+7 -7
View File
@@ -11,7 +11,7 @@
▸ **__call**(...args: *`any`[]*): `Extrinsic`
*Defined in [rx/types.ts:27](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/rx/types.ts#L27)*
*Defined in [rx/types.ts:27](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/rx/types.ts#L27)*
**Parameters:**
@@ -21,7 +21,7 @@
**Returns:** [SubmittableExtrinsic](../classes/_rx_submittableextrinsic_.submittableextrinsic.md)
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:34](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Method.ts#L34)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:34](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Method.ts#L34)*
**Parameters:**
@@ -41,7 +41,7 @@
*Inherited from ExtrinsicFunction.callIndex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:36](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Method.ts#L36)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:36](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Method.ts#L36)*
___
<a id="meta"></a>
@@ -52,7 +52,7 @@ ___
*Inherited from ExtrinsicFunction.meta*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:37](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Method.ts#L37)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:37](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Method.ts#L37)*
___
<a id="method"></a>
@@ -63,7 +63,7 @@ ___
*Inherited from ExtrinsicFunction.method*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:38](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Method.ts#L38)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:38](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Method.ts#L38)*
___
<a id="section"></a>
@@ -74,7 +74,7 @@ ___
*Inherited from ExtrinsicFunction.section*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:39](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Method.ts#L39)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:39](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Method.ts#L39)*
___
<a id="tojson"></a>
@@ -85,7 +85,7 @@ ___
*Inherited from ExtrinsicFunction.toJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:40](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Method.ts#L40)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:40](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Method.ts#L40)*
#### Type declaration
▸(): `any`
docs/api/interfaces/_types_.apibaseinterface.md
+8 -8
View File
@@ -26,7 +26,7 @@
**● genesisHash**: *`Hash`*
*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/types.ts#L13)*
*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/types.ts#L13)*
___
<a id="hassubscriptions"></a>
@@ -35,7 +35,7 @@ ___
**● hasSubscriptions**: *`boolean`*
*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/types.ts#L14)*
*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/types.ts#L14)*
___
<a id="on"></a>
@@ -44,7 +44,7 @@ ___
**● on**: *`function`*
*Defined in [types.ts:21](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/types.ts#L21)*
*Defined in [types.ts:21](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/types.ts#L21)*
#### Type declaration
▸(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `void`
@@ -65,7 +65,7 @@ ___
**● query**: *`S`*
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/types.ts#L17)*
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/types.ts#L17)*
___
<a id="rpc"></a>
@@ -74,7 +74,7 @@ ___
**● rpc**: *`R`*
*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/types.ts#L18)*
*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/types.ts#L18)*
___
<a id="runtimemetadata"></a>
@@ -83,7 +83,7 @@ ___
**● runtimeMetadata**: *`Metadata`*
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/types.ts#L15)*
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/types.ts#L15)*
___
<a id="runtimeversion"></a>
@@ -92,7 +92,7 @@ ___
**● runtimeVersion**: *`RuntimeVersion`*
*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/types.ts#L16)*
*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/types.ts#L16)*
___
<a id="tx"></a>
@@ -101,7 +101,7 @@ ___
**● tx**: *`E`*
*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/types.ts#L19)*
*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/types.ts#L19)*
___
docs/api/interfaces/_types_.apioptions.md
+2 -2
View File
@@ -12,7 +12,7 @@
**● provider**: *`ProviderInterface`*
*Defined in [types.ts:29](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/types.ts#L29)*
*Defined in [types.ts:29](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/types.ts#L29)*
*__description__*: Transport Provider from rpc-provider. If not specified, it will default to connecting to a WsProvider connecting localhost with the default port, i.e. `ws://127.0.0.1:9944`
@@ -24,7 +24,7 @@ ___
**● types**: * `undefined` &#124; `object`
*
*Defined in [types.ts:34](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/types.ts#L34)*
*Defined in [types.ts:34](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/types.ts#L34)*
*__description__*: Additional types used by runtime modules. This is nessusary if the runtime modules uses types not available in the base Substrate runtime.
docs/api/modules/_promise_combinator_.md
+2 -2
View File
@@ -21,7 +21,7 @@
**Ƭ CombinatorCallback**: *`function`*
*Defined in [promise/Combinator.ts:7](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/promise/Combinator.ts#L7)*
*Defined in [promise/Combinator.ts:7](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/promise/Combinator.ts#L7)*
#### Type declaration
▸(value: *`Array`<`any`>*): `any`
@@ -41,7 +41,7 @@ ___
**Ƭ CombinatorFunction**: *`function`*
*Defined in [promise/Combinator.ts:8](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/promise/Combinator.ts#L8)*
*Defined in [promise/Combinator.ts:8](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/promise/Combinator.ts#L8)*
#### Type declaration
▸(cb: *`function`*): `any`
docs/api/modules/_types_.md
+1 -1
View File
@@ -22,7 +22,7 @@
**Ƭ ApiInterface$Events**: * `RpcRxInterface$Events` &#124; "ready"
*
*Defined in [types.ts:10](https://github.com/polkadot-js/api/blob/69b05c7/packages/api/src/types.ts#L10)*
*Defined in [types.ts:10](https://github.com/polkadot-js/api/blob/b52a86e/packages/api/src/types.ts#L10)*
___
docs/examples/promise/01_simple_connect/index.html
+1529 -1
View File
File diff suppressed because it is too large Load Diff
docs/examples/promise/02_listen_to_blocks/index.html
+1529 -1
View File
File diff suppressed because it is too large Load Diff
docs/examples/promise/03_listen_to_balance_change/index.html
+1529 -1
View File
File diff suppressed because it is too large Load Diff
docs/examples/promise/05_read_storage/index.html
+1529 -1
View File
File diff suppressed because it is too large Load Diff
docs/examples/promise/07_transfer_dots/index.html
+1529 -1
View File
File diff suppressed because it is too large Load Diff
docs/examples/promise/08_system_events/index.html
+1536 -2
View File
File diff suppressed because it is too large Load Diff
docs/examples/promise/index.html
+1529 -1
View File
File diff suppressed because it is too large Load Diff
docs/index.html
+1530 -35
View File
File diff suppressed because it is too large Load Diff
docs/rpc-core/classes/_index_.rpc.md
+7 -7
View File
@@ -38,7 +38,7 @@ const api = new Api(provider);
⊕ **new Rpc**(provider?: *`ProviderInterface`*): [Rpc](_index_.rpc.md)
*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-core/src/index.ts#L44)*
*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-core/src/index.ts#L44)*
*__constructor__*: Default constructor for the Api Object
@@ -60,7 +60,7 @@ ___
**● _provider**: *`ProviderInterface`*
*Defined in [index.ts:40](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-core/src/index.ts#L40)*
*Defined in [index.ts:40](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-core/src/index.ts#L40)*
___
<a id="author"></a>
@@ -71,7 +71,7 @@ ___
*Implementation of [RpcInterface](../interfaces/_types_.rpcinterface.md).[author](../interfaces/_types_.rpcinterface.md#author)*
*Defined in [index.ts:41](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-core/src/index.ts#L41)*
*Defined in [index.ts:41](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-core/src/index.ts#L41)*
___
<a id="chain"></a>
@@ -82,7 +82,7 @@ ___
*Implementation of [RpcInterface](../interfaces/_types_.rpcinterface.md).[chain](../interfaces/_types_.rpcinterface.md#chain)*
*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-core/src/index.ts#L42)*
*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-core/src/index.ts#L42)*
___
<a id="state"></a>
@@ -93,7 +93,7 @@ ___
*Implementation of [RpcInterface](../interfaces/_types_.rpcinterface.md).[state](../interfaces/_types_.rpcinterface.md#state)*
*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-core/src/index.ts#L43)*
*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-core/src/index.ts#L43)*
___
<a id="system"></a>
@@ -104,7 +104,7 @@ ___
*Implementation of [RpcInterface](../interfaces/_types_.rpcinterface.md).[system](../interfaces/_types_.rpcinterface.md#system)*
*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-core/src/index.ts#L44)*
*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-core/src/index.ts#L44)*
___
@@ -116,7 +116,7 @@ ___
▸ **signature**(__namedParameters: *`object`*): `string`
*Defined in [index.ts:77](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-core/src/index.ts#L77)*
*Defined in [index.ts:77](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-core/src/index.ts#L77)*
*__name__*: signature
docs/rpc-core/interfaces/_types_.rpcinterface.md
+4 -4
View File
@@ -16,7 +16,7 @@
**● author**: *[RpcInterface$Section](../modules/_types_.md#rpcinterface_section)*
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-core/src/types.ts#L17)*
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-core/src/types.ts#L17)*
___
<a id="chain"></a>
@@ -25,7 +25,7 @@ ___
**● chain**: *[RpcInterface$Section](../modules/_types_.md#rpcinterface_section)*
*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-core/src/types.ts#L18)*
*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-core/src/types.ts#L18)*
___
<a id="state"></a>
@@ -34,7 +34,7 @@ ___
**● state**: *[RpcInterface$Section](../modules/_types_.md#rpcinterface_section)*
*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-core/src/types.ts#L19)*
*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-core/src/types.ts#L19)*
___
<a id="system"></a>
@@ -43,7 +43,7 @@ ___
**● system**: *[RpcInterface$Section](../modules/_types_.md#rpcinterface_section)*
*Defined in [types.ts:20](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-core/src/types.ts#L20)*
*Defined in [types.ts:20](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-core/src/types.ts#L20)*
___
docs/rpc-core/interfaces/_types_.rpcinterface_section_method.md
+3 -3
View File
@@ -7,7 +7,7 @@
# Callable
▸ **__call**(...params: *`Array`<`any`>*): `Promise`<`any`>
*Defined in [types.ts:5](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-core/src/types.ts#L5)*
*Defined in [types.ts:5](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-core/src/types.ts#L5)*
**Parameters:**
@@ -25,7 +25,7 @@
**● subscription**: *`string`*
*Defined in [types.ts:8](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-core/src/types.ts#L8)*
*Defined in [types.ts:8](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-core/src/types.ts#L8)*
___
<a id="unsubscribe"></a>
@@ -34,7 +34,7 @@ ___
**● unsubscribe**: *`function`*
*Defined in [types.ts:9](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-core/src/types.ts#L9)*
*Defined in [types.ts:9](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-core/src/types.ts#L9)*
#### Type declaration
▸(id: *`number`*): `Promise`<`any`>
docs/rpc-core/modules/_types_.md
+1 -1
View File
@@ -21,7 +21,7 @@
**Ƭ RpcInterface$Section**: *`object`*
*Defined in [types.ts:12](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-core/src/types.ts#L12)*
*Defined in [types.ts:12](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-core/src/types.ts#L12)*
#### Type declaration
docs/rpc-provider/classes/_coder_index_.rpccoder.md
+4 -4
View File
@@ -12,7 +12,7 @@
▸ **decodeResponse**(response: *[JsonRpcResponse](../modules/_types_.md#jsonrpcresponse)*): `any`
*Defined in [coder/index.ts:12](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-provider/src/coder/index.ts#L12)*
*Defined in [coder/index.ts:12](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-provider/src/coder/index.ts#L12)*
**Parameters:**
@@ -29,7 +29,7 @@ ___
▸ **encodeJson**(method: *`string`*, params: * `any` &#124; `Array`<`any`>*): `string`
*Defined in [coder/index.ts:33](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-provider/src/coder/index.ts#L33)*
*Defined in [coder/index.ts:33](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-provider/src/coder/index.ts#L33)*
**Parameters:**
@@ -47,7 +47,7 @@ ___
▸ **encodeObject**(method: *`string`*, params: * `any` &#124; `Array`<`any`>*): [JsonRpcRequest](../modules/_types_.md#jsonrpcrequest)
*Defined in [coder/index.ts:39](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-provider/src/coder/index.ts#L39)*
*Defined in [coder/index.ts:39](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-provider/src/coder/index.ts#L39)*
**Parameters:**
@@ -65,7 +65,7 @@ ___
▸ **getId**(): `number`
*Defined in [coder/index.ts:48](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-provider/src/coder/index.ts#L48)*
*Defined in [coder/index.ts:48](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-provider/src/coder/index.ts#L48)*
**Returns:** `number`
docs/rpc-provider/classes/_http_index_.httpprovider.html
+1536 -8
View File
File diff suppressed because it is too large Load Diff
docs/rpc-provider/classes/_http_index_.httpprovider.md
+7 -7
View File
@@ -34,7 +34,7 @@ const api = new Api(provider);
⊕ **new HttpProvider**(endpoint?: *`string`*): [HttpProvider](_http_index_.httpprovider.md)
*Defined in [http/index.ts:40](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-provider/src/http/index.ts#L40)*
*Defined in [http/index.ts:40](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-provider/src/http/index.ts#L40)*
**Parameters:**
@@ -54,7 +54,7 @@ ___
gethasSubscriptions(): `boolean`
*Defined in [http/index.ts:55](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-provider/src/http/index.ts#L55)*
*Defined in [http/index.ts:55](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-provider/src/http/index.ts#L55)*
*__summary__*: `true` when this provider supports subscriptions
@@ -72,7 +72,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[isConnected](../interfaces/_types_.providerinterface.md#isconnected)*
*Defined in [http/index.ts:63](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-provider/src/http/index.ts#L63)*
*Defined in [http/index.ts:63](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-provider/src/http/index.ts#L63)*
*__summary__*: Whether the node is connected or not.
@@ -88,7 +88,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[on](../interfaces/_types_.providerinterface.md#on)*
*Defined in [http/index.ts:71](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-provider/src/http/index.ts#L71)*
*Defined in [http/index.ts:71](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-provider/src/http/index.ts#L71)*
*__summary__*: Events are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md).
@@ -112,7 +112,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[send](../interfaces/_types_.providerinterface.md#send)*
*Defined in [http/index.ts:78](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-provider/src/http/index.ts#L78)*
*Defined in [http/index.ts:78](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-provider/src/http/index.ts#L78)*
*__summary__*: Send HTTP POST Request with Body to configured HTTP Endpoint.
@@ -134,7 +134,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[subscribe](../interfaces/_types_.providerinterface.md#subscribe)*
*Defined in [http/index.ts:100](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-provider/src/http/index.ts#L100)*
*Defined in [http/index.ts:100](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-provider/src/http/index.ts#L100)*
*__summary__*: Subscriptions are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md).
@@ -158,7 +158,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[unsubscribe](../interfaces/_types_.providerinterface.md#unsubscribe)*
*Defined in [http/index.ts:109](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-provider/src/http/index.ts#L109)*
*Defined in [http/index.ts:109](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-provider/src/http/index.ts#L109)*
*__summary__*: Subscriptions are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md).
docs/rpc-provider/classes/_mock_index_.mock.md
+9 -9
View File
@@ -19,7 +19,7 @@ A mock provider mainly used for testing.
⊕ **new Mock**(): [Mock](_mock_index_.mock.md)
*Defined in [mock/index.ts:64](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-provider/src/mock/index.ts#L64)*
*Defined in [mock/index.ts:64](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-provider/src/mock/index.ts#L64)*
**Returns:** [Mock](_mock_index_.mock.md)
@@ -33,7 +33,7 @@ ___
**● isUpdating**: *`boolean`* = true
*Defined in [mock/index.ts:42](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-provider/src/mock/index.ts#L42)*
*Defined in [mock/index.ts:42](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-provider/src/mock/index.ts#L42)*
___
<a id="subscriptions"></a>
@@ -49,7 +49,7 @@ ___
return subs;
}, ({} as MockState$Subscriptions))
*Defined in [mock/index.ts:53](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-provider/src/mock/index.ts#L53)*
*Defined in [mock/index.ts:53](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-provider/src/mock/index.ts#L53)*
___
@@ -61,7 +61,7 @@ ___
gethasSubscriptions(): `boolean`
*Defined in [mock/index.ts:70](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-provider/src/mock/index.ts#L70)*
*Defined in [mock/index.ts:70](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-provider/src/mock/index.ts#L70)*
**Returns:** `boolean`
@@ -77,7 +77,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[isConnected](../interfaces/_types_.providerinterface.md#isconnected)*
*Defined in [mock/index.ts:74](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-provider/src/mock/index.ts#L74)*
*Defined in [mock/index.ts:74](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-provider/src/mock/index.ts#L74)*
**Returns:** `boolean`
@@ -90,7 +90,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[on](../interfaces/_types_.providerinterface.md#on)*
*Defined in [mock/index.ts:78](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-provider/src/mock/index.ts#L78)*
*Defined in [mock/index.ts:78](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-provider/src/mock/index.ts#L78)*
**Parameters:**
@@ -110,7 +110,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[send](../interfaces/_types_.providerinterface.md#send)*
*Defined in [mock/index.ts:82](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-provider/src/mock/index.ts#L82)*
*Defined in [mock/index.ts:82](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-provider/src/mock/index.ts#L82)*
**Parameters:**
@@ -128,7 +128,7 @@ ___
▸ **subscribe**(type: *`string`*, method: *`string`*, ...params: *`Array`<`any`>*): `Promise`<`number`>
*Defined in [mock/index.ts:90](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-provider/src/mock/index.ts#L90)*
*Defined in [mock/index.ts:90](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-provider/src/mock/index.ts#L90)*
**Parameters:**
@@ -149,7 +149,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[unsubscribe](../interfaces/_types_.providerinterface.md#unsubscribe)*
*Defined in [mock/index.ts:110](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-provider/src/mock/index.ts#L110)*
*Defined in [mock/index.ts:110](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-provider/src/mock/index.ts#L110)*
**Parameters:**
docs/rpc-provider/classes/_ws_index_.wsprovider.html
+1537 -9
View File
File diff suppressed because it is too large Load Diff
docs/rpc-provider/classes/_ws_index_.wsprovider.md
+8 -8
View File
@@ -34,7 +34,7 @@ const api = new Api(provider);
⊕ **new WsProvider**(endpoint?: *`string`*, autoConnect?: *`boolean`*): [WsProvider](_ws_index_.wsprovider.md)
*Defined in [ws/index.ts:75](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-provider/src/ws/index.ts#L75)*
*Defined in [ws/index.ts:75](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-provider/src/ws/index.ts#L75)*
**Parameters:**
@@ -55,7 +55,7 @@ ___
gethasSubscriptions(): `boolean`
*Defined in [ws/index.ts:101](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-provider/src/ws/index.ts#L101)*
*Defined in [ws/index.ts:101](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-provider/src/ws/index.ts#L101)*
*__summary__*: `true` when this provider supports subscriptions
@@ -71,7 +71,7 @@ ___
▸ **connect**(): `void`
*Defined in [ws/index.ts:110](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-provider/src/ws/index.ts#L110)*
*Defined in [ws/index.ts:110](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-provider/src/ws/index.ts#L110)*
*__summary__*: Manually connect
@@ -86,7 +86,7 @@ ___
▸ **isConnected**(): `boolean`
*Defined in [ws/index.ts:127](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-provider/src/ws/index.ts#L127)*
*Defined in [ws/index.ts:127](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-provider/src/ws/index.ts#L127)*
*__summary__*: Whether the node is connected or not.
@@ -100,7 +100,7 @@ ___
▸ **on**(type: *[ProviderInterface$Emitted](../modules/_types_.md#providerinterface_emitted)*, sub: *[ProviderInterface$EmitCb](../modules/_types_.md#providerinterface_emitcb)*): `void`
*Defined in [ws/index.ts:136](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-provider/src/ws/index.ts#L136)*
*Defined in [ws/index.ts:136](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-provider/src/ws/index.ts#L136)*
*__summary__*: Listens on events after having subscribed using the [subscribe](_ws_index_.wsprovider.md#subscribe) function.
@@ -120,7 +120,7 @@ ___
▸ **send**(method: *`string`*, params: *`Array`<`any`>*, subscription?: *`SubscriptionHandler`*): `Promise`<`any`>
*Defined in [ws/index.ts:146](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-provider/src/ws/index.ts#L146)*
*Defined in [ws/index.ts:146](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-provider/src/ws/index.ts#L146)*
*__summary__*: Send JSON data using WebSockets to configured HTTP Endpoint or queue.
@@ -141,7 +141,7 @@ ___
▸ **subscribe**(type: *`string`*, method: *`string`*, params: *`Array`<`any`>*, callback: *[ProviderInterface$Callback](../modules/_types_.md#providerinterface_callback)*): `Promise`<`number`>
*Defined in [ws/index.ts:202](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-provider/src/ws/index.ts#L202)*
*Defined in [ws/index.ts:202](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-provider/src/ws/index.ts#L202)*
*__name__*: subscribe
@@ -179,7 +179,7 @@ ___
▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`>
*Defined in [ws/index.ts:211](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-provider/src/ws/index.ts#L211)*
*Defined in [ws/index.ts:211](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-provider/src/ws/index.ts#L211)*
*__summary__*: Allows unsubscribing to subscriptions made with [subscribe](_ws_index_.wsprovider.md#subscribe).
docs/rpc-provider/index.html
+1529 -1
View File
File diff suppressed because it is too large Load Diff
docs/rpc-provider/interfaces/_types_.providerinterface.md
+6 -6
View File
@@ -17,7 +17,7 @@
**● hasSubscriptions**: *`boolean`*
*Defined in [types.ts:45](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-provider/src/types.ts#L45)*
*Defined in [types.ts:45](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-provider/src/types.ts#L45)*
___
@@ -29,7 +29,7 @@ ___
▸ **isConnected**(): `boolean`
*Defined in [types.ts:46](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-provider/src/types.ts#L46)*
*Defined in [types.ts:46](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-provider/src/types.ts#L46)*
**Returns:** `boolean`
@@ -40,7 +40,7 @@ ___
▸ **on**(type: *[ProviderInterface$Emitted](../modules/_types_.md#providerinterface_emitted)*, sub: *[ProviderInterface$EmitCb](../modules/_types_.md#providerinterface_emitcb)*): `void`
*Defined in [types.ts:47](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-provider/src/types.ts#L47)*
*Defined in [types.ts:47](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-provider/src/types.ts#L47)*
**Parameters:**
@@ -58,7 +58,7 @@ ___
▸ **send**(method: *`string`*, params: *`Array`<`any`>*): `Promise`<`any`>
*Defined in [types.ts:48](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-provider/src/types.ts#L48)*
*Defined in [types.ts:48](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-provider/src/types.ts#L48)*
**Parameters:**
@@ -76,7 +76,7 @@ ___
▸ **subscribe**(type: *`string`*, method: *`string`*, params: *`Array`<`any`>*, cb: *[ProviderInterface$Callback](../modules/_types_.md#providerinterface_callback)*): `Promise`<`number`>
*Defined in [types.ts:49](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-provider/src/types.ts#L49)*
*Defined in [types.ts:49](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-provider/src/types.ts#L49)*
**Parameters:**
@@ -96,7 +96,7 @@ ___
▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`>
*Defined in [types.ts:50](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-provider/src/types.ts#L50)*
*Defined in [types.ts:50](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-provider/src/types.ts#L50)*
**Parameters:**
docs/rpc-provider/modules/_http_types_.md
+1 -1
View File
@@ -8,7 +8,7 @@
**Ƭ HttpState**: *`object`*
*Defined in [http/types.ts:9](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-provider/src/http/types.ts#L9)*
*Defined in [http/types.ts:9](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-provider/src/http/types.ts#L9)*
#### Type declaration
docs/rpc-provider/modules/_mock_types_.md
+4 -4
View File
@@ -8,7 +8,7 @@
**Ƭ MockState$Db**: *`object`*
*Defined in [mock/types.ts:16](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-provider/src/mock/types.ts#L16)*
*Defined in [mock/types.ts:16](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-provider/src/mock/types.ts#L16)*
#### Type declaration
@@ -21,7 +21,7 @@ ___
**Ƭ MockState$Requests**: *`object`*
*Defined in [mock/types.ts:20](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-provider/src/mock/types.ts#L20)*
*Defined in [mock/types.ts:20](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-provider/src/mock/types.ts#L20)*
#### Type declaration
@@ -45,7 +45,7 @@ ___
**Ƭ MockState$Subscription$Callback**: *`function`*
*Defined in [mock/types.ts:5](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-provider/src/mock/types.ts#L5)*
*Defined in [mock/types.ts:5](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-provider/src/mock/types.ts#L5)*
#### Type declaration
▸(error: * `Error` &#124; `null`*, value: *`any`*): `void`
@@ -66,7 +66,7 @@ ___
**Ƭ MockState$Subscriptions**: *`object`*
*Defined in [mock/types.ts:7](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-provider/src/mock/types.ts#L7)*
*Defined in [mock/types.ts:7](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-provider/src/mock/types.ts#L7)*
#### Type declaration
docs/rpc-provider/modules/_types_.md
+8 -8
View File
@@ -27,7 +27,7 @@
**Ƭ JsonRpcObject**: *`object`*
*Defined in [types.ts:5](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-provider/src/types.ts#L5)*
*Defined in [types.ts:5](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-provider/src/types.ts#L5)*
#### Type declaration
@@ -39,7 +39,7 @@ ___
**Ƭ JsonRpcRequest**: * [JsonRpcObject](_types_.md#jsonrpcobject) & `object`
*
*Defined in [types.ts:10](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-provider/src/types.ts#L10)*
*Defined in [types.ts:10](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-provider/src/types.ts#L10)*
___
<a id="jsonrpcresponse"></a>
@@ -49,7 +49,7 @@ ___
**Ƭ JsonRpcResponse**: * [JsonRpcObject](_types_.md#jsonrpcobject) & [JsonRpcResponseBase](_types_.md#jsonrpcresponsebase)
*
*Defined in [types.ts:36](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-provider/src/types.ts#L36)*
*Defined in [types.ts:36](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-provider/src/types.ts#L36)*
___
<a id="jsonrpcresponsebase"></a>
@@ -59,7 +59,7 @@ ___
**Ƭ JsonRpcResponseBase**: * `JsonRpcResponse$Single` & `JsonRpcResponse$Subscription`
*
*Defined in [types.ts:34](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-provider/src/types.ts#L34)*
*Defined in [types.ts:34](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-provider/src/types.ts#L34)*
___
<a id="jsonrpcresponsebase_error"></a>
@@ -68,7 +68,7 @@ ___
**Ƭ JsonRpcResponseBase$Error**: *`object`*
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-provider/src/types.ts#L15)*
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-provider/src/types.ts#L15)*
#### Type declaration
@@ -79,7 +79,7 @@ ___
**Ƭ ProviderInterface$Callback**: *`function`*
*Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-provider/src/types.ts#L38)*
*Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-provider/src/types.ts#L38)*
#### Type declaration
▸(result: *`any`*): `void`
@@ -99,7 +99,7 @@ ___
**Ƭ ProviderInterface$EmitCb**: *`function`*
*Defined in [types.ts:42](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-provider/src/types.ts#L42)*
*Defined in [types.ts:42](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-provider/src/types.ts#L42)*
#### Type declaration
▸(value?: *`any`*): `any`
@@ -120,7 +120,7 @@ ___
**Ƭ ProviderInterface$Emitted**: * "connected" &#124; "disconnected"
*
*Defined in [types.ts:40](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-provider/src/types.ts#L40)*
*Defined in [types.ts:40](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-provider/src/types.ts#L40)*
___
docs/rpc-rx/classes/_index_.rpcrx.md
+7 -7
View File
@@ -32,7 +32,7 @@ const api = new RpcRx(provider);
⊕ **new RpcRx**(providerOrRpc?: * `Rpc` &#124; `ProviderInterface`*): [RpcRx](_index_.rpcrx.md)
*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-rx/src/index.ts#L45)*
*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-rx/src/index.ts#L45)*
**Parameters:**
@@ -52,7 +52,7 @@ ___
**● author**: *[RpcRxInterface$Section](../modules/_types_.md#rpcrxinterface_section)*
*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-rx/src/index.ts#L42)*
*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-rx/src/index.ts#L42)*
___
<a id="chain"></a>
@@ -61,7 +61,7 @@ ___
**● chain**: *[RpcRxInterface$Section](../modules/_types_.md#rpcrxinterface_section)*
*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-rx/src/index.ts#L43)*
*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-rx/src/index.ts#L43)*
___
<a id="state"></a>
@@ -70,7 +70,7 @@ ___
**● state**: *[RpcRxInterface$Section](../modules/_types_.md#rpcrxinterface_section)*
*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-rx/src/index.ts#L44)*
*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-rx/src/index.ts#L44)*
___
<a id="system"></a>
@@ -79,7 +79,7 @@ ___
**● system**: *[RpcRxInterface$Section](../modules/_types_.md#rpcrxinterface_section)*
*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-rx/src/index.ts#L45)*
*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-rx/src/index.ts#L45)*
___
@@ -91,7 +91,7 @@ ___
▸ **isConnected**(): `BehaviorSubject`<`boolean`>
*Defined in [index.ts:66](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-rx/src/index.ts#L66)*
*Defined in [index.ts:66](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-rx/src/index.ts#L66)*
**Returns:** `BehaviorSubject`<`boolean`>
@@ -102,7 +102,7 @@ ___
▸ **on**(type: *[RpcRxInterface$Events](../modules/_types_.md#rpcrxinterface_events)*, handler: *`function`*): `void`
*Defined in [index.ts:70](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-rx/src/index.ts#L70)*
*Defined in [index.ts:70](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-rx/src/index.ts#L70)*
**Parameters:**
docs/rpc-rx/modules/_types_.md
+4 -4
View File
@@ -8,7 +8,7 @@
**Ƭ RpcRxInterface**: *`object`*
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-rx/src/types.ts#L15)*
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-rx/src/types.ts#L15)*
#### Type declaration
@@ -20,7 +20,7 @@ ___
**Ƭ RpcRxInterface$Events**: * "connected" &#124; "disconnected"
*
*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-rx/src/types.ts#L13)*
*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-rx/src/types.ts#L13)*
___
<a id="rpcrxinterface_method"></a>
@@ -29,7 +29,7 @@ ___
**Ƭ RpcRxInterface$Method**: *`function`*
*Defined in [types.ts:7](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-rx/src/types.ts#L7)*
*Defined in [types.ts:7](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-rx/src/types.ts#L7)*
#### Type declaration
▸(...params: *`Array`<`any`>*): `Observable`<`any`> &#124; `ReplaySubject`<`any`>
@@ -49,7 +49,7 @@ ___
**Ƭ RpcRxInterface$Section**: *`object`*
*Defined in [types.ts:9](https://github.com/polkadot-js/api/blob/69b05c7/packages/rpc-rx/src/types.ts#L9)*
*Defined in [types.ts:9](https://github.com/polkadot-js/api/blob/b52a86e/packages/rpc-rx/src/types.ts#L9)*
#### Type declaration
docs/search_index.json
+1 -1
View File
File diff suppressed because one or more lines are too long
docs/type-extrinsics/modules/_frommetadata_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **fromMetadata**(metadata: *`Metadata`*): `Extrinsics`
*Defined in [fromMetadata.ts:21](https://github.com/polkadot-js/api/blob/69b05c7/packages/type-extrinsics/src/fromMetadata.ts#L21)*
*Defined in [fromMetadata.ts:21](https://github.com/polkadot-js/api/blob/b52a86e/packages/type-extrinsics/src/fromMetadata.ts#L21)*
Extend a storage object with the storage modules & module functions present in the metadata.
docs/type-extrinsics/modules/_utils_createunchecked_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **createDescriptor**(section: *`string`*, method: *`string`*, index: *`number`*, meta: *`FunctionMetadata`*): `ExtrinsicFunction`
*Defined in [utils/createUnchecked.ts:16](https://github.com/polkadot-js/api/blob/69b05c7/packages/type-extrinsics/src/utils/createUnchecked.ts#L16)*
*Defined in [utils/createUnchecked.ts:16](https://github.com/polkadot-js/api/blob/b52a86e/packages/type-extrinsics/src/utils/createUnchecked.ts#L16)*
From the metadata of a function in the module's storage, generate the function that will return the an UncheckExtrinsic.
docs/type-jsonrpc/modules/_create_method_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **createMethod**(section: *`string`*, method: *`string`*, __namedParameters: *`object`*): [RpcMethod](_types_.md#rpcmethod)
*Defined in [create/method.ts:9](https://github.com/polkadot-js/api/blob/69b05c7/packages/type-jsonrpc/src/create/method.ts#L9)*
*Defined in [create/method.ts:9](https://github.com/polkadot-js/api/blob/b52a86e/packages/type-jsonrpc/src/create/method.ts#L9)*
**Parameters:**
docs/type-jsonrpc/modules/_create_param_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **createParam**(name: *`string`*, type: *`CodecTypes`*, __namedParameters?: *`object`*): [RpcParam](_types_.md#rpcparam)
*Defined in [create/param.ts:12](https://github.com/polkadot-js/api/blob/69b05c7/packages/type-jsonrpc/src/create/param.ts#L12)*
*Defined in [create/param.ts:12](https://github.com/polkadot-js/api/blob/b52a86e/packages/type-jsonrpc/src/create/param.ts#L12)*
**Parameters:**
docs/type-jsonrpc/modules/_types_.md
+4 -4
View File
@@ -8,7 +8,7 @@
**Ƭ RpcMethod**: *`object`*
*Defined in [types.ts:24](https://github.com/polkadot-js/api/blob/69b05c7/packages/type-jsonrpc/src/types.ts#L24)*
*Defined in [types.ts:24](https://github.com/polkadot-js/api/blob/b52a86e/packages/type-jsonrpc/src/types.ts#L24)*
#### Type declaration
@@ -19,7 +19,7 @@ ___
**Ƭ RpcMethodOpt**: *`object`*
*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/69b05c7/packages/type-jsonrpc/src/types.ts#L13)*
*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/b52a86e/packages/type-jsonrpc/src/types.ts#L13)*
#### Type declaration
@@ -30,7 +30,7 @@ ___
**Ƭ RpcParam**: *`object`*
*Defined in [types.ts:7](https://github.com/polkadot-js/api/blob/69b05c7/packages/type-jsonrpc/src/types.ts#L7)*
*Defined in [types.ts:7](https://github.com/polkadot-js/api/blob/b52a86e/packages/type-jsonrpc/src/types.ts#L7)*
#### Type declaration
@@ -41,7 +41,7 @@ ___
**Ƭ RpcSection**: *`object`*
*Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/69b05c7/packages/type-jsonrpc/src/types.ts#L38)*
*Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/b52a86e/packages/type-jsonrpc/src/types.ts#L38)*
#### Type declaration
docs/type-storage/interfaces/_types_.storage.md
+1 -1
View File
@@ -15,7 +15,7 @@
**● substrate**: *`object`*
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/69b05c7/packages/type-storage/src/types.ts#L17)*
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/b52a86e/packages/type-storage/src/types.ts#L17)*
#### Type declaration
docs/type-storage/interfaces/_utils_createfunction_.createitemoptions.md
+2 -2
View File
@@ -13,7 +13,7 @@
**● isUnhashed**: * `undefined` &#124; `false` &#124; `true`
*
*Defined in [utils/createFunction.ts:14](https://github.com/polkadot-js/api/blob/69b05c7/packages/type-storage/src/utils/createFunction.ts#L14)*
*Defined in [utils/createFunction.ts:14](https://github.com/polkadot-js/api/blob/b52a86e/packages/type-storage/src/utils/createFunction.ts#L14)*
___
<a id="method"></a>
@@ -23,7 +23,7 @@ ___
**● method**: * `undefined` &#124; `string`
*
*Defined in [utils/createFunction.ts:15](https://github.com/polkadot-js/api/blob/69b05c7/packages/type-storage/src/utils/createFunction.ts#L15)*
*Defined in [utils/createFunction.ts:15](https://github.com/polkadot-js/api/blob/b52a86e/packages/type-storage/src/utils/createFunction.ts#L15)*
___
docs/type-storage/modules/_frommetadata_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **fromMetadata**(metadata: *`Metadata`*): [Storage](../interfaces/_types_.storage.md)
*Defined in [fromMetadata.ts:20](https://github.com/polkadot-js/api/blob/69b05c7/packages/type-storage/src/fromMetadata.ts#L20)*
*Defined in [fromMetadata.ts:20](https://github.com/polkadot-js/api/blob/b52a86e/packages/type-storage/src/fromMetadata.ts#L20)*
Extend a storage object with the storage modules & module functions present in the metadata.
docs/type-storage/modules/_storage_.md
+2 -2
View File
@@ -8,7 +8,7 @@
**storage**: *`object`*
*Defined in [storage.ts:8](https://github.com/polkadot-js/api/blob/69b05c7/packages/type-storage/src/storage.ts#L8)*
*Defined in [storage.ts:8](https://github.com/polkadot-js/api/blob/b52a86e/packages/type-storage/src/storage.ts#L8)*
<a id="storage.substrate"></a>
@@ -16,7 +16,7 @@
**● substrate**: *[&quot;substrate&quot;](_substrate_.md)*
*Defined in [storage.ts:9](https://github.com/polkadot-js/api/blob/69b05c7/packages/type-storage/src/storage.ts#L9)*
*Defined in [storage.ts:9](https://github.com/polkadot-js/api/blob/b52a86e/packages/type-storage/src/storage.ts#L9)*
___
docs/type-storage/modules/_substrate_.md
+6 -6
View File
@@ -11,7 +11,7 @@
type: 'u32'
})
*Defined in [substrate.ts:45](https://github.com/polkadot-js/api/blob/69b05c7/packages/type-storage/src/substrate.ts#L45)*
*Defined in [substrate.ts:45](https://github.com/polkadot-js/api/blob/b52a86e/packages/type-storage/src/substrate.ts#L45)*
___
<a id="authorityprefix"></a>
@@ -23,7 +23,7 @@ ___
type: 'u32'
})
*Defined in [substrate.ts:50](https://github.com/polkadot-js/api/blob/69b05c7/packages/type-storage/src/substrate.ts#L50)*
*Defined in [substrate.ts:50](https://github.com/polkadot-js/api/blob/b52a86e/packages/type-storage/src/substrate.ts#L50)*
___
<a id="changestrieconfig"></a>
@@ -35,7 +35,7 @@ ___
type: 'u32'
})
*Defined in [substrate.ts:60](https://github.com/polkadot-js/api/blob/69b05c7/packages/type-storage/src/substrate.ts#L60)*
*Defined in [substrate.ts:60](https://github.com/polkadot-js/api/blob/b52a86e/packages/type-storage/src/substrate.ts#L60)*
___
<a id="code"></a>
@@ -47,7 +47,7 @@ ___
type: 'Bytes'
})
*Defined in [substrate.ts:35](https://github.com/polkadot-js/api/blob/69b05c7/packages/type-storage/src/substrate.ts#L35)*
*Defined in [substrate.ts:35](https://github.com/polkadot-js/api/blob/b52a86e/packages/type-storage/src/substrate.ts#L35)*
___
<a id="extrinsicindex"></a>
@@ -59,7 +59,7 @@ ___
type: 'u32'
})
*Defined in [substrate.ts:55](https://github.com/polkadot-js/api/blob/69b05c7/packages/type-storage/src/substrate.ts#L55)*
*Defined in [substrate.ts:55](https://github.com/polkadot-js/api/blob/b52a86e/packages/type-storage/src/substrate.ts#L55)*
___
<a id="heappages"></a>
@@ -71,7 +71,7 @@ ___
type: 'u64'
})
*Defined in [substrate.ts:40](https://github.com/polkadot-js/api/blob/69b05c7/packages/type-storage/src/substrate.ts#L40)*
*Defined in [substrate.ts:40](https://github.com/polkadot-js/api/blob/b52a86e/packages/type-storage/src/substrate.ts#L40)*
___
docs/type-storage/modules/_utils_createfunction_.md
+1 -1
View File
@@ -20,7 +20,7 @@
▸ **createFunction**(section: *`Text`*, method: *`Text`*, meta: *`StorageFunctionMetadata`*, options?: *[CreateItemOptions](../interfaces/_utils_createfunction_.createitemoptions.md)*): `StorageFunction`
*Defined in [utils/createFunction.ts:28](https://github.com/polkadot-js/api/blob/69b05c7/packages/type-storage/src/utils/createFunction.ts#L28)*
*Defined in [utils/createFunction.ts:28](https://github.com/polkadot-js/api/blob/b52a86e/packages/type-storage/src/utils/createFunction.ts#L28)*
From the schema of a function in the module's storage, generate the function that will return the correct storage key.
docs/types/README.md
+1 -1
View File
@@ -7,7 +7,7 @@ Implementation of the types and their (de-)serialisation via [parity-codec](http
Substrate types
---------------
These types implement specific types that are found as part of the Substrate base: [AccountId](classes/_accountid_.accountid.md), [AccountIndex](classes/_accountindex_.accountindex.md), [Address](classes/_address_.address.md), [AuthorityId](classes/_authorityid_.authorityid.md), [Balance](classes/_balance_.balance.md), [Block](classes/_block_.block.md), [BlockNumber](classes/_blocknumber_.blocknumber.md), [Bool](classes/_bool_.bool.md), [Bytes](classes/_bytes_.bytes.md), [Data](classes/_data_.data.md), [Digest](classes/_digest_.digest.md), [Event](classes/_event_.event.md), [EventRecord](classes/_eventrecord_.eventrecord.md), [Extrinsic](classes/_extrinsic_.extrinsic.md), [Extrinsics](interfaces/_method_.extrinsics.md), [ExtrinsicEra](classes/_extrinsicera_.extrinsicera.md), [ExtrinsicSignature](classes/_extrinsicsignature_.extrinsicsignature.md), [ExtrinsicStatus](classes/_extrinsicstatus_.extrinsicstatus.md), [Gas](classes/_gas_.gas.md), [H256](classes/_h256_.h256.md), [H512](classes/_h512_.h512.md), [Hash](classes/_hash_.hash.md), [Header](classes/_header_.header.md), [Justification](classes/_justification_.justification.md), [KeyValue](classes/_keyvalue_.keyvalue.md), \[\[Metadata\]\], [Method](classes/_method_.method.md), [MisbehaviorReport](classes/_misbehaviorreport_.misbehaviorreport.md), [Moment](classes/_moment_.moment.md), [NewAccountOutcome](classes/_newaccountoutcome_.newaccountoutcome.md), [Nonce](classes/_nonce_.nonce.md), [Null](classes/_null_.null.md), [Origin](classes/_origin_.origin.md), [ParachainId](classes/_parachainid_.parachainid.md), [PendingExtrinsics](classes/_pendingextrinsics_.pendingextrinsics.md), [Perbill](classes/_perbill_.perbill.md), [Permill](classes/_permill_.permill.md), [PropIndex](classes/_propindex_.propindex.md), [Proposal](classes/_proposal_.proposal.md), [ProposalIndex](classes/_proposalindex_.proposalindex.md), [ReferendumIndex](classes/_referendumindex_.referendumindex.md), [RuntimeVersion](classes/_runtimeversion_.runtimeversion.md), [SessionKey](classes/_sessionkey_.sessionkey.md), [Signature](classes/_signature_.signature.md), [SignaturePayload](classes/_signaturepayload_.signaturepayload.md), [SignedBlock](classes/_signedblock_.signedblock.md), [StorageChangeSet](classes/_storagechangeset_.storagechangeset.md), [StorageData](classes/_storagedata_.storagedata.md), [StorageKey](classes/_storagekey_.storagekey.md), [StoredPendingChange](classes/_storedpendingchange_.storedpendingchange.md), [Text](classes/_text_.text.md), [Type](classes/_codec_struct_.struct.md#type), [U8](classes/_u8_.u8.md), [U16](classes/_u16_.u16.md), [U32](classes/_u32_.u32.md), [U64](classes/_u64_.u64.md), [U128](classes/_u128_.u128.md), [U256](classes/_u256_.u256.md), [ValidatorPrefs](classes/_validatorprefs_.validatorprefs.md), [VoteIndex](classes/_voteindex_.voteindex.md), [VoteThreshold](classes/_votethreshold_.votethreshold.md)
These types implement specific types that are found as part of the Substrate base: [AccountId](classes/_accountid_.accountid.md), [AccountIndex](classes/_accountindex_.accountindex.md), [Address](classes/_address_.address.md), [AuthorityId](classes/_authorityid_.authorityid.md), [Balance](classes/_balance_.balance.md), [Block](classes/_block_.block.md), [BlockNumber](classes/_blocknumber_.blocknumber.md), [Bool](classes/_bool_.bool.md), [Bytes](classes/_bytes_.bytes.md), [Data](classes/_data_.data.md), [Digest](classes/_digest_.digest.md), [Event](classes/_event_.event.md), [EventRecord](classes/_eventrecord_.eventrecord.md), [Extrinsic](classes/_extrinsic_.extrinsic.md), [Extrinsics](interfaces/_method_.extrinsics.md), [ExtrinsicEra](classes/_extrinsicera_.extrinsicera.md), [ExtrinsicSignature](classes/_extrinsicsignature_.extrinsicsignature.md), [ExtrinsicStatus](classes/_extrinsicstatus_.extrinsicstatus.md), [Gas](classes/_gas_.gas.md), [H256](classes/_h256_.h256.md), [H512](classes/_h512_.h512.md), [Hash](classes/_hash_.hash.md), [Header](classes/_header_.header.md), [Justification](classes/_justification_.justification.md), [KeyValue](classes/_keyvalue_.keyvalue.md), [Metadata](classes/_metadata_.metadata.md), [Method](classes/_method_.method.md), [MisbehaviorReport](classes/_misbehaviorreport_.misbehaviorreport.md), [Moment](classes/_moment_.moment.md), [NewAccountOutcome](classes/_newaccountoutcome_.newaccountoutcome.md), [Nonce](classes/_nonce_.nonce.md), [Null](classes/_null_.null.md), [Origin](classes/_origin_.origin.md), [ParachainId](classes/_parachainid_.parachainid.md), [PendingExtrinsics](classes/_pendingextrinsics_.pendingextrinsics.md), [Perbill](classes/_perbill_.perbill.md), [Permill](classes/_permill_.permill.md), [PropIndex](classes/_propindex_.propindex.md), [Proposal](classes/_proposal_.proposal.md), [ProposalIndex](classes/_proposalindex_.proposalindex.md), [ReferendumIndex](classes/_referendumindex_.referendumindex.md), [RuntimeVersion](classes/_runtimeversion_.runtimeversion.md), [SessionKey](classes/_sessionkey_.sessionkey.md), [Signature](classes/_signature_.signature.md), [SignaturePayload](classes/_signaturepayload_.signaturepayload.md), [SignedBlock](classes/_signedblock_.signedblock.md), [StorageChangeSet](classes/_storagechangeset_.storagechangeset.md), [StorageData](classes/_storagedata_.storagedata.md), [StorageKey](classes/_storagekey_.storagekey.md), [StoredPendingChange](classes/_storedpendingchange_.storedpendingchange.md), [Text](classes/_text_.text.md), [Type](classes/_codec_struct_.struct.md#type), [U8](classes/_u8_.u8.md), [U16](classes/_u16_.u16.md), [U32](classes/_u32_.u32.md), [U64](classes/_u64_.u64.md), [U128](classes/_u128_.u128.md), [U256](classes/_u256_.u256.md), [ValidatorPrefs](classes/_validatorprefs_.validatorprefs.md), [VoteIndex](classes/_voteindex_.voteindex.md), [VoteThreshold](classes/_votethreshold_.votethreshold.md)
Codec types
-----------
docs/types/SUMMARY.md
+1 -1
View File
@@ -85,12 +85,12 @@
* [EventMetadata](classes/_metadata_.eventmetadata.md)
* [FunctionArgumentMetadata](classes/_metadata_.functionargumentmetadata.md)
* [FunctionMetadata](classes/_metadata_.functionmetadata.md)
* [Metadata](classes/_metadata_.metadata.md)
* [ModuleMetadata](classes/_metadata_.modulemetadata.md)
* [OuterDispatchCall](classes/_metadata_.outerdispatchcall.md)
* [OuterDispatchMetadata](classes/_metadata_.outerdispatchmetadata.md)
* [OuterEventMetadata](classes/_metadata_.outereventmetadata.md)
* [OuterEventMetadataEvent](classes/_metadata_.outereventmetadataevent.md)
* [RuntimeMetadata](classes/_metadata_.runtimemetadata.md)
* [RuntimeModuleMetadata](classes/_metadata_.runtimemodulemetadata.md)
* [StorageFunctionMetadata](classes/_metadata_.storagefunctionmetadata.md)
* [StorageFunctionModifier](classes/_metadata_.storagefunctionmodifier.md)
docs/types/classes/_accountid_.accountid.html
+2925
View File
File diff suppressed because it is too large Load Diff
docs/types/classes/_accountid_.accountid.md
+10 -10
View File
@@ -29,7 +29,7 @@
*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)*
*Defined in [AccountId.ts:19](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/AccountId.ts#L19)*
*Defined in [AccountId.ts:19](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/AccountId.ts#L19)*
**Parameters:**
@@ -117,7 +117,7 @@ getencodedLength(): `number`
*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/U8a.ts#L36)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/U8a.ts#L36)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -134,7 +134,7 @@ getlength(): `number`
*Overrides Uint8Array.length*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/U8a.ts#L43)*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/U8a.ts#L43)*
*__description__*: The length of the value
@@ -165,7 +165,7 @@ ___
*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)*
*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/U8aFixed.ts#L39)*
*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/U8aFixed.ts#L39)*
*__description__*: Returns the number of bits in the value
@@ -691,7 +691,7 @@ ___
*Overrides Uint8Array.subarray*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/U8a.ts#L53)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/U8a.ts#L53)*
*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here
@@ -715,7 +715,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/U8a.ts#L60)*
*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/U8a.ts#L60)*
*__description__*: Returns a hex string representation of the value
@@ -732,7 +732,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
*Defined in [AccountId.ts:46](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/AccountId.ts#L46)*
*Defined in [AccountId.ts:46](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/AccountId.ts#L46)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -764,7 +764,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)*
*Defined in [AccountId.ts:53](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/AccountId.ts#L53)*
*Defined in [AccountId.ts:53](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/AccountId.ts#L53)*
*__description__*: Returns the string representation of the value
@@ -781,7 +781,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/U8a.ts#L82)*
*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/U8a.ts#L82)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -815,7 +815,7 @@ ___
▸ **encode**(value: *`Uint8Array`*): `string`
*Defined in [AccountId.ts:27](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/AccountId.ts#L27)*
*Defined in [AccountId.ts:27](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/AccountId.ts#L27)*
**Parameters:**
docs/types/classes/_accountindex_.accountindex.html
+4153
View File
File diff suppressed because it is too large Load Diff
docs/types/classes/_accountindex_.accountindex.md
+13 -13
View File
@@ -24,7 +24,7 @@
*Overrides [U32](_u32_.u32.md).[constructor](_u32_.u32.md#constructor)*
*Defined in [AccountIndex.ts:29](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/AccountIndex.ts#L29)*
*Defined in [AccountIndex.ts:29](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/AccountIndex.ts#L29)*
**Parameters:**
@@ -46,7 +46,7 @@ getencodedLength(): `number`
*Inherited from [UInt](_codec_uint_.uint.md).[encodedLength](_codec_uint_.uint.md#encodedlength)*
*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/UInt.ts#L57)*
*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/UInt.ts#L57)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -186,7 +186,7 @@ ___
*Overrides BN.bitLength*
*Defined in [codec/UInt.ts:64](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/UInt.ts#L64)*
*Defined in [codec/UInt.ts:64](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/UInt.ts#L64)*
*__description__*: Returns the number of bits in the value
@@ -1521,7 +1521,7 @@ ___
*Overrides [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)*
*Defined in [AccountIndex.ts:92](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/AccountIndex.ts#L92)*
*Defined in [AccountIndex.ts:92](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/AccountIndex.ts#L92)*
*__description__*: Returns the BN representation of the AccountIndex
@@ -1560,7 +1560,7 @@ ___
*Overrides [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)*
*Defined in [AccountIndex.ts:99](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/AccountIndex.ts#L99)*
*Defined in [AccountIndex.ts:99](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/AccountIndex.ts#L99)*
*__description__*: Returns a hex string representation of the value
@@ -1577,7 +1577,7 @@ ___
*Overrides [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)*
*Defined in [AccountIndex.ts:108](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/AccountIndex.ts#L108)*
*Defined in [AccountIndex.ts:108](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/AccountIndex.ts#L108)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -1630,7 +1630,7 @@ ___
*Overrides [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)*
*Defined in [AccountIndex.ts:115](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/AccountIndex.ts#L115)*
*Defined in [AccountIndex.ts:115](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/AccountIndex.ts#L115)*
*__description__*: Returns the string representation of the value
@@ -1668,7 +1668,7 @@ ___
*Overrides [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)*
*Defined in [AccountIndex.ts:125](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/AccountIndex.ts#L125)*
*Defined in [AccountIndex.ts:125](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/AccountIndex.ts#L125)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -1870,7 +1870,7 @@ ___
▸ **calcLength**(_value: * `BN` &#124; `number`*): `number`
*Defined in [AccountIndex.ts:52](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/AccountIndex.ts#L52)*
*Defined in [AccountIndex.ts:52](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/AccountIndex.ts#L52)*
**Parameters:**
@@ -1887,7 +1887,7 @@ ___
▸ **decodeAccountIndex**(value: *[AnyNumber](../modules/_types_.md#anynumber)*): `BN` &#124; `Uint8Array` &#124; `number` &#124; `string`
*Defined in [AccountIndex.ts:36](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/AccountIndex.ts#L36)*
*Defined in [AccountIndex.ts:36](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/AccountIndex.ts#L36)*
**Parameters:**
@@ -1906,7 +1906,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)*
*Defined in [codec/UInt.ts:38](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/UInt.ts#L38)*
*Defined in [codec/UInt.ts:38](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/UInt.ts#L38)*
**Parameters:**
@@ -2010,7 +2010,7 @@ ___
▸ **readLength**(input: *`Uint8Array`*): [`number`, `number`]
*Defined in [AccountIndex.ts:66](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/AccountIndex.ts#L66)*
*Defined in [AccountIndex.ts:66](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/AccountIndex.ts#L66)*
**Parameters:**
@@ -2048,7 +2048,7 @@ ___
▸ **writeLength**(input: *`Uint8Array`*): `Uint8Array`
*Defined in [AccountIndex.ts:80](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/AccountIndex.ts#L80)*
*Defined in [AccountIndex.ts:80](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/AccountIndex.ts#L80)*
**Parameters:**
docs/types/classes/_address_.address.html
+2152
View File
File diff suppressed because it is too large Load Diff
docs/types/classes/_address_.address.md
+8 -8
View File
@@ -20,7 +20,7 @@
*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)*
*Defined in [Address.ts:25](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Address.ts#L25)*
*Defined in [Address.ts:25](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Address.ts#L25)*
**Parameters:**
@@ -40,7 +40,7 @@ ___
getencodedLength(): `number`
*Defined in [Address.ts:67](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Address.ts#L67)*
*Defined in [Address.ts:67](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Address.ts#L67)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -53,7 +53,7 @@ ___
getrawLength(): `number`
*Defined in [Address.ts:81](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Address.ts#L81)*
*Defined in [Address.ts:81](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Address.ts#L81)*
*__description__*: The length of the raw value, either AccountIndex or AccountId
@@ -69,7 +69,7 @@ ___
▸ **toHex**(): `string`
*Defined in [Address.ts:90](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Address.ts#L90)*
*Defined in [Address.ts:90](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Address.ts#L90)*
*__description__*: Returns a hex string representation of the value
@@ -82,7 +82,7 @@ ___
▸ **toJSON**(): `any`
*Defined in [Address.ts:97](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Address.ts#L97)*
*Defined in [Address.ts:97](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Address.ts#L97)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -95,7 +95,7 @@ ___
▸ **toString**(): `string`
*Defined in [Address.ts:104](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Address.ts#L104)*
*Defined in [Address.ts:104](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Address.ts#L104)*
*__description__*: Returns the string representation of the value
@@ -108,7 +108,7 @@ ___
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Defined in [Address.ts:112](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Address.ts#L112)*
*Defined in [Address.ts:112](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Address.ts#L112)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -127,7 +127,7 @@ ___
▸ **decodeAddress**(value: *`AnyAddress`*): [AccountId](_accountid_.accountid.md) &#124; [AccountIndex](_accountindex_.accountindex.md)
*Defined in [Address.ts:32](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Address.ts#L32)*
*Defined in [Address.ts:32](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Address.ts#L32)*
**Parameters:**
docs/types/classes/_authorityid_.authorityid.html
+2927
View File
File diff suppressed because it is too large Load Diff
docs/types/classes/_authorityid_.authorityid.md
+10 -10
View File
@@ -27,7 +27,7 @@
*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)*
*Defined in [AccountId.ts:19](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/AccountId.ts#L19)*
*Defined in [AccountId.ts:19](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/AccountId.ts#L19)*
**Parameters:**
@@ -115,7 +115,7 @@ getencodedLength(): `number`
*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/U8a.ts#L36)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/U8a.ts#L36)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -132,7 +132,7 @@ getlength(): `number`
*Overrides Uint8Array.length*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/U8a.ts#L43)*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/U8a.ts#L43)*
*__description__*: The length of the value
@@ -163,7 +163,7 @@ ___
*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)*
*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/U8aFixed.ts#L39)*
*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/U8aFixed.ts#L39)*
*__description__*: Returns the number of bits in the value
@@ -689,7 +689,7 @@ ___
*Overrides Uint8Array.subarray*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/U8a.ts#L53)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/U8a.ts#L53)*
*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here
@@ -713,7 +713,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/U8a.ts#L60)*
*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/U8a.ts#L60)*
*__description__*: Returns a hex string representation of the value
@@ -732,7 +732,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
*Defined in [AccountId.ts:46](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/AccountId.ts#L46)*
*Defined in [AccountId.ts:46](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/AccountId.ts#L46)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -766,7 +766,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)*
*Defined in [AccountId.ts:53](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/AccountId.ts#L53)*
*Defined in [AccountId.ts:53](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/AccountId.ts#L53)*
*__description__*: Returns the string representation of the value
@@ -783,7 +783,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/U8a.ts#L82)*
*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/U8a.ts#L82)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -819,7 +819,7 @@ ___
*Inherited from [AccountId](_accountid_.accountid.md).[encode](_accountid_.accountid.md#encode)*
*Defined in [AccountId.ts:27](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/AccountId.ts#L27)*
*Defined in [AccountId.ts:27](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/AccountId.ts#L27)*
**Parameters:**
docs/types/classes/_balance_.balance.html
+4086
View File
File diff suppressed because it is too large Load Diff
docs/types/classes/_balance_.balance.md
+9 -9
View File
@@ -26,7 +26,7 @@
*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)*
*Defined in [U128.ts:14](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/U128.ts#L14)*
*Defined in [U128.ts:14](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/U128.ts#L14)*
**Parameters:**
@@ -48,7 +48,7 @@ getencodedLength(): `number`
*Inherited from [UInt](_codec_uint_.uint.md).[encodedLength](_codec_uint_.uint.md#encodedlength)*
*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/UInt.ts#L57)*
*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/UInt.ts#L57)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -188,7 +188,7 @@ ___
*Overrides BN.bitLength*
*Defined in [codec/UInt.ts:64](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/UInt.ts#L64)*
*Defined in [codec/UInt.ts:64](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/UInt.ts#L64)*
*__description__*: Returns the number of bits in the value
@@ -1523,7 +1523,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)*
*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/UInt.ts#L71)*
*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/UInt.ts#L71)*
*__description__*: Returns the BN representation of the number. (Compatibility)
@@ -1562,7 +1562,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)*
*Defined in [codec/UInt.ts:78](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/UInt.ts#L78)*
*Defined in [codec/UInt.ts:78](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/UInt.ts#L78)*
*__description__*: Returns a hex string representation of the value
@@ -1581,7 +1581,7 @@ ___
*Overrides BN.toJSON*
*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/UInt.ts#L85)*
*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/UInt.ts#L85)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -1634,7 +1634,7 @@ ___
*Overrides BN.toString*
*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/UInt.ts#L95)*
*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/UInt.ts#L95)*
*__description__*: Returns the string representation of the value
@@ -1678,7 +1678,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)*
*Defined in [codec/UInt.ts:104](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/UInt.ts#L104)*
*Defined in [codec/UInt.ts:104](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/UInt.ts#L104)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -1882,7 +1882,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)*
*Defined in [codec/UInt.ts:38](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/UInt.ts#L38)*
*Defined in [codec/UInt.ts:38](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/UInt.ts#L38)*
**Parameters:**
docs/types/classes/_bft_.bftauthoritysignature.html
+3350
View File
File diff suppressed because it is too large Load Diff
docs/types/classes/_bft_.bftauthoritysignature.md
+13 -13
View File
@@ -29,7 +29,7 @@
*Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)*
*Defined in [Bft.ts:20](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Bft.ts#L20)*
*Defined in [Bft.ts:20](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Bft.ts#L20)*
**Parameters:**
@@ -67,7 +67,7 @@ getTypes(): `Array`<`string`>
*Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)*
*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Tuple.ts#L75)*
*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Tuple.ts#L75)*
*__description__*: The types definition of the tuple
@@ -80,7 +80,7 @@ ___
getauthorityId(): [AuthorityId](_authorityid_.authorityid.md)
*Defined in [Bft.ts:31](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Bft.ts#L31)*
*Defined in [Bft.ts:31](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Bft.ts#L31)*
*__description__*: The wrapped \[\[AuthoriyId\]\]
@@ -95,7 +95,7 @@ getencodedLength(): `number`
*Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)*
*Defined in [codec/Tuple.ts:66](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Tuple.ts#L66)*
*Defined in [codec/Tuple.ts:66](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Tuple.ts#L66)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -108,7 +108,7 @@ ___
getsignature(): [Signature](_signature_.signature.md)
*Defined in [Bft.ts:38](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Bft.ts#L38)*
*Defined in [Bft.ts:38](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Bft.ts#L38)*
*__description__*: The wrapped [Signature](_signature_.signature.md) value
@@ -278,7 +278,7 @@ ___
*Overrides Array.filter*
*Defined in [codec/Tuple.ts:131](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Tuple.ts#L131)*
*Defined in [codec/Tuple.ts:131](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Tuple.ts#L131)*
*__description__*: Filters the array with the callback
@@ -698,7 +698,7 @@ ___
*Overrides Array.map*
*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Tuple.ts#L140)*
*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Tuple.ts#L140)*
*__description__*: Maps the array with the callback
@@ -1006,7 +1006,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)*
*Defined in [codec/Tuple.ts:82](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Tuple.ts#L82)*
*Defined in [codec/Tuple.ts:82](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Tuple.ts#L82)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -1023,7 +1023,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)*
*Defined in [codec/Tuple.ts:89](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Tuple.ts#L89)*
*Defined in [codec/Tuple.ts:89](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Tuple.ts#L89)*
*__description__*: Returns a hex string representation of the value
@@ -1040,7 +1040,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)*
*Defined in [codec/Tuple.ts:96](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Tuple.ts#L96)*
*Defined in [codec/Tuple.ts:96](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Tuple.ts#L96)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -1074,7 +1074,7 @@ ___
*Overrides Array.toString*
*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Tuple.ts#L105)*
*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Tuple.ts#L105)*
*__description__*: Returns the string representation of the value
@@ -1091,7 +1091,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)*
*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Tuple.ts#L114)*
*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Tuple.ts#L114)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -1148,7 +1148,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)*
*Defined in [codec/Tuple.ts:53](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Tuple.ts#L53)*
*Defined in [codec/Tuple.ts:53](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Tuple.ts#L53)*
**Type parameters:**
docs/types/classes/_bft_.bfthashsignature.html
+3350
View File
File diff suppressed because it is too large Load Diff
docs/types/classes/_bft_.bfthashsignature.md
+13 -13
View File
@@ -29,7 +29,7 @@
*Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)*
*Defined in [Bft.ts:51](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Bft.ts#L51)*
*Defined in [Bft.ts:51](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Bft.ts#L51)*
**Parameters:**
@@ -67,7 +67,7 @@ getTypes(): `Array`<`string`>
*Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)*
*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Tuple.ts#L75)*
*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Tuple.ts#L75)*
*__description__*: The types definition of the tuple
@@ -82,7 +82,7 @@ getencodedLength(): `number`
*Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)*
*Defined in [codec/Tuple.ts:66](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Tuple.ts#L66)*
*Defined in [codec/Tuple.ts:66](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Tuple.ts#L66)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -95,7 +95,7 @@ ___
gethash(): [Hash](_hash_.hash.md)
*Defined in [Bft.ts:62](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Bft.ts#L62)*
*Defined in [Bft.ts:62](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Bft.ts#L62)*
*__description__*: The wrapped [Hash](_hash_.hash.md)
@@ -108,7 +108,7 @@ ___
getsignature(): [Signature](_signature_.signature.md)
*Defined in [Bft.ts:69](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Bft.ts#L69)*
*Defined in [Bft.ts:69](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Bft.ts#L69)*
*__description__*: The wrapped [Signature](_signature_.signature.md)
@@ -278,7 +278,7 @@ ___
*Overrides Array.filter*
*Defined in [codec/Tuple.ts:131](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Tuple.ts#L131)*
*Defined in [codec/Tuple.ts:131](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Tuple.ts#L131)*
*__description__*: Filters the array with the callback
@@ -698,7 +698,7 @@ ___
*Overrides Array.map*
*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Tuple.ts#L140)*
*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Tuple.ts#L140)*
*__description__*: Maps the array with the callback
@@ -1006,7 +1006,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)*
*Defined in [codec/Tuple.ts:82](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Tuple.ts#L82)*
*Defined in [codec/Tuple.ts:82](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Tuple.ts#L82)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -1023,7 +1023,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)*
*Defined in [codec/Tuple.ts:89](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Tuple.ts#L89)*
*Defined in [codec/Tuple.ts:89](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Tuple.ts#L89)*
*__description__*: Returns a hex string representation of the value
@@ -1040,7 +1040,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)*
*Defined in [codec/Tuple.ts:96](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Tuple.ts#L96)*
*Defined in [codec/Tuple.ts:96](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Tuple.ts#L96)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -1074,7 +1074,7 @@ ___
*Overrides Array.toString*
*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Tuple.ts#L105)*
*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Tuple.ts#L105)*
*__description__*: Returns the string representation of the value
@@ -1091,7 +1091,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)*
*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Tuple.ts#L114)*
*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Tuple.ts#L114)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -1148,7 +1148,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)*
*Defined in [codec/Tuple.ts:53](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Tuple.ts#L53)*
*Defined in [codec/Tuple.ts:53](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Tuple.ts#L53)*
**Type parameters:**
docs/types/classes/_block_.block.html
+2398
View File
File diff suppressed because it is too large Load Diff
docs/types/classes/_block_.block.md
+14 -14
View File
@@ -29,7 +29,7 @@
*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)*
*Defined in [Block.ts:24](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Block.ts#L24)*
*Defined in [Block.ts:24](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Block.ts#L24)*
**Parameters:**
@@ -76,7 +76,7 @@ getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L133)*
*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L133)*
*__description__*: Returns the Type description to sthe structure
@@ -91,7 +91,7 @@ getencodedLength(): `number`
*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)*
*Defined in [codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L140)*
*Defined in [codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L140)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -104,7 +104,7 @@ ___
getextrinsics(): [Extrinsics](_extrinsics_.extrinsics.md)
*Defined in [Block.ts:35](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Block.ts#L35)*
*Defined in [Block.ts:35](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Block.ts#L35)*
*__description__*: The [Extrinsics](../interfaces/_method_.extrinsics.md) conatined in the block
@@ -117,7 +117,7 @@ ___
gethash(): [Hash](_hash_.hash.md)
*Defined in [Block.ts:42](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Block.ts#L42)*
*Defined in [Block.ts:42](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Block.ts#L42)*
*__description__*: Coinvenience getter, encoded the [Hash](_hash_.hash.md) for the block
@@ -130,7 +130,7 @@ ___
getheader(): [Header](_header_.header.md)
*Defined in [Block.ts:51](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Block.ts#L51)*
*Defined in [Block.ts:51](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Block.ts#L51)*
*__description__*: The [Header](_header_.header.md) in the block
@@ -232,7 +232,7 @@ ___
*Overrides Map.get*
*Defined in [codec/Struct.ts:150](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L150)*
*Defined in [codec/Struct.ts:150](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L150)*
*__description__*: Returns a specific names entry in the structure
@@ -253,7 +253,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)*
*Defined in [codec/Struct.ts:157](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L157)*
*Defined in [codec/Struct.ts:157](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L157)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
@@ -328,7 +328,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)*
*Defined in [codec/Struct.ts:164](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L164)*
*Defined in [codec/Struct.ts:164](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L164)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -345,7 +345,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)*
*Defined in [codec/Struct.ts:171](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L171)*
*Defined in [codec/Struct.ts:171](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L171)*
*__description__*: Returns a hex string representation of the value
@@ -362,7 +362,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
*Defined in [codec/Struct.ts:178](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L178)*
*Defined in [codec/Struct.ts:178](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L178)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -379,7 +379,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)*
*Defined in [codec/Struct.ts:192](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L192)*
*Defined in [codec/Struct.ts:192](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L192)*
*__description__*: Returns the string representation of the value
@@ -396,7 +396,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
*Defined in [codec/Struct.ts:200](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L200)*
*Defined in [codec/Struct.ts:200](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L200)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -432,7 +432,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Struct.ts#L113)*
*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Struct.ts#L113)*
**Type parameters:**
docs/types/classes/_blocknumber_.blocknumber.html
+4086
View File
File diff suppressed because it is too large Load Diff
docs/types/classes/_blocknumber_.blocknumber.md
+9 -9
View File
@@ -26,7 +26,7 @@
*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)*
*Defined in [U64.ts:14](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/U64.ts#L14)*
*Defined in [U64.ts:14](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/U64.ts#L14)*
**Parameters:**
@@ -48,7 +48,7 @@ getencodedLength(): `number`
*Inherited from [UInt](_codec_uint_.uint.md).[encodedLength](_codec_uint_.uint.md#encodedlength)*
*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/UInt.ts#L57)*
*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/UInt.ts#L57)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -188,7 +188,7 @@ ___
*Overrides BN.bitLength*
*Defined in [codec/UInt.ts:64](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/UInt.ts#L64)*
*Defined in [codec/UInt.ts:64](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/UInt.ts#L64)*
*__description__*: Returns the number of bits in the value
@@ -1523,7 +1523,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)*
*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/UInt.ts#L71)*
*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/UInt.ts#L71)*
*__description__*: Returns the BN representation of the number. (Compatibility)
@@ -1562,7 +1562,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)*
*Defined in [codec/UInt.ts:78](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/UInt.ts#L78)*
*Defined in [codec/UInt.ts:78](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/UInt.ts#L78)*
*__description__*: Returns a hex string representation of the value
@@ -1581,7 +1581,7 @@ ___
*Overrides BN.toJSON*
*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/UInt.ts#L85)*
*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/UInt.ts#L85)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -1634,7 +1634,7 @@ ___
*Overrides BN.toString*
*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/UInt.ts#L95)*
*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/UInt.ts#L95)*
*__description__*: Returns the string representation of the value
@@ -1678,7 +1678,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)*
*Defined in [codec/UInt.ts:104](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/UInt.ts#L104)*
*Defined in [codec/UInt.ts:104](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/UInt.ts#L104)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -1882,7 +1882,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)*
*Defined in [codec/UInt.ts:38](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/UInt.ts#L38)*
*Defined in [codec/UInt.ts:38](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/UInt.ts#L38)*
**Parameters:**
docs/types/classes/_bool_.bool.html
+2137
View File
File diff suppressed because it is too large Load Diff
docs/types/classes/_bool_.bool.md
+6 -6
View File
@@ -22,7 +22,7 @@
⊕ **new Bool**(value?: * [Bool](_bool_.bool.md) &#124; `Boolean` &#124; `Uint8Array` &#124; `boolean` &#124; `number`*): [Bool](_bool_.bool.md)
*Defined in [Bool.ts:15](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Bool.ts#L15)*
*Defined in [Bool.ts:15](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Bool.ts#L15)*
**Parameters:**
@@ -54,7 +54,7 @@ ___
getencodedLength(): `number`
*Defined in [Bool.ts:35](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Bool.ts#L35)*
*Defined in [Bool.ts:35](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Bool.ts#L35)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -72,7 +72,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)*
*Defined in [Bool.ts:42](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Bool.ts#L42)*
*Defined in [Bool.ts:42](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Bool.ts#L42)*
*__description__*: Returns a hex string representation of the value
@@ -87,7 +87,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)*
*Defined in [Bool.ts:49](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Bool.ts#L49)*
*Defined in [Bool.ts:49](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Bool.ts#L49)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -102,7 +102,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)*
*Defined in [Bool.ts:56](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Bool.ts#L56)*
*Defined in [Bool.ts:56](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Bool.ts#L56)*
*__description__*: Returns the string representation of the value
@@ -117,7 +117,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)*
*Defined in [Bool.ts:64](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Bool.ts#L64)*
*Defined in [Bool.ts:64](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Bool.ts#L64)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
docs/types/classes/_bytes_.bytes.html
+2898
View File
File diff suppressed because it is too large Load Diff
docs/types/classes/_bytes_.bytes.md
+8 -8
View File
@@ -35,7 +35,7 @@
*Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)*
*Defined in [Bytes.ts:18](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Bytes.ts#L18)*
*Defined in [Bytes.ts:18](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Bytes.ts#L18)*
**Parameters:**
@@ -123,7 +123,7 @@ getencodedLength(): `number`
*Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)*
*Defined in [Bytes.ts:64](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Bytes.ts#L64)*
*Defined in [Bytes.ts:64](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Bytes.ts#L64)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -140,7 +140,7 @@ getlength(): `number`
*Overrides Uint8Array.length*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/U8a.ts#L43)*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/U8a.ts#L43)*
*__description__*: The length of the value
@@ -682,7 +682,7 @@ ___
*Overrides Uint8Array.subarray*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/U8a.ts#L53)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/U8a.ts#L53)*
*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here
@@ -706,7 +706,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/U8a.ts#L60)*
*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/U8a.ts#L60)*
*__description__*: Returns a hex string representation of the value
@@ -723,7 +723,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/U8a.ts#L67)*
*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/U8a.ts#L67)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -757,7 +757,7 @@ ___
*Overrides Uint8Array.toString*
*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/U8a.ts#L74)*
*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/U8a.ts#L74)*
*__description__*: Returns the string representation of the value
@@ -774,7 +774,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
*Defined in [Bytes.ts:72](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/Bytes.ts#L72)*
*Defined in [Bytes.ts:72](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/Bytes.ts#L72)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
docs/types/classes/_codec_base_.base.html
+2074
View File
File diff suppressed because it is too large Load Diff
docs/types/classes/_codec_base_.base.md
+1 -1
View File
@@ -30,7 +30,7 @@
⊕ **new Base**(value?: *`any`*): [Base](_codec_base_.base.md)
*Defined in [codec/Base.ts:10](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Base.ts#L10)*
*Defined in [codec/Base.ts:10](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Base.ts#L10)*
**Parameters:**
docs/types/classes/_codec_compact_.compact.html
+2250
View File
File diff suppressed because it is too large Load Diff
docs/types/classes/_codec_compact_.compact.md
+15 -15
View File
@@ -24,7 +24,7 @@
*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)*
*Defined in [codec/Compact.ts:22](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Compact.ts#L22)*
*Defined in [codec/Compact.ts:22](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Compact.ts#L22)*
**Parameters:**
@@ -45,7 +45,7 @@ ___
**● addLengthPrefix**: *`compactAddLength`* = compactAddLength
*Defined in [codec/Compact.ts:40](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Compact.ts#L40)*
*Defined in [codec/Compact.ts:40](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Compact.ts#L40)*
Prepend a Uint8Array with its compact length.
*__param__*: The Uint8Array to be prefixed
@@ -57,7 +57,7 @@ ___
**● decodeU8a**: *`compactFromU8a`* = compactFromU8a
*Defined in [codec/Compact.ts:41](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Compact.ts#L41)*
*Defined in [codec/Compact.ts:41](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Compact.ts#L41)*
___
<a id="encodeu8a"></a>
@@ -66,7 +66,7 @@ ___
**● encodeU8a**: *`compactToU8a`* = compactToU8a
*Defined in [codec/Compact.ts:42](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Compact.ts#L42)*
*Defined in [codec/Compact.ts:42](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Compact.ts#L42)*
___
@@ -78,7 +78,7 @@ ___
getencodedLength(): `number`
*Defined in [codec/Compact.ts:71](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Compact.ts#L71)*
*Defined in [codec/Compact.ts:71](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Compact.ts#L71)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -94,7 +94,7 @@ ___
▸ **bitLength**(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength)
*Defined in [codec/Compact.ts:78](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Compact.ts#L78)*
*Defined in [codec/Compact.ts:78](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Compact.ts#L78)*
*__description__*: Returns the number of bits in the value
@@ -107,7 +107,7 @@ ___
▸ **toBn**(): `BN`
*Defined in [codec/Compact.ts:85](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Compact.ts#L85)*
*Defined in [codec/Compact.ts:85](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Compact.ts#L85)*
*__description__*: Returns the BN representation of the number
@@ -122,7 +122,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)*
*Defined in [codec/Compact.ts:92](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Compact.ts#L92)*
*Defined in [codec/Compact.ts:92](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Compact.ts#L92)*
*__description__*: Returns a hex string representation of the value
@@ -137,7 +137,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)*
*Defined in [codec/Compact.ts:99](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Compact.ts#L99)*
*Defined in [codec/Compact.ts:99](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Compact.ts#L99)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -150,7 +150,7 @@ ___
▸ **toNumber**(): `number`
*Defined in [codec/Compact.ts:106](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Compact.ts#L106)*
*Defined in [codec/Compact.ts:106](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Compact.ts#L106)*
*__description__*: Returns the number representation for the value
@@ -165,7 +165,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)*
*Defined in [codec/Compact.ts:113](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Compact.ts#L113)*
*Defined in [codec/Compact.ts:113](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Compact.ts#L113)*
*__description__*: Returns the string representation of the value
@@ -180,7 +180,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)*
*Defined in [codec/Compact.ts:121](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Compact.ts#L121)*
*Defined in [codec/Compact.ts:121](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Compact.ts#L121)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -199,7 +199,7 @@ ___
▸ **decodeCompact**(Type: *[Constructor](../modules/_types_.md#constructor)< [UInt](_codec_uint_.uint.md) &#124; [Moment](_moment_.moment.md)>*, value: *[AnyNumber](../modules/_types_.md#anynumber)*): [Moment](_moment_.moment.md) &#124; [UInt](_codec_uint_.uint.md)
*Defined in [codec/Compact.ts:50](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Compact.ts#L50)*
*Defined in [codec/Compact.ts:50](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Compact.ts#L50)*
**Parameters:**
@@ -217,7 +217,7 @@ ___
▸ **stripLengthPrefix**(u8a: *`Uint8Array`*, bitLength?: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `Uint8Array`
*Defined in [codec/Compact.ts:44](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Compact.ts#L44)*
*Defined in [codec/Compact.ts:44](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Compact.ts#L44)*
**Parameters:**
@@ -235,7 +235,7 @@ ___
▸ **with**(Type: *[Constructor](../modules/_types_.md#constructor)< [UInt](_codec_uint_.uint.md) &#124; [Moment](_moment_.moment.md)>*): [Constructor](../modules/_types_.md#constructor)<[Compact](_codec_compact_.compact.md)>
*Defined in [codec/Compact.ts:27](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Compact.ts#L27)*
*Defined in [codec/Compact.ts:27](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Compact.ts#L27)*
**Parameters:**
docs/types/classes/_codec_enum_.enum.html
+2170
View File
File diff suppressed because it is too large Load Diff
docs/types/classes/_codec_enum_.enum.md
+8 -8
View File
@@ -30,7 +30,7 @@
*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)*
*Defined in [codec/Enum.ts:25](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Enum.ts#L25)*
*Defined in [codec/Enum.ts:25](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Enum.ts#L25)*
**Parameters:**
@@ -51,7 +51,7 @@ ___
getencodedLength(): `number`
*Defined in [codec/Enum.ts:48](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Enum.ts#L48)*
*Defined in [codec/Enum.ts:48](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Enum.ts#L48)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -69,7 +69,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)*
*Defined in [codec/Enum.ts:55](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Enum.ts#L55)*
*Defined in [codec/Enum.ts:55](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Enum.ts#L55)*
*__description__*: Returns a hex string representation of the value
@@ -84,7 +84,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)*
*Defined in [codec/Enum.ts:62](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Enum.ts#L62)*
*Defined in [codec/Enum.ts:62](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Enum.ts#L62)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -97,7 +97,7 @@ ___
▸ **toNumber**(): `number`
*Defined in [codec/Enum.ts:69](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Enum.ts#L69)*
*Defined in [codec/Enum.ts:69](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Enum.ts#L69)*
*__description__*: Returns the number representation for the value
@@ -112,7 +112,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)*
*Defined in [codec/Enum.ts:76](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Enum.ts#L76)*
*Defined in [codec/Enum.ts:76](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Enum.ts#L76)*
*__description__*: Returns the string representation of the value
@@ -127,7 +127,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)*
*Defined in [codec/Enum.ts:84](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Enum.ts#L84)*
*Defined in [codec/Enum.ts:84](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Enum.ts#L84)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -146,7 +146,7 @@ ___
▸ **decodeEnum**(value?: * [Enum](_codec_enum_.enum.md) &#124; `Uint8Array` &#124; `number`*): `number`
*Defined in [codec/Enum.ts:35](https://github.com/polkadot-js/api/blob/69b05c7/packages/types/src/codec/Enum.ts#L35)*
*Defined in [codec/Enum.ts:35](https://github.com/polkadot-js/api/blob/b52a86e/packages/types/src/codec/Enum.ts#L35)*
**Parameters:**

Some files were not shown because too many files have changed in this diff Show More