diff --git a/docs/GLOSSARY.html b/docs/GLOSSARY.html index 35b9776726..f0a605326f 100644 --- a/docs/GLOSSARY.html +++ b/docs/GLOSSARY.html @@ -402,7 +402,7 @@ diff --git a/docs/api-observable/classes/_base_.apibase.md b/docs/api-observable/classes/_base_.apibase.md index 9c41bf6864..1f611b93d4 100644 --- a/docs/api-observable/classes/_base_.apibase.md +++ b/docs/api-observable/classes/_base_.apibase.md @@ -14,7 +14,7 @@ ⊕ **new ApiBase**(api: *`RxApiInterface`*): [ApiBase](_base_.apibase.md) -*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L22)* +*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L22)* **Parameters:** @@ -34,7 +34,7 @@ ___ **● api**: *`RxApiInterface`* -*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L22)* +*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L22)* ___ @@ -46,7 +46,7 @@ ___ ▸ **combine**<`T`,`R`>(observables: *`Array`<`Observable`<`any`>>*, mapfn?: *`MapFn`<`R`, `T`>*): `Observable`<`T`> -*Defined in [Base.ts:28](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L28)* +*Defined in [Base.ts:28](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L28)* **Type parameters:** @@ -68,7 +68,7 @@ ___ ▸ **isConnected**(): `Observable`<`boolean`> -*Defined in [Base.ts:36](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L36)* +*Defined in [Base.ts:36](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L36)* **Returns:** `Observable`<`boolean`> @@ -79,7 +79,7 @@ ___ ▸ **rawCall**<`T`>(__namedParameters: *`object`*, ...params: *`Array`<`any`>*): `Observable`<`T`> -*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L40)* +*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L40)* **Type parameters:** @@ -100,7 +100,7 @@ ___ ▸ **rawStorage**<`T`>(key: *`StorageFunction`*, ...params: *`Array`<`any`>*): `Observable`<`T`> -*Defined in [Base.ts:52](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L52)* +*Defined in [Base.ts:52](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L52)* **Type parameters:** @@ -121,7 +121,7 @@ ___ ▸ **rawStorageMulti**<`T`>(...keys: *`Array`< [`StorageFunction`] | [`StorageFunction`, `any`]>*): `Observable`<`T`> -*Defined in [Base.ts:63](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L63)* +*Defined in [Base.ts:63](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L63)* **Type parameters:** diff --git a/docs/api-observable/classes/_calls_.apicalls.md b/docs/api-observable/classes/_calls_.apicalls.md index bec4b45078..06f2dfe55c 100644 --- a/docs/api-observable/classes/_calls_.apicalls.md +++ b/docs/api-observable/classes/_calls_.apicalls.md @@ -18,7 +18,7 @@ *Inherited from [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)* -*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L22)* +*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L22)* **Parameters:** @@ -40,7 +40,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[api](_base_.apibase.md#api)* -*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L22)* +*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L22)* ___ @@ -52,7 +52,7 @@ ___ ▸ **bestNumber**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Calls.ts#L13)* +*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Calls.ts#L13)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -63,7 +63,7 @@ ___ ▸ **chainGetBlock**(hash: *`Uint8Array`*): `Observable`< `SignedBlock` | `undefined`> -*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Calls.ts#L25)* +*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Calls.ts#L25)* **Parameters:** @@ -80,7 +80,7 @@ ___ ▸ **chainNewHead**(): `Observable`< `Header` | `undefined`> -*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Calls.ts#L29)* +*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Calls.ts#L29)* **Returns:** `Observable`< `Header` | `undefined`> @@ -93,7 +93,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[combine](_base_.apibase.md#combine)* -*Defined in [Base.ts:28](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L28)* +*Defined in [Base.ts:28](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L28)* **Type parameters:** @@ -117,7 +117,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democacyVoteOf](_queries_.apiqueries.md#democacyvoteof)* -*Defined in [Queries.ts:76](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L76)* +*Defined in [Queries.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L76)* **Parameters:** @@ -137,7 +137,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democacyVotersFor](_queries_.apiqueries.md#democacyvotersfor)* -*Defined in [Queries.ts:80](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L80)* +*Defined in [Queries.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L80)* **Parameters:** @@ -156,7 +156,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyLaunchPeriod](_queries_.apiqueries.md#democracylaunchperiod)* -*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L19)* +*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L19)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -169,7 +169,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyNextTally](_queries_.apiqueries.md#democracynexttally)* -*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L23)* +*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L23)* **Returns:** `Observable`< `ReferendumIndex` | `undefined`> @@ -182,7 +182,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyProposalDeposits](_queries_.apiqueries.md#democracyproposaldeposits)* -*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L27)* +*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L27)* **Parameters:** @@ -201,7 +201,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyPublicProposals](_queries_.apiqueries.md#democracypublicproposals)* -*Defined in [Queries.ts:40](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L40)* +*Defined in [Queries.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L40)* **Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>> @@ -214,7 +214,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyReferendumCount](_queries_.apiqueries.md#democracyreferendumcount)* -*Defined in [Queries.ts:59](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L59)* +*Defined in [Queries.ts:59](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L59)* **Returns:** `Observable`< `ReferendumIndex` | `undefined`> @@ -227,7 +227,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyReferendumInfoOf](_queries_.apiqueries.md#democracyreferenduminfoof)* -*Defined in [Queries.ts:63](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L63)* +*Defined in [Queries.ts:63](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L63)* **Parameters:** @@ -246,7 +246,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyVotingPeriod](_queries_.apiqueries.md#democracyvotingperiod)* -*Defined in [Queries.ts:91](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L91)* +*Defined in [Queries.ts:91](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L91)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -259,7 +259,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[eraLastLengthChange](_queries_.apiqueries.md#eralastlengthchange)* -*Defined in [Queries.ts:116](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L116)* +*Defined in [Queries.ts:116](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L116)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -272,7 +272,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[fees](_queries_.apiqueries.md#fees)* -*Defined in [Queries.ts:95](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L95)* +*Defined in [Queries.ts:95](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L95)* **Returns:** `Observable`<[RxFees](../modules/_types_d_.md#rxfees)> @@ -285,7 +285,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[isConnected](_base_.apibase.md#isconnected)* -*Defined in [Base.ts:36](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L36)* +*Defined in [Base.ts:36](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L36)* **Returns:** `Observable`<`boolean`> @@ -298,7 +298,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)* -*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L40)* +*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L40)* **Type parameters:** @@ -321,7 +321,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)* -*Defined in [Base.ts:52](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L52)* +*Defined in [Base.ts:52](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L52)* **Type parameters:** @@ -344,7 +344,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)* -*Defined in [Base.ts:63](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L63)* +*Defined in [Base.ts:63](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L63)* **Type parameters:** @@ -366,7 +366,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentIndex](_queries_.apiqueries.md#sessioncurrentindex)* -*Defined in [Queries.ts:128](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L128)* +*Defined in [Queries.ts:128](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L128)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -379,7 +379,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentStart](_queries_.apiqueries.md#sessioncurrentstart)* -*Defined in [Queries.ts:132](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L132)* +*Defined in [Queries.ts:132](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L132)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -392,7 +392,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLastLengthChange](_queries_.apiqueries.md#sessionlastlengthchange)* -*Defined in [Queries.ts:136](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L136)* +*Defined in [Queries.ts:136](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L136)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -405,7 +405,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLength](_queries_.apiqueries.md#sessionlength)* -*Defined in [Queries.ts:140](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L140)* +*Defined in [Queries.ts:140](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L140)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -418,7 +418,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionReward](_queries_.apiqueries.md#sessionreward)* -*Defined in [Queries.ts:120](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L120)* +*Defined in [Queries.ts:120](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L120)* **Returns:** `Observable`< `Perbill` | `undefined`> @@ -431,7 +431,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionRewardCurrent](_queries_.apiqueries.md#sessionrewardcurrent)* -*Defined in [Queries.ts:124](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L124)* +*Defined in [Queries.ts:124](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L124)* **Returns:** `Observable`< `Balance` | `undefined`> @@ -444,7 +444,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionValidators](_queries_.apiqueries.md#sessionvalidators)* -*Defined in [Queries.ts:148](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L148)* +*Defined in [Queries.ts:148](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L148)* **Returns:** `Observable`<`Array`<`AccountId`>> @@ -457,7 +457,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionsPerEra](_queries_.apiqueries.md#sessionsperera)* -*Defined in [Queries.ts:144](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L144)* +*Defined in [Queries.ts:144](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L144)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -470,7 +470,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingFreeBalanceOf](_queries_.apiqueries.md#stakingfreebalanceof)* -*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L171)* +*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L171)* **Parameters:** @@ -489,7 +489,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingIntentions](_queries_.apiqueries.md#stakingintentions)* -*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L159)* +*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L159)* **Returns:** `Observable`<`Array`<`AccountId`>> @@ -502,7 +502,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominating](_queries_.apiqueries.md#stakingnominating)* -*Defined in [Queries.ts:186](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L186)* +*Defined in [Queries.ts:186](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L186)* **Parameters:** @@ -521,7 +521,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominatorsFor](_queries_.apiqueries.md#stakingnominatorsfor)* -*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L175)* +*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L175)* **Parameters:** @@ -540,7 +540,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingReservedBalanceOf](_queries_.apiqueries.md#stakingreservedbalanceof)* -*Defined in [Queries.ts:191](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L191)* +*Defined in [Queries.ts:191](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L191)* **Parameters:** @@ -559,7 +559,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[systemAccountIndexOf](_queries_.apiqueries.md#systemaccountindexof)* -*Defined in [Queries.ts:203](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L203)* +*Defined in [Queries.ts:203](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L203)* **Parameters:** @@ -578,7 +578,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[timestampBlockPeriod](_queries_.apiqueries.md#timestampblockperiod)* -*Defined in [Queries.ts:195](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L195)* +*Defined in [Queries.ts:195](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L195)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -591,7 +591,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[timestampNow](_queries_.apiqueries.md#timestampnow)* -*Defined in [Queries.ts:199](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L199)* +*Defined in [Queries.ts:199](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L199)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -604,7 +604,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[validatorCount](_queries_.apiqueries.md#validatorcount)* -*Defined in [Queries.ts:207](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L207)* +*Defined in [Queries.ts:207](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L207)* **Returns:** `Observable`<`u32`> diff --git a/docs/api-observable/classes/_classes_.rxproposal.md b/docs/api-observable/classes/_classes_.rxproposal.md index 93f1f754c0..234d68afe3 100644 --- a/docs/api-observable/classes/_classes_.rxproposal.md +++ b/docs/api-observable/classes/_classes_.rxproposal.md @@ -21,7 +21,7 @@ *Overrides Struct.__constructor* -*Defined in [classes.ts:9](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/classes.ts#L9)* +*Defined in [classes.ts:9](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/classes.ts#L9)* **Parameters:** @@ -43,7 +43,7 @@ ___ *Inherited from Struct._Types* -*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L27)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)* ___ @@ -54,7 +54,7 @@ ___ *Inherited from Struct._jsonMap* -*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L26)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)* ___ @@ -65,7 +65,7 @@ ___ *Inherited from Base.raw* -*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Base.ts:19](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Base.ts#L19)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* ___ @@ -79,7 +79,7 @@ getType(): `E` *Inherited from Struct.Type* -*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L76)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)* **Returns:** `E` @@ -90,7 +90,7 @@ ___ getaddress(): `AccountId` -*Defined in [classes.ts:18](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/classes.ts#L18)* +*Defined in [classes.ts:18](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/classes.ts#L18)* **Returns:** `AccountId` @@ -101,7 +101,7 @@ ___ getid(): `PropIndex` -*Defined in [classes.ts:22](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/classes.ts#L22)* +*Defined in [classes.ts:22](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/classes.ts#L22)* **Returns:** `PropIndex` @@ -112,7 +112,7 @@ ___ getproposal(): `Proposal` -*Defined in [classes.ts:26](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/classes.ts#L26)* +*Defined in [classes.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/classes.ts#L26)* **Returns:** `Proposal` @@ -130,7 +130,7 @@ ___ *Overrides Base.byteLength* -*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L80)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)* **Returns:** `number` @@ -145,7 +145,7 @@ ___ *Overrides Base.fromJSON* -*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L86)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L86)* **Parameters:** @@ -166,7 +166,7 @@ ___ *Overrides Base.fromU8a* -*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L101)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)* **Parameters:** @@ -185,7 +185,7 @@ ___ *Inherited from Struct.get* -*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L111)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)* **Parameters:** @@ -204,7 +204,7 @@ ___ *Inherited from Struct.keys* -*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L126)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)* **Returns:** `Array`<`string`> @@ -219,7 +219,7 @@ ___ *Overrides Base.toJSON* -*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L115)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L115)* **Returns:** `any` @@ -234,7 +234,7 @@ ___ *Overrides Base.toString* -*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L138)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)* **Returns:** `string` @@ -249,7 +249,7 @@ ___ *Overrides Base.toU8a* -*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L130)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)* **Parameters:** @@ -268,7 +268,7 @@ ___ *Inherited from Struct.values* -*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L147)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)* **Returns:** `Array`<`Base`> @@ -281,7 +281,7 @@ ___ *Inherited from Struct.decode* -*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L45)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)* **Type parameters:** @@ -307,7 +307,7 @@ ___ *Inherited from Struct.with* -*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L66)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L66)* **Type parameters:** diff --git a/docs/api-observable/classes/_classes_.rxproposaldeposits.md b/docs/api-observable/classes/_classes_.rxproposaldeposits.md index b7298d19fd..5350a66041 100644 --- a/docs/api-observable/classes/_classes_.rxproposaldeposits.md +++ b/docs/api-observable/classes/_classes_.rxproposaldeposits.md @@ -21,7 +21,7 @@ *Overrides Struct.__constructor* -*Defined in [classes.ts:31](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/classes.ts#L31)* +*Defined in [classes.ts:31](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/classes.ts#L31)* **Parameters:** @@ -43,7 +43,7 @@ ___ *Inherited from Struct._Types* -*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L27)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)* ___ @@ -54,7 +54,7 @@ ___ *Inherited from Struct._jsonMap* -*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L26)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)* ___ @@ -65,7 +65,7 @@ ___ *Inherited from Base.raw* -*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Base.ts:19](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Base.ts#L19)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* ___ @@ -79,7 +79,7 @@ getType(): `E` *Inherited from Struct.Type* -*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L76)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)* **Returns:** `E` @@ -90,7 +90,7 @@ ___ getaddresses(): `Vector`<`AccountId`> -*Defined in [classes.ts:39](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/classes.ts#L39)* +*Defined in [classes.ts:39](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/classes.ts#L39)* **Returns:** `Vector`<`AccountId`> @@ -101,7 +101,7 @@ ___ getbalance(): `Balance` -*Defined in [classes.ts:43](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/classes.ts#L43)* +*Defined in [classes.ts:43](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/classes.ts#L43)* **Returns:** `Balance` @@ -119,7 +119,7 @@ ___ *Overrides Base.byteLength* -*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L80)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)* **Returns:** `number` @@ -134,7 +134,7 @@ ___ *Overrides Base.fromJSON* -*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L86)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L86)* **Parameters:** @@ -155,7 +155,7 @@ ___ *Overrides Base.fromU8a* -*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L101)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)* **Parameters:** @@ -174,7 +174,7 @@ ___ *Inherited from Struct.get* -*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L111)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)* **Parameters:** @@ -193,7 +193,7 @@ ___ *Inherited from Struct.keys* -*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L126)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)* **Returns:** `Array`<`string`> @@ -208,7 +208,7 @@ ___ *Overrides Base.toJSON* -*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L115)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L115)* **Returns:** `any` @@ -223,7 +223,7 @@ ___ *Overrides Base.toString* -*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L138)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)* **Returns:** `string` @@ -238,7 +238,7 @@ ___ *Overrides Base.toU8a* -*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L130)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)* **Parameters:** @@ -257,7 +257,7 @@ ___ *Inherited from Struct.values* -*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L147)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)* **Returns:** `Array`<`Base`> @@ -270,7 +270,7 @@ ___ *Inherited from Struct.decode* -*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L45)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)* **Type parameters:** @@ -296,7 +296,7 @@ ___ *Inherited from Struct.with* -*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L66)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L66)* **Type parameters:** diff --git a/docs/api-observable/classes/_classes_.rxreferendum.md b/docs/api-observable/classes/_classes_.rxreferendum.md index e2394a37c6..2c710cdeed 100644 --- a/docs/api-observable/classes/_classes_.rxreferendum.md +++ b/docs/api-observable/classes/_classes_.rxreferendum.md @@ -21,7 +21,7 @@ *Overrides Struct.__constructor* -*Defined in [classes.ts:48](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/classes.ts#L48)* +*Defined in [classes.ts:48](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/classes.ts#L48)* **Parameters:** @@ -44,7 +44,7 @@ ___ *Inherited from Struct._Types* -*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L27)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)* ___ @@ -55,7 +55,7 @@ ___ *Inherited from Struct._jsonMap* -*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L26)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)* ___ @@ -66,7 +66,7 @@ ___ *Inherited from Base.raw* -*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Base.ts:19](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Base.ts#L19)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* ___ @@ -80,7 +80,7 @@ getType(): `E` *Inherited from Struct.Type* -*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L76)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)* **Returns:** `E` @@ -91,7 +91,7 @@ ___ getblockNumber(): `BlockNumber` -*Defined in [classes.ts:58](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/classes.ts#L58)* +*Defined in [classes.ts:58](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/classes.ts#L58)* **Returns:** `BlockNumber` @@ -102,7 +102,7 @@ ___ getid(): `ReferendumIndex` -*Defined in [classes.ts:62](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/classes.ts#L62)* +*Defined in [classes.ts:62](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/classes.ts#L62)* **Returns:** `ReferendumIndex` @@ -113,7 +113,7 @@ ___ getproposal(): `Proposal` -*Defined in [classes.ts:66](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/classes.ts#L66)* +*Defined in [classes.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/classes.ts#L66)* **Returns:** `Proposal` @@ -124,7 +124,7 @@ ___ getvoteThreshold(): `VoteThreshold` -*Defined in [classes.ts:70](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/classes.ts#L70)* +*Defined in [classes.ts:70](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/classes.ts#L70)* **Returns:** `VoteThreshold` @@ -142,7 +142,7 @@ ___ *Overrides Base.byteLength* -*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L80)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)* **Returns:** `number` @@ -157,7 +157,7 @@ ___ *Overrides Base.fromJSON* -*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L86)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L86)* **Parameters:** @@ -178,7 +178,7 @@ ___ *Overrides Base.fromU8a* -*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L101)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)* **Parameters:** @@ -197,7 +197,7 @@ ___ *Inherited from Struct.get* -*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L111)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)* **Parameters:** @@ -216,7 +216,7 @@ ___ *Inherited from Struct.keys* -*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L126)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)* **Returns:** `Array`<`string`> @@ -231,7 +231,7 @@ ___ *Overrides Base.toJSON* -*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L115)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L115)* **Returns:** `any` @@ -246,7 +246,7 @@ ___ *Overrides Base.toString* -*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L138)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)* **Returns:** `string` @@ -261,7 +261,7 @@ ___ *Overrides Base.toU8a* -*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L130)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)* **Parameters:** @@ -280,7 +280,7 @@ ___ *Inherited from Struct.values* -*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L147)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)* **Returns:** `Array`<`Base`> @@ -293,7 +293,7 @@ ___ *Inherited from Struct.decode* -*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L45)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)* **Type parameters:** @@ -319,7 +319,7 @@ ___ *Inherited from Struct.with* -*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L66)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L66)* **Type parameters:** diff --git a/docs/api-observable/classes/_combined_.apicombined.md b/docs/api-observable/classes/_combined_.apicombined.md index e16c8970e3..2f055931ec 100644 --- a/docs/api-observable/classes/_combined_.apicombined.md +++ b/docs/api-observable/classes/_combined_.apicombined.md @@ -18,7 +18,7 @@ *Inherited from [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)* -*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L22)* +*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L22)* **Parameters:** @@ -40,7 +40,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[api](_base_.apibase.md#api)* -*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L22)* +*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L22)* ___ @@ -54,7 +54,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[bestNumber](_calls_.apicalls.md#bestnumber)* -*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Calls.ts#L13)* +*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Calls.ts#L13)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -67,7 +67,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[chainGetBlock](_calls_.apicalls.md#chaingetblock)* -*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Calls.ts#L25)* +*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Calls.ts#L25)* **Parameters:** @@ -86,7 +86,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[chainNewHead](_calls_.apicalls.md#chainnewhead)* -*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Calls.ts#L29)* +*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Calls.ts#L29)* **Returns:** `Observable`< `Header` | `undefined`> @@ -99,7 +99,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[combine](_base_.apibase.md#combine)* -*Defined in [Base.ts:28](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L28)* +*Defined in [Base.ts:28](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L28)* **Type parameters:** @@ -123,7 +123,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democacyVoteOf](_queries_.apiqueries.md#democacyvoteof)* -*Defined in [Queries.ts:76](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L76)* +*Defined in [Queries.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L76)* **Parameters:** @@ -143,7 +143,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democacyVotersFor](_queries_.apiqueries.md#democacyvotersfor)* -*Defined in [Queries.ts:80](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L80)* +*Defined in [Queries.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L80)* **Parameters:** @@ -162,7 +162,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyLaunchPeriod](_queries_.apiqueries.md#democracylaunchperiod)* -*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L19)* +*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L19)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -175,7 +175,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyNextTally](_queries_.apiqueries.md#democracynexttally)* -*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L23)* +*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L23)* **Returns:** `Observable`< `ReferendumIndex` | `undefined`> @@ -186,7 +186,7 @@ ___ ▸ **democracyProposalCount**(): `Observable`<`number`> -*Defined in [Combined.ts:20](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L20)* +*Defined in [Combined.ts:20](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L20)* **Returns:** `Observable`<`number`> @@ -199,7 +199,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyProposalDeposits](_queries_.apiqueries.md#democracyproposaldeposits)* -*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L27)* +*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L27)* **Parameters:** @@ -218,7 +218,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyPublicProposals](_queries_.apiqueries.md#democracypublicproposals)* -*Defined in [Queries.ts:40](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L40)* +*Defined in [Queries.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L40)* **Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>> @@ -231,7 +231,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyReferendumCount](_queries_.apiqueries.md#democracyreferendumcount)* -*Defined in [Queries.ts:59](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L59)* +*Defined in [Queries.ts:59](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L59)* **Returns:** `Observable`< `ReferendumIndex` | `undefined`> @@ -244,7 +244,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyReferendumInfoOf](_queries_.apiqueries.md#democracyreferenduminfoof)* -*Defined in [Queries.ts:63](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L63)* +*Defined in [Queries.ts:63](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L63)* **Parameters:** @@ -261,7 +261,7 @@ ___ ▸ **democracyReferendumInfos**(referendumIds: *`Array`< `ReferendumIndex` | `BN` | `number`>*): `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>> -*Defined in [Combined.ts:30](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L30)* +*Defined in [Combined.ts:30](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L30)* **Parameters:** @@ -278,7 +278,7 @@ ___ ▸ **democracyReferendumVoters**(referendumId: * `ReferendumIndex` | `BN` | `number`*): `Observable`<`Array`<[RxReferendumVote](../modules/_types_d_.md#rxreferendumvote)>> -*Defined in [Combined.ts:42](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L42)* +*Defined in [Combined.ts:42](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L42)* **Parameters:** @@ -295,7 +295,7 @@ ___ ▸ **democracyReferendums**(): `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>> -*Defined in [Combined.ts:58](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L58)* +*Defined in [Combined.ts:58](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L58)* **Returns:** `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>> @@ -306,7 +306,7 @@ ___ ▸ **democracyVotersBalancesOf**(referendumId: * `ReferendumIndex` | `BN` | `number`*): `Observable`<`Array`<`Balance`>> -*Defined in [Combined.ts:87](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L87)* +*Defined in [Combined.ts:87](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L87)* **Parameters:** @@ -323,7 +323,7 @@ ___ ▸ **democracyVotersVotesOf**(referendumId: * `ReferendumIndex` | `BN` | `number`*): `Observable`<`Array`<`Bool`>> -*Defined in [Combined.ts:103](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L103)* +*Defined in [Combined.ts:103](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L103)* **Parameters:** @@ -340,7 +340,7 @@ ___ ▸ **democracyVotesOf**(index: * `ReferendumIndex` | `BN` | `number`*, addresses: *`Array`< `AccountId` | `string`>*): `Observable`<`boolean`> -*Defined in [Combined.ts:79](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L79)* +*Defined in [Combined.ts:79](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L79)* **Parameters:** @@ -360,7 +360,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyVotingPeriod](_queries_.apiqueries.md#democracyvotingperiod)* -*Defined in [Queries.ts:91](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L91)* +*Defined in [Queries.ts:91](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L91)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -371,7 +371,7 @@ ___ ▸ **eraBlockLength**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Combined.ts:114](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L114)* +*Defined in [Combined.ts:114](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L114)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -382,7 +382,7 @@ ___ ▸ **eraBlockProgress**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Combined.ts:129](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L129)* +*Defined in [Combined.ts:129](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L129)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -393,7 +393,7 @@ ___ ▸ **eraBlockRemaining**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Combined.ts:151](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L151)* +*Defined in [Combined.ts:151](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L151)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -406,7 +406,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[eraLastLengthChange](_queries_.apiqueries.md#eralastlengthchange)* -*Defined in [Queries.ts:116](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L116)* +*Defined in [Queries.ts:116](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L116)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -419,7 +419,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[fees](_queries_.apiqueries.md#fees)* -*Defined in [Queries.ts:95](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L95)* +*Defined in [Queries.ts:95](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L95)* **Returns:** `Observable`<[RxFees](../modules/_types_d_.md#rxfees)> @@ -432,7 +432,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[isConnected](_base_.apibase.md#isconnected)* -*Defined in [Base.ts:36](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L36)* +*Defined in [Base.ts:36](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L36)* **Returns:** `Observable`<`boolean`> @@ -445,7 +445,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)* -*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L40)* +*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L40)* **Type parameters:** @@ -468,7 +468,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)* -*Defined in [Base.ts:52](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L52)* +*Defined in [Base.ts:52](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L52)* **Type parameters:** @@ -491,7 +491,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)* -*Defined in [Base.ts:63](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L63)* +*Defined in [Base.ts:63](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L63)* **Type parameters:** @@ -511,7 +511,7 @@ ___ ▸ **sessionBlockProgress**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Combined.ts:166](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L166)* +*Defined in [Combined.ts:166](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L166)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -522,7 +522,7 @@ ___ ▸ **sessionBlockRemaining**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Combined.ts:185](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L185)* +*Defined in [Combined.ts:185](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L185)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -533,7 +533,7 @@ ___ ▸ **sessionBrokenValue**(): `Observable`< `Moment` | `undefined`> -*Defined in [Combined.ts:200](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L200)* +*Defined in [Combined.ts:200](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L200)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -546,7 +546,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentIndex](_queries_.apiqueries.md#sessioncurrentindex)* -*Defined in [Queries.ts:128](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L128)* +*Defined in [Queries.ts:128](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L128)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -559,7 +559,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentStart](_queries_.apiqueries.md#sessioncurrentstart)* -*Defined in [Queries.ts:132](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L132)* +*Defined in [Queries.ts:132](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L132)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -572,7 +572,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLastLengthChange](_queries_.apiqueries.md#sessionlastlengthchange)* -*Defined in [Queries.ts:136](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L136)* +*Defined in [Queries.ts:136](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L136)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -585,7 +585,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLength](_queries_.apiqueries.md#sessionlength)* -*Defined in [Queries.ts:140](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L140)* +*Defined in [Queries.ts:140](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L140)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -598,7 +598,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionReward](_queries_.apiqueries.md#sessionreward)* -*Defined in [Queries.ts:120](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L120)* +*Defined in [Queries.ts:120](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L120)* **Returns:** `Observable`< `Perbill` | `undefined`> @@ -611,7 +611,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionRewardCurrent](_queries_.apiqueries.md#sessionrewardcurrent)* -*Defined in [Queries.ts:124](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L124)* +*Defined in [Queries.ts:124](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L124)* **Returns:** `Observable`< `Balance` | `undefined`> @@ -622,7 +622,7 @@ ___ ▸ **sessionTimeExpected**(): `Observable`< `Moment` | `undefined`> -*Defined in [Combined.ts:219](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L219)* +*Defined in [Combined.ts:219](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L219)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -633,7 +633,7 @@ ___ ▸ **sessionTimeRemaining**(): `Observable`< `Moment` | `undefined`> -*Defined in [Combined.ts:234](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L234)* +*Defined in [Combined.ts:234](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L234)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -646,7 +646,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionValidators](_queries_.apiqueries.md#sessionvalidators)* -*Defined in [Queries.ts:148](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L148)* +*Defined in [Queries.ts:148](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L148)* **Returns:** `Observable`<`Array`<`AccountId`>> @@ -659,7 +659,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionsPerEra](_queries_.apiqueries.md#sessionsperera)* -*Defined in [Queries.ts:144](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L144)* +*Defined in [Queries.ts:144](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L144)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -672,7 +672,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingFreeBalanceOf](_queries_.apiqueries.md#stakingfreebalanceof)* -*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L171)* +*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L171)* **Parameters:** @@ -691,7 +691,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingIntentions](_queries_.apiqueries.md#stakingintentions)* -*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L159)* +*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L159)* **Returns:** `Observable`<`Array`<`AccountId`>> @@ -704,7 +704,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominating](_queries_.apiqueries.md#stakingnominating)* -*Defined in [Queries.ts:186](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L186)* +*Defined in [Queries.ts:186](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L186)* **Parameters:** @@ -723,7 +723,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominatorsFor](_queries_.apiqueries.md#stakingnominatorsfor)* -*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L175)* +*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L175)* **Parameters:** @@ -742,7 +742,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingReservedBalanceOf](_queries_.apiqueries.md#stakingreservedbalanceof)* -*Defined in [Queries.ts:191](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L191)* +*Defined in [Queries.ts:191](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L191)* **Parameters:** @@ -761,7 +761,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[systemAccountIndexOf](_queries_.apiqueries.md#systemaccountindexof)* -*Defined in [Queries.ts:203](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L203)* +*Defined in [Queries.ts:203](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L203)* **Parameters:** @@ -780,7 +780,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[timestampBlockPeriod](_queries_.apiqueries.md#timestampblockperiod)* -*Defined in [Queries.ts:195](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L195)* +*Defined in [Queries.ts:195](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L195)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -793,7 +793,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[timestampNow](_queries_.apiqueries.md#timestampnow)* -*Defined in [Queries.ts:199](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L199)* +*Defined in [Queries.ts:199](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L199)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -804,7 +804,7 @@ ___ ▸ **validatingBalance**(address: * `AccountId` | `string`*): `Observable`<[RxBalance](../modules/_types_d_.md#rxbalance)> -*Defined in [Combined.ts:249](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L249)* +*Defined in [Combined.ts:249](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L249)* **Parameters:** @@ -821,7 +821,7 @@ ___ ▸ **validatingBalances**(...addresses: *`Array`< `AccountId` | `string`>*): `Observable`<[RxBalanceMap](../modules/_types_d_.md#rxbalancemap)> -*Defined in [Combined.ts:274](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L274)* +*Defined in [Combined.ts:274](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L274)* **Parameters:** @@ -840,7 +840,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[validatorCount](_queries_.apiqueries.md#validatorcount)* -*Defined in [Queries.ts:207](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L207)* +*Defined in [Queries.ts:207](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L207)* **Returns:** `Observable`<`u32`> @@ -851,7 +851,7 @@ ___ ▸ **votingBalance**(_address: * `AccountId` | `string`*): `Observable`<[RxBalance](../modules/_types_d_.md#rxbalance)> -*Defined in [Combined.ts:288](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L288)* +*Defined in [Combined.ts:288](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L288)* **Parameters:** @@ -868,7 +868,7 @@ ___ ▸ **votingBalances**(...addresses: *`Array`< `AccountId` | `string`>*): `Observable`<[RxBalance](../modules/_types_d_.md#rxbalance)[]> -*Defined in [Combined.ts:322](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L322)* +*Defined in [Combined.ts:322](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L322)* **Parameters:** @@ -885,7 +885,7 @@ ___ ▸ **votingBalancesNominatorsFor**(address: * `AccountId` | `string`*): `Observable`<`any`> -*Defined in [Combined.ts:311](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L311)* +*Defined in [Combined.ts:311](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L311)* **Parameters:** diff --git a/docs/api-observable/classes/_index_.api.md b/docs/api-observable/classes/_index_.api.md index 544d4c7cc0..f37b2bb7ee 100644 --- a/docs/api-observable/classes/_index_.api.md +++ b/docs/api-observable/classes/_index_.api.md @@ -16,7 +16,7 @@ *Inherited from [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)* -*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L22)* +*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L22)* **Parameters:** @@ -38,7 +38,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[api](_base_.apibase.md#api)* -*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L22)* +*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L22)* ___ @@ -52,7 +52,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[bestNumber](_calls_.apicalls.md#bestnumber)* -*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Calls.ts#L13)* +*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Calls.ts#L13)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -65,7 +65,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[chainGetBlock](_calls_.apicalls.md#chaingetblock)* -*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Calls.ts#L25)* +*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Calls.ts#L25)* **Parameters:** @@ -84,7 +84,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[chainNewHead](_calls_.apicalls.md#chainnewhead)* -*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Calls.ts#L29)* +*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Calls.ts#L29)* **Returns:** `Observable`< `Header` | `undefined`> @@ -97,7 +97,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[combine](_base_.apibase.md#combine)* -*Defined in [Base.ts:28](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L28)* +*Defined in [Base.ts:28](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L28)* **Type parameters:** @@ -121,7 +121,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democacyVoteOf](_queries_.apiqueries.md#democacyvoteof)* -*Defined in [Queries.ts:76](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L76)* +*Defined in [Queries.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L76)* **Parameters:** @@ -141,7 +141,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democacyVotersFor](_queries_.apiqueries.md#democacyvotersfor)* -*Defined in [Queries.ts:80](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L80)* +*Defined in [Queries.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L80)* **Parameters:** @@ -160,7 +160,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyLaunchPeriod](_queries_.apiqueries.md#democracylaunchperiod)* -*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L19)* +*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L19)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -173,7 +173,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyNextTally](_queries_.apiqueries.md#democracynexttally)* -*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L23)* +*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L23)* **Returns:** `Observable`< `ReferendumIndex` | `undefined`> @@ -186,7 +186,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[democracyProposalCount](_combined_.apicombined.md#democracyproposalcount)* -*Defined in [Combined.ts:20](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L20)* +*Defined in [Combined.ts:20](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L20)* **Returns:** `Observable`<`number`> @@ -199,7 +199,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyProposalDeposits](_queries_.apiqueries.md#democracyproposaldeposits)* -*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L27)* +*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L27)* **Parameters:** @@ -218,7 +218,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyPublicProposals](_queries_.apiqueries.md#democracypublicproposals)* -*Defined in [Queries.ts:40](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L40)* +*Defined in [Queries.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L40)* **Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>> @@ -231,7 +231,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyReferendumCount](_queries_.apiqueries.md#democracyreferendumcount)* -*Defined in [Queries.ts:59](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L59)* +*Defined in [Queries.ts:59](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L59)* **Returns:** `Observable`< `ReferendumIndex` | `undefined`> @@ -244,7 +244,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyReferendumInfoOf](_queries_.apiqueries.md#democracyreferenduminfoof)* -*Defined in [Queries.ts:63](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L63)* +*Defined in [Queries.ts:63](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L63)* **Parameters:** @@ -263,7 +263,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[democracyReferendumInfos](_combined_.apicombined.md#democracyreferenduminfos)* -*Defined in [Combined.ts:30](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L30)* +*Defined in [Combined.ts:30](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L30)* **Parameters:** @@ -282,7 +282,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[democracyReferendumVoters](_combined_.apicombined.md#democracyreferendumvoters)* -*Defined in [Combined.ts:42](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L42)* +*Defined in [Combined.ts:42](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L42)* **Parameters:** @@ -301,7 +301,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[democracyReferendums](_combined_.apicombined.md#democracyreferendums)* -*Defined in [Combined.ts:58](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L58)* +*Defined in [Combined.ts:58](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L58)* **Returns:** `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>> @@ -314,7 +314,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[democracyVotersBalancesOf](_combined_.apicombined.md#democracyvotersbalancesof)* -*Defined in [Combined.ts:87](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L87)* +*Defined in [Combined.ts:87](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L87)* **Parameters:** @@ -333,7 +333,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[democracyVotersVotesOf](_combined_.apicombined.md#democracyvotersvotesof)* -*Defined in [Combined.ts:103](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L103)* +*Defined in [Combined.ts:103](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L103)* **Parameters:** @@ -352,7 +352,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[democracyVotesOf](_combined_.apicombined.md#democracyvotesof)* -*Defined in [Combined.ts:79](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L79)* +*Defined in [Combined.ts:79](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L79)* **Parameters:** @@ -372,7 +372,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyVotingPeriod](_queries_.apiqueries.md#democracyvotingperiod)* -*Defined in [Queries.ts:91](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L91)* +*Defined in [Queries.ts:91](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L91)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -385,7 +385,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[eraBlockLength](_combined_.apicombined.md#erablocklength)* -*Defined in [Combined.ts:114](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L114)* +*Defined in [Combined.ts:114](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L114)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -398,7 +398,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[eraBlockProgress](_combined_.apicombined.md#erablockprogress)* -*Defined in [Combined.ts:129](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L129)* +*Defined in [Combined.ts:129](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L129)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -411,7 +411,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[eraBlockRemaining](_combined_.apicombined.md#erablockremaining)* -*Defined in [Combined.ts:151](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L151)* +*Defined in [Combined.ts:151](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L151)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -424,7 +424,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[eraLastLengthChange](_queries_.apiqueries.md#eralastlengthchange)* -*Defined in [Queries.ts:116](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L116)* +*Defined in [Queries.ts:116](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L116)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -437,7 +437,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[fees](_queries_.apiqueries.md#fees)* -*Defined in [Queries.ts:95](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L95)* +*Defined in [Queries.ts:95](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L95)* **Returns:** `Observable`<[RxFees](../modules/_types_d_.md#rxfees)> @@ -450,7 +450,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[isConnected](_base_.apibase.md#isconnected)* -*Defined in [Base.ts:36](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L36)* +*Defined in [Base.ts:36](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L36)* **Returns:** `Observable`<`boolean`> @@ -463,7 +463,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)* -*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L40)* +*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L40)* **Type parameters:** @@ -486,7 +486,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)* -*Defined in [Base.ts:52](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L52)* +*Defined in [Base.ts:52](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L52)* **Type parameters:** @@ -509,7 +509,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)* -*Defined in [Base.ts:63](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L63)* +*Defined in [Base.ts:63](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L63)* **Type parameters:** @@ -531,7 +531,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[sessionBlockProgress](_combined_.apicombined.md#sessionblockprogress)* -*Defined in [Combined.ts:166](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L166)* +*Defined in [Combined.ts:166](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L166)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -544,7 +544,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[sessionBlockRemaining](_combined_.apicombined.md#sessionblockremaining)* -*Defined in [Combined.ts:185](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L185)* +*Defined in [Combined.ts:185](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L185)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -557,7 +557,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[sessionBrokenValue](_combined_.apicombined.md#sessionbrokenvalue)* -*Defined in [Combined.ts:200](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L200)* +*Defined in [Combined.ts:200](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L200)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -570,7 +570,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentIndex](_queries_.apiqueries.md#sessioncurrentindex)* -*Defined in [Queries.ts:128](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L128)* +*Defined in [Queries.ts:128](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L128)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -583,7 +583,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentStart](_queries_.apiqueries.md#sessioncurrentstart)* -*Defined in [Queries.ts:132](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L132)* +*Defined in [Queries.ts:132](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L132)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -596,7 +596,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLastLengthChange](_queries_.apiqueries.md#sessionlastlengthchange)* -*Defined in [Queries.ts:136](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L136)* +*Defined in [Queries.ts:136](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L136)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -609,7 +609,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLength](_queries_.apiqueries.md#sessionlength)* -*Defined in [Queries.ts:140](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L140)* +*Defined in [Queries.ts:140](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L140)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -622,7 +622,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionReward](_queries_.apiqueries.md#sessionreward)* -*Defined in [Queries.ts:120](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L120)* +*Defined in [Queries.ts:120](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L120)* **Returns:** `Observable`< `Perbill` | `undefined`> @@ -635,7 +635,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionRewardCurrent](_queries_.apiqueries.md#sessionrewardcurrent)* -*Defined in [Queries.ts:124](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L124)* +*Defined in [Queries.ts:124](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L124)* **Returns:** `Observable`< `Balance` | `undefined`> @@ -648,7 +648,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[sessionTimeExpected](_combined_.apicombined.md#sessiontimeexpected)* -*Defined in [Combined.ts:219](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L219)* +*Defined in [Combined.ts:219](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L219)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -661,7 +661,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[sessionTimeRemaining](_combined_.apicombined.md#sessiontimeremaining)* -*Defined in [Combined.ts:234](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L234)* +*Defined in [Combined.ts:234](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L234)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -674,7 +674,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionValidators](_queries_.apiqueries.md#sessionvalidators)* -*Defined in [Queries.ts:148](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L148)* +*Defined in [Queries.ts:148](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L148)* **Returns:** `Observable`<`Array`<`AccountId`>> @@ -687,7 +687,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionsPerEra](_queries_.apiqueries.md#sessionsperera)* -*Defined in [Queries.ts:144](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L144)* +*Defined in [Queries.ts:144](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L144)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -700,7 +700,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingFreeBalanceOf](_queries_.apiqueries.md#stakingfreebalanceof)* -*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L171)* +*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L171)* **Parameters:** @@ -719,7 +719,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingIntentions](_queries_.apiqueries.md#stakingintentions)* -*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L159)* +*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L159)* **Returns:** `Observable`<`Array`<`AccountId`>> @@ -732,7 +732,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominating](_queries_.apiqueries.md#stakingnominating)* -*Defined in [Queries.ts:186](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L186)* +*Defined in [Queries.ts:186](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L186)* **Parameters:** @@ -751,7 +751,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominatorsFor](_queries_.apiqueries.md#stakingnominatorsfor)* -*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L175)* +*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L175)* **Parameters:** @@ -770,7 +770,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingReservedBalanceOf](_queries_.apiqueries.md#stakingreservedbalanceof)* -*Defined in [Queries.ts:191](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L191)* +*Defined in [Queries.ts:191](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L191)* **Parameters:** @@ -789,7 +789,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[systemAccountIndexOf](_queries_.apiqueries.md#systemaccountindexof)* -*Defined in [Queries.ts:203](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L203)* +*Defined in [Queries.ts:203](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L203)* **Parameters:** @@ -808,7 +808,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[timestampBlockPeriod](_queries_.apiqueries.md#timestampblockperiod)* -*Defined in [Queries.ts:195](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L195)* +*Defined in [Queries.ts:195](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L195)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -821,7 +821,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[timestampNow](_queries_.apiqueries.md#timestampnow)* -*Defined in [Queries.ts:199](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L199)* +*Defined in [Queries.ts:199](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L199)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -834,7 +834,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[validatingBalance](_combined_.apicombined.md#validatingbalance)* -*Defined in [Combined.ts:249](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L249)* +*Defined in [Combined.ts:249](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L249)* **Parameters:** @@ -853,7 +853,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[validatingBalances](_combined_.apicombined.md#validatingbalances)* -*Defined in [Combined.ts:274](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L274)* +*Defined in [Combined.ts:274](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L274)* **Parameters:** @@ -872,7 +872,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[validatorCount](_queries_.apiqueries.md#validatorcount)* -*Defined in [Queries.ts:207](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L207)* +*Defined in [Queries.ts:207](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L207)* **Returns:** `Observable`<`u32`> @@ -885,7 +885,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[votingBalance](_combined_.apicombined.md#votingbalance)* -*Defined in [Combined.ts:288](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L288)* +*Defined in [Combined.ts:288](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L288)* **Parameters:** @@ -904,7 +904,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[votingBalances](_combined_.apicombined.md#votingbalances)* -*Defined in [Combined.ts:322](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L322)* +*Defined in [Combined.ts:322](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L322)* **Parameters:** @@ -923,7 +923,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[votingBalancesNominatorsFor](_combined_.apicombined.md#votingbalancesnominatorsfor)* -*Defined in [Combined.ts:311](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L311)* +*Defined in [Combined.ts:311](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L311)* **Parameters:** diff --git a/docs/api-observable/classes/_queries_.apiqueries.md b/docs/api-observable/classes/_queries_.apiqueries.md index 4759436deb..976eb6de21 100644 --- a/docs/api-observable/classes/_queries_.apiqueries.md +++ b/docs/api-observable/classes/_queries_.apiqueries.md @@ -18,7 +18,7 @@ *Inherited from [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)* -*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L22)* +*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L22)* **Parameters:** @@ -40,7 +40,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[api](_base_.apibase.md#api)* -*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L22)* +*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L22)* ___ @@ -54,7 +54,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[combine](_base_.apibase.md#combine)* -*Defined in [Base.ts:28](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L28)* +*Defined in [Base.ts:28](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L28)* **Type parameters:** @@ -76,7 +76,7 @@ ___ ▸ **democacyVoteOf**(index: * `ReferendumIndex` | `BN` | `number`*, address: * `AccountId` | `string`*): `Observable`<`Bool`> -*Defined in [Queries.ts:76](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L76)* +*Defined in [Queries.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L76)* **Parameters:** @@ -94,7 +94,7 @@ ___ ▸ **democacyVotersFor**(index: * `ReferendumIndex` | `BN` | `number`*): `Observable`<`Array`<`AccountId`>> -*Defined in [Queries.ts:80](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L80)* +*Defined in [Queries.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L80)* **Parameters:** @@ -111,7 +111,7 @@ ___ ▸ **democracyLaunchPeriod**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L19)* +*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L19)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -122,7 +122,7 @@ ___ ▸ **democracyNextTally**(): `Observable`< `ReferendumIndex` | `undefined`> -*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L23)* +*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L23)* **Returns:** `Observable`< `ReferendumIndex` | `undefined`> @@ -133,7 +133,7 @@ ___ ▸ **democracyProposalDeposits**(proposalId: * `PropIndex` | `BN` | `number`*): `Observable`< [RxProposalDeposits](_classes_.rxproposaldeposits.md) | `undefined`> -*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L27)* +*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L27)* **Parameters:** @@ -150,7 +150,7 @@ ___ ▸ **democracyPublicProposals**(): `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>> -*Defined in [Queries.ts:40](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L40)* +*Defined in [Queries.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L40)* **Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>> @@ -161,7 +161,7 @@ ___ ▸ **democracyReferendumCount**(): `Observable`< `ReferendumIndex` | `undefined`> -*Defined in [Queries.ts:59](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L59)* +*Defined in [Queries.ts:59](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L59)* **Returns:** `Observable`< `ReferendumIndex` | `undefined`> @@ -172,7 +172,7 @@ ___ ▸ **democracyReferendumInfoOf**(referendumId: * `ReferendumIndex` | `BN` | `number`*): `Observable`< [RxReferendum](_classes_.rxreferendum.md) | `undefined`> -*Defined in [Queries.ts:63](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L63)* +*Defined in [Queries.ts:63](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L63)* **Parameters:** @@ -189,7 +189,7 @@ ___ ▸ **democracyVotingPeriod**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Queries.ts:91](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L91)* +*Defined in [Queries.ts:91](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L91)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -200,7 +200,7 @@ ___ ▸ **eraLastLengthChange**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Queries.ts:116](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L116)* +*Defined in [Queries.ts:116](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L116)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -211,7 +211,7 @@ ___ ▸ **fees**(): `Observable`<[RxFees](../modules/_types_d_.md#rxfees)> -*Defined in [Queries.ts:95](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L95)* +*Defined in [Queries.ts:95](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L95)* **Returns:** `Observable`<[RxFees](../modules/_types_d_.md#rxfees)> @@ -224,7 +224,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[isConnected](_base_.apibase.md#isconnected)* -*Defined in [Base.ts:36](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L36)* +*Defined in [Base.ts:36](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L36)* **Returns:** `Observable`<`boolean`> @@ -237,7 +237,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)* -*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L40)* +*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L40)* **Type parameters:** @@ -260,7 +260,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)* -*Defined in [Base.ts:52](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L52)* +*Defined in [Base.ts:52](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L52)* **Type parameters:** @@ -283,7 +283,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)* -*Defined in [Base.ts:63](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L63)* +*Defined in [Base.ts:63](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L63)* **Type parameters:** @@ -303,7 +303,7 @@ ___ ▸ **sessionCurrentIndex**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Queries.ts:128](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L128)* +*Defined in [Queries.ts:128](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L128)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -314,7 +314,7 @@ ___ ▸ **sessionCurrentStart**(): `Observable`< `Moment` | `undefined`> -*Defined in [Queries.ts:132](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L132)* +*Defined in [Queries.ts:132](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L132)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -325,7 +325,7 @@ ___ ▸ **sessionLastLengthChange**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Queries.ts:136](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L136)* +*Defined in [Queries.ts:136](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L136)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -336,7 +336,7 @@ ___ ▸ **sessionLength**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Queries.ts:140](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L140)* +*Defined in [Queries.ts:140](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L140)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -347,7 +347,7 @@ ___ ▸ **sessionReward**(): `Observable`< `Perbill` | `undefined`> -*Defined in [Queries.ts:120](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L120)* +*Defined in [Queries.ts:120](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L120)* **Returns:** `Observable`< `Perbill` | `undefined`> @@ -358,7 +358,7 @@ ___ ▸ **sessionRewardCurrent**(): `Observable`< `Balance` | `undefined`> -*Defined in [Queries.ts:124](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L124)* +*Defined in [Queries.ts:124](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L124)* **Returns:** `Observable`< `Balance` | `undefined`> @@ -369,7 +369,7 @@ ___ ▸ **sessionValidators**(): `Observable`<`Array`<`AccountId`>> -*Defined in [Queries.ts:148](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L148)* +*Defined in [Queries.ts:148](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L148)* **Returns:** `Observable`<`Array`<`AccountId`>> @@ -380,7 +380,7 @@ ___ ▸ **sessionsPerEra**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Queries.ts:144](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L144)* +*Defined in [Queries.ts:144](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L144)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -391,7 +391,7 @@ ___ ▸ **stakingFreeBalanceOf**(address: * `AccountId` | `string`*): `Observable`< `Balance` | `undefined`> -*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L171)* +*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L171)* **Parameters:** @@ -408,7 +408,7 @@ ___ ▸ **stakingIntentions**(): `Observable`<`Array`<`AccountId`>> -*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L159)* +*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L159)* **Returns:** `Observable`<`Array`<`AccountId`>> @@ -419,7 +419,7 @@ ___ ▸ **stakingNominating**(address: * `AccountId` | `string`*): `Observable`< `AccountId` | `undefined`> -*Defined in [Queries.ts:186](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L186)* +*Defined in [Queries.ts:186](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L186)* **Parameters:** @@ -436,7 +436,7 @@ ___ ▸ **stakingNominatorsFor**(address: * `AccountId` | `string`*): `Observable`<`Array`<`AccountId`>> -*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L175)* +*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L175)* **Parameters:** @@ -453,7 +453,7 @@ ___ ▸ **stakingReservedBalanceOf**(address: * `AccountId` | `string`*): `Observable`< `Balance` | `undefined`> -*Defined in [Queries.ts:191](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L191)* +*Defined in [Queries.ts:191](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L191)* **Parameters:** @@ -470,7 +470,7 @@ ___ ▸ **systemAccountIndexOf**(address: * `AccountId` | `string`*): `Observable`< `Index` | `undefined`> -*Defined in [Queries.ts:203](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L203)* +*Defined in [Queries.ts:203](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L203)* **Parameters:** @@ -487,7 +487,7 @@ ___ ▸ **timestampBlockPeriod**(): `Observable`< `Moment` | `undefined`> -*Defined in [Queries.ts:195](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L195)* +*Defined in [Queries.ts:195](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L195)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -498,7 +498,7 @@ ___ ▸ **timestampNow**(): `Observable`< `Moment` | `undefined`> -*Defined in [Queries.ts:199](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L199)* +*Defined in [Queries.ts:199](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L199)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -509,7 +509,7 @@ ___ ▸ **validatorCount**(): `Observable`<`u32`> -*Defined in [Queries.ts:207](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L207)* +*Defined in [Queries.ts:207](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L207)* **Returns:** `Observable`<`u32`> diff --git a/docs/api-observable/modules/_types_d_.md b/docs/api-observable/modules/_types_d_.md index b4e15cd0ac..13ea7d43c1 100644 --- a/docs/api-observable/modules/_types_d_.md +++ b/docs/api-observable/modules/_types_d_.md @@ -9,7 +9,7 @@ **Ƭ ApiFunctions**: * `keyof ApiBase` | `keyof ApiCalls` | `keyof ApiCombined` | `keyof ApiQueries` * -*Defined in [types.d.ts:14](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/types.d.ts#L14)* +*Defined in [types.d.ts:14](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/types.d.ts#L14)* ___ @@ -18,7 +18,7 @@ ___ **Ƭ RxBalance**: *`object`* -*Defined in [types.d.ts:16](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/types.d.ts#L16)* +*Defined in [types.d.ts:16](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/types.d.ts#L16)* #### Type declaration @@ -29,7 +29,7 @@ ___ **Ƭ RxBalanceMap**: *`object`* -*Defined in [types.d.ts:40](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/types.d.ts#L40)* +*Defined in [types.d.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/types.d.ts#L40)* #### Type declaration @@ -42,7 +42,7 @@ ___ **Ƭ RxFees**: *`object`* -*Defined in [types.d.ts:26](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/types.d.ts#L26)* +*Defined in [types.d.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/types.d.ts#L26)* #### Type declaration @@ -53,7 +53,7 @@ ___ **Ƭ RxReferendumVote**: *`object`* -*Defined in [types.d.ts:34](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/types.d.ts#L34)* +*Defined in [types.d.ts:34](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/types.d.ts#L34)* #### Type declaration diff --git a/docs/api-provider/classes/_http_index_.httpprovider.html b/docs/api-provider/classes/_http_index_.httpprovider.html index 5af24520bb..310d9b9114 100644 --- a/docs/api-provider/classes/_http_index_.httpprovider.html +++ b/docs/api-provider/classes/_http_index_.httpprovider.html @@ -383,7 +383,7 @@

constructor

⊕ new HttpProvider(endpoint: string): HttpProvider

-

Defined in http/index.ts:35

+

Defined in http/index.ts:35

Parameters:

@@ -406,7 +406,7 @@

isConnected

▸ isConnected(): boolean

Implementation of ProviderInterface.isConnected

-

Defined in http/index.ts:49

+

Defined in http/index.ts:49

Whether the node is connected or not.

Returns: boolean true if connected

@@ -415,7 +415,7 @@ true if connected

on

▸ on(type: ProviderInterface$Emitted, sub: ProviderInterface$EmitCb): void

Implementation of ProviderInterface.on

-

Defined in http/index.ts:56

+

Defined in http/index.ts:56

Events are not supported with the HttpProvider, see WsProvider.

Parameters:

@@ -442,7 +442,7 @@ true if connected

send

▸ send(method: string, params: Array<any>): Promise<any>

Implementation of ProviderInterface.send

-

Defined in http/index.ts:60

+

Defined in http/index.ts:60

Parameters:

@@ -468,7 +468,7 @@ true if connected

subscribe

▸ subscribe(types: string, method: string, params: Array<any>, cb: ProviderInterface$Callback): Promise<number>

Implementation of ProviderInterface.subscribe

-

Defined in http/index.ts:82

+

Defined in http/index.ts:82

Subscriptions are not supported with the HttpProvider, see WsProvider.

Parameters:

@@ -503,7 +503,7 @@ true if connected

unsubscribe

▸ unsubscribe(type: string, method: string, id: number): Promise<boolean>

Implementation of ProviderInterface.unsubscribe

-

Defined in http/index.ts:91

+

Defined in http/index.ts:91

Subscriptions are not supported with the HttpProvider, see WsProvider.

Parameters:

@@ -573,7 +573,7 @@ true if connected

diff --git a/docs/api-provider/classes/_http_index_.httpprovider.md b/docs/api-provider/classes/_http_index_.httpprovider.md index 39e22e9900..fea2209ab4 100644 --- a/docs/api-provider/classes/_http_index_.httpprovider.md +++ b/docs/api-provider/classes/_http_index_.httpprovider.md @@ -23,7 +23,7 @@ const provider = new WsProvider('[http://127.0.0.1:9933')](http://127.0.0.1:9933 ⊕ **new HttpProvider**(endpoint: *`string`*): [HttpProvider](_http_index_.httpprovider.md) -*Defined in [http/index.ts:35](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/http/index.ts#L35)* +*Defined in [http/index.ts:35](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/http/index.ts#L35)* **Parameters:** @@ -45,7 +45,7 @@ ___ *Implementation of [ProviderInterface](../interfaces/_types_d_.providerinterface.md).[isConnected](../interfaces/_types_d_.providerinterface.md#isconnected)* -*Defined in [http/index.ts:49](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/http/index.ts#L49)* +*Defined in [http/index.ts:49](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/http/index.ts#L49)* Whether the node is connected or not. @@ -61,7 +61,7 @@ ___ *Implementation of [ProviderInterface](../interfaces/_types_d_.providerinterface.md).[on](../interfaces/_types_d_.providerinterface.md#on)* -*Defined in [http/index.ts:56](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/http/index.ts#L56)* +*Defined in [http/index.ts:56](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/http/index.ts#L56)* Events are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md). @@ -83,7 +83,7 @@ ___ *Implementation of [ProviderInterface](../interfaces/_types_d_.providerinterface.md).[send](../interfaces/_types_d_.providerinterface.md#send)* -*Defined in [http/index.ts:60](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/http/index.ts#L60)* +*Defined in [http/index.ts:60](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/http/index.ts#L60)* **Parameters:** @@ -103,7 +103,7 @@ ___ *Implementation of [ProviderInterface](../interfaces/_types_d_.providerinterface.md).[subscribe](../interfaces/_types_d_.providerinterface.md#subscribe)* -*Defined in [http/index.ts:82](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/http/index.ts#L82)* +*Defined in [http/index.ts:82](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/http/index.ts#L82)* Subscriptions are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md). @@ -127,7 +127,7 @@ ___ *Implementation of [ProviderInterface](../interfaces/_types_d_.providerinterface.md).[unsubscribe](../interfaces/_types_d_.providerinterface.md#unsubscribe)* -*Defined in [http/index.ts:91](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/http/index.ts#L91)* +*Defined in [http/index.ts:91](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/http/index.ts#L91)* Subscriptions are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md). diff --git a/docs/api-provider/classes/_ws_index_.wsprovider.html b/docs/api-provider/classes/_ws_index_.wsprovider.html index b4f833aa55..8e6ff19c3a 100644 --- a/docs/api-provider/classes/_ws_index_.wsprovider.html +++ b/docs/api-provider/classes/_ws_index_.wsprovider.html @@ -385,7 +385,7 @@

constructor

⊕ new WsProvider(endpoint: string, autoConnect?: boolean): WsProvider

-

Defined in ws/index.ts:67

+

Defined in ws/index.ts:67

Parameters:

@@ -455,7 +455,7 @@

connect

▸ connect(): void

-

Defined in ws/index.ts:97

+

Defined in ws/index.ts:97

The WsProvider connects automatically by default. if you decided otherwise, you may connect manually using this method.

Returns: void


@@ -497,7 +497,7 @@

isConnected

▸ isConnected(): boolean

-

Defined in ws/index.ts:114

+

Defined in ws/index.ts:114

Whether the node is connected or not.

Returns: boolean true if connected

@@ -586,7 +586,7 @@ true if connected

on

▸ on(type: ProviderInterface$Emitted, sub: ProviderInterface$EmitCb): this

Overrides EventEmitter.on

-

Defined in ws/index.ts:124

+

Defined in ws/index.ts:124

Listens on events after having subscribed using the subscribe function.

Parameters:

@@ -705,7 +705,7 @@ true if connected

send

▸ send(method: string, params: Array<any>, subscription?: SubscriptionHandler): Promise<any>

-

Defined in ws/index.ts:128

+

Defined in ws/index.ts:128

Parameters:

@@ -734,7 +734,7 @@ true if connected

subscribe

▸ subscribe(type: string, method: string, params: Array<any>, callback: ProviderInterface$Callback): Promise<number>

-

Defined in ws/index.ts:179

+

Defined in ws/index.ts:179

Allows subscribing to a specific event. example: const provider = new WsProvider('ws://127.0.0.1:9944'); const api = createApi(provider);

api.state.storage([[storage.balances.freeBalance,

@@ -777,7 +777,7 @@ Promise resolving to the dd of the subscription you can use with [[unsubscribe]]

unsubscribe

▸ unsubscribe(type: string, method: string, id: number): Promise<boolean>

-

Defined in ws/index.ts:188

+

Defined in ws/index.ts:188

Allows unsubscribing to subscriptions made with subscribe.

Parameters:

@@ -847,7 +847,7 @@ Promise resolving to the dd of the subscription you can use with [[unsubscribe]] diff --git a/docs/api-provider/classes/_ws_index_.wsprovider.md b/docs/api-provider/classes/_ws_index_.wsprovider.md index 6f3eb0e249..94c61d440c 100644 --- a/docs/api-provider/classes/_ws_index_.wsprovider.md +++ b/docs/api-provider/classes/_ws_index_.wsprovider.md @@ -26,7 +26,7 @@ The WebSocket Provider allows sending requests using WebSocket. Unlike the [Http ⊕ **new WsProvider**(endpoint: *`string`*, autoConnect?: *`boolean`*): [WsProvider](_ws_index_.wsprovider.md) -*Defined in [ws/index.ts:67](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/ws/index.ts#L67)* +*Defined in [ws/index.ts:67](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/ws/index.ts#L67)* **Parameters:** @@ -83,7 +83,7 @@ ___ ▸ **connect**(): `void` -*Defined in [ws/index.ts:97](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/ws/index.ts#L97)* +*Defined in [ws/index.ts:97](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/ws/index.ts#L97)* The [WsProvider](_ws_index_.wsprovider.md) connects automatically by default. if you decided otherwise, you may connect manually using this method. @@ -133,7 +133,7 @@ ___ ▸ **isConnected**(): `boolean` -*Defined in [ws/index.ts:114](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/ws/index.ts#L114)* +*Defined in [ws/index.ts:114](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/ws/index.ts#L114)* Whether the node is connected or not. @@ -213,7 +213,7 @@ ___ *Overrides EventEmitter.on* -*Defined in [ws/index.ts:124](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/ws/index.ts#L124)* +*Defined in [ws/index.ts:124](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/ws/index.ts#L124)* Listens on events after having subscribed using the [subscribe](_ws_index_.wsprovider.md#subscribe) function. @@ -302,7 +302,7 @@ ___ ▸ **send**(method: *`string`*, params: *`Array`<`any`>*, subscription?: *`SubscriptionHandler`*): `Promise`<`any`> -*Defined in [ws/index.ts:128](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/ws/index.ts#L128)* +*Defined in [ws/index.ts:128](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/ws/index.ts#L128)* **Parameters:** @@ -321,7 +321,7 @@ ___ ▸ **subscribe**(type: *`string`*, method: *`string`*, params: *`Array`<`any`>*, callback: *[ProviderInterface$Callback](../modules/_types_d_.md#providerinterface_callback)*): `Promise`<`number`> -*Defined in [ws/index.ts:179](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/ws/index.ts#L179)* +*Defined in [ws/index.ts:179](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/ws/index.ts#L179)* Allows subscribing to a specific event. *__example__*: const provider = new WsProvider('ws://127.0.0.1:9944'); const api = createApi(provider); @@ -349,7 +349,7 @@ ___ ▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`> -*Defined in [ws/index.ts:188](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/ws/index.ts#L188)* +*Defined in [ws/index.ts:188](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/ws/index.ts#L188)* Allows unsubscribing to subscriptions made with [subscribe](_ws_index_.wsprovider.md#subscribe). diff --git a/docs/api-provider/index.html b/docs/api-provider/index.html index c6fd482ea9..b6aa7fd8d9 100644 --- a/docs/api-provider/index.html +++ b/docs/api-provider/index.html @@ -426,7 +426,7 @@ diff --git a/docs/api-provider/interfaces/_types_d_.providerinterface.md b/docs/api-provider/interfaces/_types_d_.providerinterface.md index 02da8f1c53..3232cf5e5e 100644 --- a/docs/api-provider/interfaces/_types_d_.providerinterface.md +++ b/docs/api-provider/interfaces/_types_d_.providerinterface.md @@ -16,7 +16,7 @@ ▸ **isConnected**(): `boolean` -*Defined in [types.d.ts:45](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/types.d.ts#L45)* +*Defined in [types.d.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/types.d.ts#L45)* **Returns:** `boolean` @@ -27,7 +27,7 @@ ___ ▸ **on**(type: *[ProviderInterface$Emitted](../modules/_types_d_.md#providerinterface_emitted)*, sub: *[ProviderInterface$EmitCb](../modules/_types_d_.md#providerinterface_emitcb)*): `void` -*Defined in [types.d.ts:46](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/types.d.ts#L46)* +*Defined in [types.d.ts:46](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/types.d.ts#L46)* **Parameters:** @@ -45,7 +45,7 @@ ___ ▸ **send**(method: *`string`*, params: *`Array`<`any`>*): `Promise`<`any`> -*Defined in [types.d.ts:47](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/types.d.ts#L47)* +*Defined in [types.d.ts:47](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/types.d.ts#L47)* **Parameters:** @@ -63,7 +63,7 @@ ___ ▸ **subscribe**(type: *`string`*, method: *`string`*, params: *`Array`<`any`>*, cb: *[ProviderInterface$Callback](../modules/_types_d_.md#providerinterface_callback)*): `Promise`<`number`> -*Defined in [types.d.ts:48](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/types.d.ts#L48)* +*Defined in [types.d.ts:48](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/types.d.ts#L48)* **Parameters:** @@ -83,7 +83,7 @@ ___ ▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`> -*Defined in [types.d.ts:49](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/types.d.ts#L49)* +*Defined in [types.d.ts:49](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/types.d.ts#L49)* **Parameters:** diff --git a/docs/api-provider/modules/_coder_json_decoderesponse_.md b/docs/api-provider/modules/_coder_json_decoderesponse_.md index 2fb3303d0c..63d79b625c 100644 --- a/docs/api-provider/modules/_coder_json_decoderesponse_.md +++ b/docs/api-provider/modules/_coder_json_decoderesponse_.md @@ -8,7 +8,7 @@ ▸ **decodeResponse**(self: *[RpcCoderState](_coder_json_types_d_.md#rpccoderstate)*, response: *[JsonRpcResponse](_types_d_.md#jsonrpcresponse)*): `any` -*Defined in [coder/json/decodeResponse.ts:22](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/coder/json/decodeResponse.ts#L22)* +*Defined in [coder/json/decodeResponse.ts:22](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/coder/json/decodeResponse.ts#L22)* **Parameters:** diff --git a/docs/api-provider/modules/_coder_json_encodejson_.md b/docs/api-provider/modules/_coder_json_encodejson_.md index 97c5c0c891..ba5f3ef04a 100644 --- a/docs/api-provider/modules/_coder_json_encodejson_.md +++ b/docs/api-provider/modules/_coder_json_encodejson_.md @@ -8,7 +8,7 @@ ▸ **encodeJson**(self: *[RpcCoderState](_coder_json_types_d_.md#rpccoderstate)*, method: *`string`*, params: *`Array`<`any`>*): `string` -*Defined in [coder/json/encodeJson.ts:9](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/coder/json/encodeJson.ts#L9)* +*Defined in [coder/json/encodeJson.ts:9](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/coder/json/encodeJson.ts#L9)* **Parameters:** diff --git a/docs/api-provider/modules/_coder_json_encodeobject_.md b/docs/api-provider/modules/_coder_json_encodeobject_.md index 3129978592..6aac3b5f25 100644 --- a/docs/api-provider/modules/_coder_json_encodeobject_.md +++ b/docs/api-provider/modules/_coder_json_encodeobject_.md @@ -8,7 +8,7 @@ ▸ **encodeObject**(self: *[RpcCoderState](_coder_json_types_d_.md#rpccoderstate)*, method: *`string`*, params: *`Array`<`any`>*): [JsonRpcRequest](_types_d_.md#jsonrpcrequest) -*Defined in [coder/json/encodeObject.ts:8](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/coder/json/encodeObject.ts#L8)* +*Defined in [coder/json/encodeObject.ts:8](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/coder/json/encodeObject.ts#L8)* **Parameters:** diff --git a/docs/api-provider/modules/_coder_json_index_.md b/docs/api-provider/modules/_coder_json_index_.md index 2f833b18f5..cbdfe6c5e7 100644 --- a/docs/api-provider/modules/_coder_json_index_.md +++ b/docs/api-provider/modules/_coder_json_index_.md @@ -8,7 +8,7 @@ ▸ **rpcCoder**(): [RpcCoder](_coder_json_types_d_.md#rpccoder) -*Defined in [coder/json/index.ts:12](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/coder/json/index.ts#L12)* +*Defined in [coder/json/index.ts:12](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/coder/json/index.ts#L12)* **Returns:** [RpcCoder](_coder_json_types_d_.md#rpccoder) diff --git a/docs/api-provider/modules/_coder_json_types_d_.md b/docs/api-provider/modules/_coder_json_types_d_.md index 6d430b81e9..05b7a3093d 100644 --- a/docs/api-provider/modules/_coder_json_types_d_.md +++ b/docs/api-provider/modules/_coder_json_types_d_.md @@ -8,7 +8,7 @@ **Ƭ RpcCoder**: *`object`* -*Defined in [coder/json/types.d.ts:7](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/coder/json/types.d.ts#L7)* +*Defined in [coder/json/types.d.ts:7](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/coder/json/types.d.ts#L7)* #### Type declaration @@ -19,7 +19,7 @@ ___ **Ƭ RpcCoderState**: *`object`* -*Defined in [coder/json/types.d.ts:14](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/coder/json/types.d.ts#L14)* +*Defined in [coder/json/types.d.ts:14](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/coder/json/types.d.ts#L14)* #### Type declaration diff --git a/docs/api-provider/modules/_http_types_d_.md b/docs/api-provider/modules/_http_types_d_.md index 39d7690352..d42ed0366c 100644 --- a/docs/api-provider/modules/_http_types_d_.md +++ b/docs/api-provider/modules/_http_types_d_.md @@ -8,7 +8,7 @@ **Ƭ HttpState**: *`object`* -*Defined in [http/types.d.ts:8](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/http/types.d.ts#L8)* +*Defined in [http/types.d.ts:8](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/http/types.d.ts#L8)* #### Type declaration diff --git a/docs/api-provider/modules/_mock_index_.md b/docs/api-provider/modules/_mock_index_.md index 89b263a40e..a5919d6c43 100644 --- a/docs/api-provider/modules/_mock_index_.md +++ b/docs/api-provider/modules/_mock_index_.md @@ -8,7 +8,7 @@ ▸ **mockProvider**(): [ProviderInterface](../interfaces/_types_d_.providerinterface.md) -*Defined in [mock/index.ts:18](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/mock/index.ts#L18)* +*Defined in [mock/index.ts:18](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/mock/index.ts#L18)* A moock provider mainly used for testing. diff --git a/docs/api-provider/modules/_mock_mocks_.md b/docs/api-provider/modules/_mock_mocks_.md index f85865bfb6..78cb449bda 100644 --- a/docs/api-provider/modules/_mock_mocks_.md +++ b/docs/api-provider/modules/_mock_mocks_.md @@ -8,7 +8,7 @@ ▸ **mocks**(__namedParameters: *`object`*): `void` -*Defined in [mock/mocks.ts:63](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/mock/mocks.ts#L63)* +*Defined in [mock/mocks.ts:63](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/mock/mocks.ts#L63)* **Parameters:** diff --git a/docs/api-provider/modules/_mock_on_.md b/docs/api-provider/modules/_mock_on_.md index cbe67437c5..6ba0813d34 100644 --- a/docs/api-provider/modules/_mock_on_.md +++ b/docs/api-provider/modules/_mock_on_.md @@ -8,7 +8,7 @@ ▸ **on**(self: *[MockState](_mock_types_d_.md#mockstate)*, type: *[ProviderInterface$Emitted](_types_d_.md#providerinterface_emitted)*, sub: *[ProviderInterface$EmitCb](_types_d_.md#providerinterface_emitcb)*): `void` -*Defined in [mock/on.ts:8](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/mock/on.ts#L8)* +*Defined in [mock/on.ts:8](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/mock/on.ts#L8)* **Parameters:** diff --git a/docs/api-provider/modules/_mock_send_.md b/docs/api-provider/modules/_mock_send_.md index 236853a566..6250f57ef0 100644 --- a/docs/api-provider/modules/_mock_send_.md +++ b/docs/api-provider/modules/_mock_send_.md @@ -8,7 +8,7 @@ ▸ **send**(__namedParameters: *`object`*, method: *`string`*, params: *`Array`<`any`>*): `Promise`<`any`> -*Defined in [mock/send.ts:7](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/mock/send.ts#L7)* +*Defined in [mock/send.ts:7](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/mock/send.ts#L7)* **Parameters:** diff --git a/docs/api-provider/modules/_mock_state_.md b/docs/api-provider/modules/_mock_state_.md index 7272790324..5ecddebfc9 100644 --- a/docs/api-provider/modules/_mock_state_.md +++ b/docs/api-provider/modules/_mock_state_.md @@ -8,7 +8,7 @@ ▸ **state**(): [MockState](_mock_types_d_.md#mockstate) -*Defined in [mock/state.ts:38](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/mock/state.ts#L38)* +*Defined in [mock/state.ts:38](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/mock/state.ts#L38)* **Returns:** [MockState](_mock_types_d_.md#mockstate) diff --git a/docs/api-provider/modules/_mock_subscribe_.md b/docs/api-provider/modules/_mock_subscribe_.md index 8f2443dfba..09c2f732fb 100644 --- a/docs/api-provider/modules/_mock_subscribe_.md +++ b/docs/api-provider/modules/_mock_subscribe_.md @@ -8,7 +8,7 @@ ▸ **subscribe**(self: *[MockState](_mock_types_d_.md#mockstate)*, type: *`string`*, method: *`string`*, params: *`Array`<`any`>*): `Promise`<`number`> -*Defined in [mock/subscribe.ts:7](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/mock/subscribe.ts#L7)* +*Defined in [mock/subscribe.ts:7](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/mock/subscribe.ts#L7)* **Parameters:** diff --git a/docs/api-provider/modules/_mock_types_d_.md b/docs/api-provider/modules/_mock_types_d_.md index b1a69ffa60..ef41ebf568 100644 --- a/docs/api-provider/modules/_mock_types_d_.md +++ b/docs/api-provider/modules/_mock_types_d_.md @@ -8,7 +8,7 @@ **Ƭ MockState**: *`object`* -*Defined in [mock/types.d.ts:27](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/mock/types.d.ts#L27)* +*Defined in [mock/types.d.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/mock/types.d.ts#L27)* #### Type declaration @@ -19,7 +19,7 @@ ___ **Ƭ MockState$Db**: *`object`* -*Defined in [mock/types.d.ts:19](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/mock/types.d.ts#L19)* +*Defined in [mock/types.d.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/mock/types.d.ts#L19)* #### Type declaration @@ -32,7 +32,7 @@ ___ **Ƭ MockState$Requests**: *`object`* -*Defined in [mock/types.d.ts:23](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/mock/types.d.ts#L23)* +*Defined in [mock/types.d.ts:23](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/mock/types.d.ts#L23)* #### Type declaration @@ -56,7 +56,7 @@ ___ **Ƭ MockState$Subscription$Callback**: *`function`* -*Defined in [mock/types.d.ts:8](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/mock/types.d.ts#L8)* +*Defined in [mock/types.d.ts:8](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/mock/types.d.ts#L8)* #### Type declaration ▸(error: * `Error` | `null`*, value: *`any`*): `void` @@ -77,7 +77,7 @@ ___ **Ƭ MockState$Subscriptions**: *`object`* -*Defined in [mock/types.d.ts:10](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/mock/types.d.ts#L10)* +*Defined in [mock/types.d.ts:10](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/mock/types.d.ts#L10)* #### Type declaration diff --git a/docs/api-provider/modules/_mock_unsubscribe_.md b/docs/api-provider/modules/_mock_unsubscribe_.md index 751c830e10..965372fc8c 100644 --- a/docs/api-provider/modules/_mock_unsubscribe_.md +++ b/docs/api-provider/modules/_mock_unsubscribe_.md @@ -8,7 +8,7 @@ ▸ **unsubscribe**(self: *[MockState](_mock_types_d_.md#mockstate)*, type: *`string`*, name: *`string`*, id: *`number`*): `Promise`<`boolean`> -*Defined in [mock/unsubscribe.ts:7](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/mock/unsubscribe.ts#L7)* +*Defined in [mock/unsubscribe.ts:7](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/mock/unsubscribe.ts#L7)* **Parameters:** diff --git a/docs/api-provider/modules/_types_d_.md b/docs/api-provider/modules/_types_d_.md index 7351bf1fae..0ac1b60a01 100644 --- a/docs/api-provider/modules/_types_d_.md +++ b/docs/api-provider/modules/_types_d_.md @@ -8,7 +8,7 @@ **Ƭ JsonRpcObject**: *`object`* -*Defined in [types.d.ts:5](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/types.d.ts#L5)* +*Defined in [types.d.ts:5](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/types.d.ts#L5)* #### Type declaration @@ -20,7 +20,7 @@ ___ **Ƭ JsonRpcRequest**: * [JsonRpcObject](_types_d_.md#jsonrpcobject) & `object` * -*Defined in [types.d.ts:10](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/types.d.ts#L10)* +*Defined in [types.d.ts:10](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/types.d.ts#L10)* ___ @@ -30,7 +30,7 @@ ___ **Ƭ JsonRpcResponse**: * [JsonRpcObject](_types_d_.md#jsonrpcobject) & [JsonRpcResponseBase](_types_d_.md#jsonrpcresponsebase) * -*Defined in [types.d.ts:36](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/types.d.ts#L36)* +*Defined in [types.d.ts:36](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/types.d.ts#L36)* ___ @@ -40,7 +40,7 @@ ___ **Ƭ JsonRpcResponseBase**: * `JsonRpcResponse$Single` & `JsonRpcResponse$Subscription` * -*Defined in [types.d.ts:34](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/types.d.ts#L34)* +*Defined in [types.d.ts:34](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/types.d.ts#L34)* ___ @@ -49,7 +49,7 @@ ___ **Ƭ JsonRpcResponseBase$Error**: *`object`* -*Defined in [types.d.ts:15](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/types.d.ts#L15)* +*Defined in [types.d.ts:15](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/types.d.ts#L15)* #### Type declaration @@ -60,7 +60,7 @@ ___ **Ƭ ProviderInterface$Callback**: *`function`* -*Defined in [types.d.ts:38](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/types.d.ts#L38)* +*Defined in [types.d.ts:38](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/types.d.ts#L38)* #### Type declaration ▸(error: * `Error` | `null`*, result: *`any`*): `void` @@ -81,7 +81,7 @@ ___ **Ƭ ProviderInterface$EmitCb**: *`function`* -*Defined in [types.d.ts:42](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/types.d.ts#L42)* +*Defined in [types.d.ts:42](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/types.d.ts#L42)* #### Type declaration ▸(value?: *`any`*): `any` @@ -102,7 +102,7 @@ ___ **Ƭ ProviderInterface$Emitted**: * "connected" | "disconnected" * -*Defined in [types.d.ts:40](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/types.d.ts#L40)* +*Defined in [types.d.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/types.d.ts#L40)* ___ diff --git a/docs/api-rx/classes/_index_.rxapi.html b/docs/api-rx/classes/_index_.rxapi.html index bd22129e38..e3e4b8261e 100644 --- a/docs/api-rx/classes/_index_.rxapi.html +++ b/docs/api-rx/classes/_index_.rxapi.html @@ -382,7 +382,7 @@

constructor

⊕ new RxApi(provider?: ProviderInterface): RxApi

-

Defined in index.ts:40

+

Defined in index.ts:40

Parameters:

@@ -408,28 +408,28 @@

author

● author: RxApiInterface$Section

-

Defined in index.ts:37

+

Defined in index.ts:37


chain

● chain: RxApiInterface$Section

-

Defined in index.ts:38

+

Defined in index.ts:38


state

● state: RxApiInterface$Section

-

Defined in index.ts:39

+

Defined in index.ts:39


system

● system: RxApiInterface$Section

-

Defined in index.ts:40

+

Defined in index.ts:40


Methods

isConnected

▸ isConnected(): BehaviorSubject<boolean>

-

Defined in index.ts:59

+

Defined in index.ts:59

Returns: BehaviorSubject<boolean>


@@ -475,7 +475,7 @@ diff --git a/docs/api-rx/classes/_index_.rxapi.md b/docs/api-rx/classes/_index_.rxapi.md index f239e0670d..0c2c8dcace 100644 --- a/docs/api-rx/classes/_index_.rxapi.md +++ b/docs/api-rx/classes/_index_.rxapi.md @@ -21,7 +21,7 @@ const provider = new WsProvider('[http://127.0.0.1:9944')](http://127.0.0.1:9944 ⊕ **new RxApi**(provider?: *`ProviderInterface`*): [RxApi](_index_.rxapi.md) -*Defined in [index.ts:40](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-rx/src/index.ts#L40)* +*Defined in [index.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-rx/src/index.ts#L40)* **Parameters:** @@ -41,7 +41,7 @@ ___ **● author**: *[RxApiInterface$Section](../modules/_types_d_.md#rxapiinterface_section)* -*Defined in [index.ts:37](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-rx/src/index.ts#L37)* +*Defined in [index.ts:37](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-rx/src/index.ts#L37)* ___ @@ -50,7 +50,7 @@ ___ **● chain**: *[RxApiInterface$Section](../modules/_types_d_.md#rxapiinterface_section)* -*Defined in [index.ts:38](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-rx/src/index.ts#L38)* +*Defined in [index.ts:38](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-rx/src/index.ts#L38)* ___ @@ -59,7 +59,7 @@ ___ **● state**: *[RxApiInterface$Section](../modules/_types_d_.md#rxapiinterface_section)* -*Defined in [index.ts:39](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-rx/src/index.ts#L39)* +*Defined in [index.ts:39](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-rx/src/index.ts#L39)* ___ @@ -68,7 +68,7 @@ ___ **● system**: *[RxApiInterface$Section](../modules/_types_d_.md#rxapiinterface_section)* -*Defined in [index.ts:40](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-rx/src/index.ts#L40)* +*Defined in [index.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-rx/src/index.ts#L40)* ___ @@ -80,7 +80,7 @@ ___ ▸ **isConnected**(): `BehaviorSubject`<`boolean`> -*Defined in [index.ts:59](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-rx/src/index.ts#L59)* +*Defined in [index.ts:59](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-rx/src/index.ts#L59)* **Returns:** `BehaviorSubject`<`boolean`> diff --git a/docs/api-rx/index.html b/docs/api-rx/index.html index f038f8f05f..d08e630d73 100644 --- a/docs/api-rx/index.html +++ b/docs/api-rx/index.html @@ -415,7 +415,7 @@ diff --git a/docs/api-rx/modules/_types_d_.md b/docs/api-rx/modules/_types_d_.md index 3fa8f770bf..e69dc90e32 100644 --- a/docs/api-rx/modules/_types_d_.md +++ b/docs/api-rx/modules/_types_d_.md @@ -8,7 +8,7 @@ **Ƭ RxApiInterface**: *`object`* -*Defined in [types.d.ts:15](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-rx/src/types.d.ts#L15)* +*Defined in [types.d.ts:15](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-rx/src/types.d.ts#L15)* #### Type declaration @@ -19,7 +19,7 @@ ___ **Ƭ RxApiInterface$Method**: *`function`* -*Defined in [types.d.ts:9](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-rx/src/types.d.ts#L9)* +*Defined in [types.d.ts:9](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-rx/src/types.d.ts#L9)* #### Type declaration ▸(...params: *`Array`<`any`>*): `Observable`<`any`> | `BehaviorSubject`<`any`> @@ -39,7 +39,7 @@ ___ **Ƭ RxApiInterface$Section**: *`object`* -*Defined in [types.d.ts:11](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-rx/src/types.d.ts#L11)* +*Defined in [types.d.ts:11](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-rx/src/types.d.ts#L11)* #### Type declaration diff --git a/docs/api/classes/_index_.api.html b/docs/api/classes/_index_.api.html index 000a83790f..e02758d0f7 100644 --- a/docs/api/classes/_index_.api.html +++ b/docs/api/classes/_index_.api.html @@ -381,7 +381,7 @@

constructor

⊕ new Api(provider: ProviderInterface): Api

-

Defined in index.ts:29

+

Defined in index.ts:29

constructor: Default constructor for the Api Object

Parameters:

@@ -406,28 +406,28 @@

author

● author: ApiInterface$Section

-

Defined in index.ts:26

+

Defined in index.ts:26


chain

● chain: ApiInterface$Section

-

Defined in index.ts:27

+

Defined in index.ts:27


state

● state: ApiInterface$Section

-

Defined in index.ts:28

+

Defined in index.ts:28


system

● system: ApiInterface$Section

-

Defined in index.ts:29

+

Defined in index.ts:29


Methods

<Static> signature

▸ signature(__namedParameters: object): string

-

Defined in index.ts:58

+

Defined in index.ts:58

name: signature

signature: jsonrpcSignature (method: InterfaceMethodDefinition): string

summary: Returns a string representation of the method with inputs and outputs.

@@ -494,7 +494,7 @@ diff --git a/docs/api/classes/_index_.api.md b/docs/api/classes/_index_.api.md index 7b85098362..efbeaf2157 100644 --- a/docs/api/classes/_index_.api.md +++ b/docs/api/classes/_index_.api.md @@ -20,7 +20,7 @@ const provider = new WsProvider('[http://127.0.0.1:9944')](http://127.0.0.1:9944 ⊕ **new Api**(provider: *`ProviderInterface`*): [Api](_index_.api.md) -*Defined in [index.ts:29](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api/src/index.ts#L29)* +*Defined in [index.ts:29](https://github.com/polkadot-js/api/blob/48e57f9/packages/api/src/index.ts#L29)* *__constructor__*: Default constructor for the Api Object @@ -42,7 +42,7 @@ ___ **● author**: *[ApiInterface$Section](../modules/_types_d_.md#apiinterface_section)* -*Defined in [index.ts:26](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api/src/index.ts#L26)* +*Defined in [index.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/api/src/index.ts#L26)* ___ @@ -51,7 +51,7 @@ ___ **● chain**: *[ApiInterface$Section](../modules/_types_d_.md#apiinterface_section)* -*Defined in [index.ts:27](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api/src/index.ts#L27)* +*Defined in [index.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/api/src/index.ts#L27)* ___ @@ -60,7 +60,7 @@ ___ **● state**: *[ApiInterface$Section](../modules/_types_d_.md#apiinterface_section)* -*Defined in [index.ts:28](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api/src/index.ts#L28)* +*Defined in [index.ts:28](https://github.com/polkadot-js/api/blob/48e57f9/packages/api/src/index.ts#L28)* ___ @@ -69,7 +69,7 @@ ___ **● system**: *[ApiInterface$Section](../modules/_types_d_.md#apiinterface_section)* -*Defined in [index.ts:29](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api/src/index.ts#L29)* +*Defined in [index.ts:29](https://github.com/polkadot-js/api/blob/48e57f9/packages/api/src/index.ts#L29)* ___ @@ -81,7 +81,7 @@ ___ ▸ **signature**(__namedParameters: *`object`*): `string` -*Defined in [index.ts:58](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api/src/index.ts#L58)* +*Defined in [index.ts:58](https://github.com/polkadot-js/api/blob/48e57f9/packages/api/src/index.ts#L58)* *__name__*: signature diff --git a/docs/api/index.html b/docs/api/index.html index decfe27c1d..ca842e4566 100644 --- a/docs/api/index.html +++ b/docs/api/index.html @@ -461,7 +461,7 @@ diff --git a/docs/api/interfaces/_types_d_.apiinterface_section_method.md b/docs/api/interfaces/_types_d_.apiinterface_section_method.md index ac1881cb57..87c7ec410a 100644 --- a/docs/api/interfaces/_types_d_.apiinterface_section_method.md +++ b/docs/api/interfaces/_types_d_.apiinterface_section_method.md @@ -7,7 +7,7 @@ # Callable ▸ **__call**(...params: *`Array`<`any`>*): `Promise`<`any`> -*Defined in [types.d.ts:7](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api/src/types.d.ts#L7)* +*Defined in [types.d.ts:7](https://github.com/polkadot-js/api/blob/48e57f9/packages/api/src/types.d.ts#L7)* **Parameters:** @@ -25,7 +25,7 @@ **● subscription**: *`string`* -*Defined in [types.d.ts:10](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api/src/types.d.ts#L10)* +*Defined in [types.d.ts:10](https://github.com/polkadot-js/api/blob/48e57f9/packages/api/src/types.d.ts#L10)* ___ @@ -34,7 +34,7 @@ ___ **● unsubscribe**: *`function`* -*Defined in [types.d.ts:11](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api/src/types.d.ts#L11)* +*Defined in [types.d.ts:11](https://github.com/polkadot-js/api/blob/48e57f9/packages/api/src/types.d.ts#L11)* #### Type declaration ▸(id: *`number`*): `Promise`<`any`> diff --git a/docs/api/modules/_types_d_.md b/docs/api/modules/_types_d_.md index b71e371f7a..24547c590e 100644 --- a/docs/api/modules/_types_d_.md +++ b/docs/api/modules/_types_d_.md @@ -8,7 +8,7 @@ **Ƭ ApiInterface**: *`object`* -*Defined in [types.d.ts:18](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api/src/types.d.ts#L18)* +*Defined in [types.d.ts:18](https://github.com/polkadot-js/api/blob/48e57f9/packages/api/src/types.d.ts#L18)* #### Type declaration @@ -19,7 +19,7 @@ ___ **Ƭ ApiInterface$Section**: *`object`* -*Defined in [types.d.ts:14](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api/src/types.d.ts#L14)* +*Defined in [types.d.ts:14](https://github.com/polkadot-js/api/blob/48e57f9/packages/api/src/types.d.ts#L14)* #### Type declaration diff --git a/docs/examples/01_simple_connect/index.html b/docs/examples/01_simple_connect/index.html index 4ba6c2f521..ccd160772c 100644 --- a/docs/examples/01_simple_connect/index.html +++ b/docs/examples/01_simple_connect/index.html @@ -431,7 +431,7 @@ main().finally(_ => process.exit()); diff --git a/docs/examples/02_listen_to_blocks/index.html b/docs/examples/02_listen_to_blocks/index.html index 4558e4aadc..956260148d 100644 --- a/docs/examples/02_listen_to_blocks/index.html +++ b/docs/examples/02_listen_to_blocks/index.html @@ -433,7 +433,7 @@ main(); diff --git a/docs/examples/03_listen_to_balance_change/index.html b/docs/examples/03_listen_to_balance_change/index.html index 3ecb2a5807..8499a481fc 100644 --- a/docs/examples/03_listen_to_balance_change/index.html +++ b/docs/examples/03_listen_to_balance_change/index.html @@ -432,7 +432,7 @@ api.state diff --git a/docs/examples/04_generate_account/index.html b/docs/examples/04_generate_account/index.html index 635d617e20..61dcded4d2 100644 --- a/docs/examples/04_generate_account/index.html +++ b/docs/examples/04_generate_account/index.html @@ -447,7 +447,7 @@ diff --git a/docs/examples/05_read_storage/index.html b/docs/examples/05_read_storage/index.html index 5339a99946..1726dfe7a9 100644 --- a/docs/examples/05_read_storage/index.html +++ b/docs/examples/05_read_storage/index.html @@ -447,7 +447,7 @@ main().finally(_ => process.exit()); diff --git a/docs/examples/06_craft_extrinsic/index.html b/docs/examples/06_craft_extrinsic/index.html index 78c479078e..a906a1f38a 100644 --- a/docs/examples/06_craft_extrinsic/index.html +++ b/docs/examples/06_craft_extrinsic/index.html @@ -471,7 +471,7 @@ transfer(Alice, addressBob, amount) diff --git a/docs/examples/07_transfer_dots/index.html b/docs/examples/07_transfer_dots/index.html index be266ad24b..450c23b4e7 100644 --- a/docs/examples/07_transfer_dots/index.html +++ b/docs/examples/07_transfer_dots/index.html @@ -451,7 +451,7 @@ transfer(Alice, addressBob, amount) diff --git a/docs/examples/index.html b/docs/examples/index.html index 62cf081ca3..6ac0acf26a 100644 --- a/docs/examples/index.html +++ b/docs/examples/index.html @@ -427,7 +427,7 @@ diff --git a/docs/index.html b/docs/index.html index 11f15d5a52..4d2a527a0b 100644 --- a/docs/index.html +++ b/docs/index.html @@ -447,7 +447,7 @@ diff --git a/docs/types/README.md b/docs/types/README.md new file mode 100644 index 0000000000..fc226972ae --- /dev/null +++ b/docs/types/README.md @@ -0,0 +1,6 @@ + +@polkadot/types +=============== + +Implementation of the types and their serialisation via parity-codec + diff --git a/docs/types/SUMMARY.md b/docs/types/SUMMARY.md new file mode 100644 index 0000000000..ae84a46d8b --- /dev/null +++ b/docs/types/SUMMARY.md @@ -0,0 +1,151 @@ +* ["AccountId"](modules/_accountid_.md) + * [AccountId](classes/_accountid_.accountid.md) +* ["AccountIndex"](modules/_accountindex_.md) + * [AccountIndex](classes/_accountindex_.accountindex.md) +* ["Address"](modules/_address_.md) + * [Address](classes/_address_.address.md) +* ["AuthorityId"](modules/_authorityid_.md) + * [AuthorityId](classes/_authorityid_.authorityid.md) +* ["Balance"](modules/_balance_.md) + * [Balance](classes/_balance_.balance.md) +* ["Bft"](modules/_bft_.md) + * [BftAuthoritySignature](classes/_bft_.bftauthoritysignature.md) + * [BftHashSignature](classes/_bft_.bfthashsignature.md) + * [Justification](classes/_bft_.justification.md) +* ["Block"](modules/_block_.md) + * [Block](classes/_block_.block.md) +* ["BlockNumber"](modules/_blocknumber_.md) + * [BlockNumber](classes/_blocknumber_.blocknumber.md) +* ["Bool"](modules/_bool_.md) + * [Bool](classes/_bool_.bool.md) +* ["Bytes"](modules/_bytes_.md) + * [Bytes](classes/_bytes_.bytes.md) +* ["Extrinsic"](modules/_extrinsic_.md) + * [Extrinsic](classes/_extrinsic_.extrinsic.md) +* ["Extrinsics"](modules/_extrinsics_.md) + * [Extrinsics](classes/_extrinsics_.extrinsics.md) +* ["Gas"](modules/_gas_.md) + * [Gas](classes/_gas_.gas.md) +* ["H256"](modules/_h256_.md) + * [H256](classes/_h256_.h256.md) +* ["H512"](modules/_h512_.md) + * [H512](classes/_h512_.h512.md) +* ["Hash"](modules/_hash_.md) + * [Hash](classes/_hash_.hash.md) +* ["Header"](modules/_header_.md) + * [Digest](classes/_header_.digest.md) + * [Header](classes/_header_.header.md) +* ["KeyValue"](modules/_keyvalue_.md) + * [KeyValue](classes/_keyvalue_.keyvalue.md) + * [KeyValueOption](classes/_keyvalue_.keyvalueoption.md) +* ["Metadata"](modules/_metadata_.md) + * [CallMetadata](classes/_metadata_.callmetadata.md) + * [EventMetadata](classes/_metadata_.eventmetadata.md) + * [FunctionArgumentMetadata](classes/_metadata_.functionargumentmetadata.md) + * [FunctionMetadata](classes/_metadata_.functionmetadata.md) + * [ModuleMetadata](classes/_metadata_.modulemetadata.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) + * [StorageFunctionType](classes/_metadata_.storagefunctiontype.md) + * [StorageFunctionType$Map](classes/_metadata_.storagefunctiontype_map.md) + * [StorageMetadata](classes/_metadata_.storagemetadata.md) +* ["Metadata.rpc"](modules/_metadata_rpc_.md) +* ["MisbehaviorReport"](modules/_misbehaviorreport_.md) + * [BftAtReport](classes/_misbehaviorreport_.bftatreport.md) + * [BftDoubleCommit](classes/_misbehaviorreport_.bftdoublecommit.md) + * [BftDoublePrepare](classes/_misbehaviorreport_.bftdoubleprepare.md) + * [MisbehaviorKind](classes/_misbehaviorreport_.misbehaviorkind.md) + * [MisbehaviorReport](classes/_misbehaviorreport_.misbehaviorreport.md) +* ["Moment"](modules/_moment_.md) + * [Moment](classes/_moment_.moment.md) +* ["NewAccountOutcome"](modules/_newaccountoutcome_.md) + * [NewAccountOutcome](classes/_newaccountoutcome_.newaccountoutcome.md) +* ["Nonce"](modules/_nonce_.md) + * [Index](classes/_nonce_.index.md) +* ["Origin"](modules/_origin_.md) + * [Origin](classes/_origin_.origin.md) +* ["ParachainId"](modules/_parachainid_.md) + * [ParachainId](classes/_parachainid_.parachainid.md) +* ["PendingExtrinsics"](modules/_pendingextrinsics_.md) + * [PendingExtrinsics](classes/_pendingextrinsics_.pendingextrinsics.md) +* ["Perbill"](modules/_perbill_.md) + * [Perbill](classes/_perbill_.perbill.md) +* ["Permill"](modules/_permill_.md) + * [Permill](classes/_permill_.permill.md) +* ["PropIndex"](modules/_propindex_.md) + * [PropIndex](classes/_propindex_.propindex.md) +* ["Proposal"](modules/_proposal_.md) + * [Proposal](classes/_proposal_.proposal.md) +* ["ProposalIndex"](modules/_proposalindex_.md) + * [ProposalIndex](classes/_proposalindex_.proposalindex.md) +* ["RawAddress"](modules/_rawaddress_.md) + * [RawAddress](classes/_rawaddress_.rawaddress.md) +* ["ReferendumIndex"](modules/_referendumindex_.md) + * [ReferendumIndex](classes/_referendumindex_.referendumindex.md) +* ["RuntimeVersion"](modules/_runtimeversion_.md) + * [RuntimeVersion](classes/_runtimeversion_.runtimeversion.md) +* ["Signature"](modules/_signature_.md) + * [Signature](classes/_signature_.signature.md) +* ["SignedBlock"](modules/_signedblock_.md) + * [SignedBlock](classes/_signedblock_.signedblock.md) +* ["StorageChangeSet"](modules/_storagechangeset_.md) + * [StorageChangeSet](classes/_storagechangeset_.storagechangeset.md) +* ["StorageData"](modules/_storagedata_.md) + * [StorageData](classes/_storagedata_.storagedata.md) +* ["StorageKey"](modules/_storagekey_.md) + * [StorageKey](classes/_storagekey_.storagekey.md) + * [StorageFunction](interfaces/_storagekey_.storagefunction.md) +* ["Text"](modules/_text_.md) + * [Text](classes/_text_.text.md) +* ["Type"](modules/_type_.md) + * [Type](classes/_type_.type.md) +* ["U128"](modules/_u128_.md) + * [U128](classes/_u128_.u128.md) +* ["U16"](modules/_u16_.md) + * [U16](classes/_u16_.u16.md) +* ["U256"](modules/_u256_.md) + * [U256](classes/_u256_.u256.md) +* ["U32"](modules/_u32_.md) + * [U32](classes/_u32_.u32.md) +* ["U64"](modules/_u64_.md) + * [U64](classes/_u64_.u64.md) +* ["U8"](modules/_u8_.md) + * [U8](classes/_u8_.u8.md) +* ["ValidatorPrefs"](modules/_validatorprefs_.md) + * [ValidatorPrefs](classes/_validatorprefs_.validatorprefs.md) +* ["VoteIndex"](modules/_voteindex_.md) + * [VoteIndex](classes/_voteindex_.voteindex.md) +* ["VoteThreshold"](modules/_votethreshold_.md) + * [VoteThreshold](classes/_votethreshold_.votethreshold.md) +* ["codec/Base"](modules/_codec_base_.md) + * [Base](classes/_codec_base_.base.md) +* ["codec/Compact"](modules/_codec_compact_.md) + * [Compact](classes/_codec_compact_.compact.md) +* ["codec/Enum"](modules/_codec_enum_.md) + * [Enum](classes/_codec_enum_.enum.md) +* ["codec/EnumType"](modules/_codec_enumtype_.md) + * [EnumType](classes/_codec_enumtype_.enumtype.md) +* ["codec/Length"](modules/_codec_length_.md) + * [Length](classes/_codec_length_.length.md) +* ["codec/Option"](modules/_codec_option_.md) + * [Option](classes/_codec_option_.option.md) +* ["codec/Struct"](modules/_codec_struct_.md) + * [Struct](classes/_codec_struct_.struct.md) +* ["codec/Tuple"](modules/_codec_tuple_.md) + * [Tuple](classes/_codec_tuple_.tuple.md) +* ["codec/U8a"](modules/_codec_u8a_.md) + * [U8a](classes/_codec_u8a_.u8a.md) +* ["codec/U8aFixed"](modules/_codec_u8afixed_.md) + * [U8aFixed](classes/_codec_u8afixed_.u8afixed.md) +* ["codec/UInt"](modules/_codec_uint_.md) + * [UInt](classes/_codec_uint_.uint.md) +* ["codec/Vector"](modules/_codec_vector_.md) + * [Vector](classes/_codec_vector_.vector.md) +* ["codec/createType"](modules/_codec_createtype_.md) +* ["codec/index"](modules/_codec_index_.md) +* ["index"](modules/_index_.md) +* ["types.d"](modules/_types_d_.md) diff --git a/docs/types/classes/_accountid_.accountid.md b/docs/types/classes/_accountid_.accountid.md new file mode 100644 index 0000000000..46a05613f7 --- /dev/null +++ b/docs/types/classes/_accountid_.accountid.md @@ -0,0 +1,223 @@ + + +# Hierarchy + +↳ [U8aFixed](_codec_u8afixed_.u8afixed.md) + +**↳ AccountId** + +↳ [AuthorityId](_authorityid_.authorityid.md) + +# Constructors + + + +## constructor + +⊕ **new AccountId**(value?: *[AnyU8a](../modules/_types_d_.md#anyu8a)*): [AccountId](_accountid_.accountid.md) + +*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* + +*Defined in [AccountId.ts:20](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/AccountId.ts#L20)* + +**Parameters:** + +| Param | Type | Default value | +| ------ | ------ | ------ | +| `Default value` value | [AnyU8a](../modules/_types_d_.md#anyu8a) | new Uint8Array() | + +**Returns:** [AccountId](_accountid_.accountid.md) + +___ + +# Properties + + + +## `` _bitLength + +**● _bitLength**: *`number`* + +*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[_bitLength](_codec_u8afixed_.u8afixed.md#_bitlength)* + +*Defined in [codec/U8aFixed.ts:14](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8aFixed.ts#L14)* + +___ + + +## raw + +**● raw**: *`Uint8Array`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## length + +getlength(): `number` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* + +*Defined in [codec/U8a.ts:25](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L25)* + +**Returns:** `number` + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[byteLength](_codec_u8afixed_.u8afixed.md#bytelength)* + +*Overrides [U8a](_codec_u8a_.u8a.md).[byteLength](_codec_u8a_.u8a.md#bytelength)* + +*Defined in [codec/U8aFixed.ts:28](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8aFixed.ts#L28)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [AccountId](_accountid_.accountid.md) + +*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[fromJSON](_codec_u8afixed_.u8afixed.md#fromjson)* + +*Defined in [AccountId.ts:44](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/AccountId.ts#L44)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [AccountId](_accountid_.accountid.md) + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [AccountId](_accountid_.accountid.md) + +*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[fromU8a](_codec_u8afixed_.u8afixed.md#fromu8a)* + +*Defined in [AccountId.ts:50](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/AccountId.ts#L50)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [AccountId](_accountid_.accountid.md) + +___ + + +## toHex + +▸ **toHex**(): `string` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* + +*Defined in [codec/U8a.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L45)* + +**Returns:** `string` + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Overrides [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* + +*Defined in [AccountId.ts:56](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/AccountId.ts#L56)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Overrides [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* + +*Defined in [AccountId.ts:60](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/AccountId.ts#L60)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L53)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## `` decode + +▸ **decode**(value: * `string` | `Uint8Array` | `Array`<`number`>*): `Uint8Array` + +*Defined in [AccountId.ts:34](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/AccountId.ts#L34)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| value | `string` | `Uint8Array` | `Array`<`number`>| + +**Returns:** `Uint8Array` + +___ + + +## `` encode + +▸ **encode**(value: *`Uint8Array`*): `string` + +*Defined in [AccountId.ts:30](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/AccountId.ts#L30)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| value | `Uint8Array` | + +**Returns:** `string` + +___ + diff --git a/docs/types/classes/_accountindex_.accountindex.md b/docs/types/classes/_accountindex_.accountindex.md new file mode 100644 index 0000000000..7fb979849e --- /dev/null +++ b/docs/types/classes/_accountindex_.accountindex.md @@ -0,0 +1,210 @@ + + +# Hierarchy + +↳ [U8a](_codec_u8a_.u8a.md) + +**↳ AccountIndex** + +# Constructors + + + +## constructor + +⊕ **new AccountIndex**(value?: *[AnyU8a](../modules/_types_d_.md#anyu8a)*): [AccountIndex](_accountindex_.accountindex.md) + +*Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* + +*Defined in [AccountIndex.ts:15](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/AccountIndex.ts#L15)* + +**Parameters:** + +| Param | Type | Default value | +| ------ | ------ | ------ | +| `Default value` value | [AnyU8a](../modules/_types_d_.md#anyu8a) | new Uint8Array() | + +**Returns:** [AccountIndex](_accountindex_.accountindex.md) + +___ + +# Properties + + + +## raw + +**● raw**: *`Uint8Array`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## length + +getlength(): `number` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* + +*Defined in [codec/U8a.ts:25](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L25)* + +**Returns:** `number` + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[byteLength](_codec_u8a_.u8a.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/U8a.ts:29](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L29)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [AccountIndex](_accountindex_.accountindex.md) + +*Overrides [U8a](_codec_u8a_.u8a.md).[fromJSON](_codec_u8a_.u8a.md#fromjson)* + +*Defined in [AccountIndex.ts:34](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/AccountIndex.ts#L34)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [AccountIndex](_accountindex_.accountindex.md) + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [AccountIndex](_accountindex_.accountindex.md) + +*Overrides [U8a](_codec_u8a_.u8a.md).[fromU8a](_codec_u8a_.u8a.md#fromu8a)* + +*Defined in [AccountIndex.ts:43](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/AccountIndex.ts#L43)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [AccountIndex](_accountindex_.accountindex.md) + +___ + + +## toHex + +▸ **toHex**(): `string` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* + +*Defined in [codec/U8a.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L45)* + +**Returns:** `string` + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Overrides [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* + +*Defined in [AccountIndex.ts:49](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/AccountIndex.ts#L49)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Overrides [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* + +*Defined in [AccountIndex.ts:53](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/AccountIndex.ts#L53)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L53)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## `` decode + +▸ **decode**(value: * `string` | `Uint8Array` | `Array`<`number`>*): `Uint8Array` + +*Defined in [AccountIndex.ts:30](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/AccountIndex.ts#L30)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| value | `string` | `Uint8Array` | `Array`<`number`>| + +**Returns:** `Uint8Array` + +___ + + +## `` encode + +▸ **encode**(value: *`Uint8Array`*): `string` + +*Defined in [AccountIndex.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/AccountIndex.ts#L26)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| value | `Uint8Array` | + +**Returns:** `string` + +___ + diff --git a/docs/types/classes/_address_.address.md b/docs/types/classes/_address_.address.md new file mode 100644 index 0000000000..896d7c23fc --- /dev/null +++ b/docs/types/classes/_address_.address.md @@ -0,0 +1,197 @@ + + +# Hierarchy + + [Base](_codec_base_.base.md)< [AccountId](_accountid_.accountid.md) | [AccountIndex](_accountindex_.accountindex.md)> + +**↳ Address** + +↳ [RawAddress](_rawaddress_.rawaddress.md) + +# Constructors + + + +## constructor + +⊕ **new Address**(value?: * [Address](_address_.address.md) | [AccountId](_accountid_.accountid.md) | [AccountIndex](_accountindex_.accountindex.md) | `string` | `Uint8Array`*): [Address](_address_.address.md) + +*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* + +*Defined in [Address.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Address.ts#L19)* + +**Parameters:** + +| Param | Type | Default value | +| ------ | ------ | ------ | +| `Default value` value | [Address](_address_.address.md) | [AccountId](_accountid_.accountid.md) | [AccountIndex](_accountindex_.accountindex.md) | `string` | `Uint8Array`| new Uint8Array() | + +**Returns:** [Address](_address_.address.md) + +___ + +# Properties + + + +## raw + +**● raw**: * [AccountId](_accountid_.accountid.md) | [AccountIndex](_accountindex_.accountindex.md) +* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [Address.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Address.ts#L86)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Address](_address_.address.md) + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [Address.ts:90](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Address.ts#L90)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Address](_address_.address.md) + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Address](_address_.address.md) + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [Address.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Address.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Address](_address_.address.md) + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [Address.ts:109](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Address.ts#L109)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [Address.ts:113](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Address.ts#L113)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [Address.ts:117](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Address.ts#L117)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## `` decode + +▸ **decode**(value: * [AccountId](_accountid_.accountid.md) | [AccountIndex](_accountindex_.accountindex.md) | `string` | `Uint8Array` | `Array`<`number`>*): [AccountId](_accountid_.accountid.md) | [AccountIndex](_accountindex_.accountindex.md) + +*Defined in [Address.ts:28](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Address.ts#L28)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| value | [AccountId](_accountid_.accountid.md) | [AccountIndex](_accountindex_.accountindex.md) | `string` | `Uint8Array` | `Array`<`number`>| + +**Returns:** [AccountId](_accountid_.accountid.md) | [AccountIndex](_accountindex_.accountindex.md) + +___ + + +## `` readLength + +▸ **readLength**(input: *`Uint8Array`*): `number` + +*Defined in [Address.ts:52](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Address.ts#L52)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** `number` + +___ + + +## `` writeLength + +▸ **writeLength**(length: *`number`*): `Uint8Array` + +*Defined in [Address.ts:70](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Address.ts#L70)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| length | `number` | + +**Returns:** `Uint8Array` + +___ + diff --git a/docs/types/classes/_authorityid_.authorityid.md b/docs/types/classes/_authorityid_.authorityid.md new file mode 100644 index 0000000000..9db28107d2 --- /dev/null +++ b/docs/types/classes/_authorityid_.authorityid.md @@ -0,0 +1,235 @@ + + +# Hierarchy + +↳ [AccountId](_accountid_.accountid.md) + +**↳ AuthorityId** + +# Constructors + + + +## constructor + +⊕ **new AuthorityId**(value?: *[AnyU8a](../modules/_types_d_.md#anyu8a)*): [AuthorityId](_authorityid_.authorityid.md) + +*Inherited from [AccountId](_accountid_.accountid.md).[constructor](_accountid_.accountid.md#constructor)* + +*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* + +*Defined in [AccountId.ts:20](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/AccountId.ts#L20)* + +**Parameters:** + +| Param | Type | Default value | +| ------ | ------ | ------ | +| `Default value` value | [AnyU8a](../modules/_types_d_.md#anyu8a) | new Uint8Array() | + +**Returns:** [AuthorityId](_authorityid_.authorityid.md) + +___ + +# Properties + + + +## `` _bitLength + +**● _bitLength**: *`number`* + +*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[_bitLength](_codec_u8afixed_.u8afixed.md#_bitlength)* + +*Defined in [codec/U8aFixed.ts:14](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8aFixed.ts#L14)* + +___ + + +## raw + +**● raw**: *`Uint8Array`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## length + +getlength(): `number` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* + +*Defined in [codec/U8a.ts:25](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L25)* + +**Returns:** `number` + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[byteLength](_codec_u8afixed_.u8afixed.md#bytelength)* + +*Overrides [U8a](_codec_u8a_.u8a.md).[byteLength](_codec_u8a_.u8a.md#bytelength)* + +*Defined in [codec/U8aFixed.ts:28](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8aFixed.ts#L28)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [AccountId](_accountid_.accountid.md) + +*Inherited from [AccountId](_accountid_.accountid.md).[fromJSON](_accountid_.accountid.md#fromjson)* + +*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[fromJSON](_codec_u8afixed_.u8afixed.md#fromjson)* + +*Defined in [AccountId.ts:44](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/AccountId.ts#L44)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [AccountId](_accountid_.accountid.md) + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [AccountId](_accountid_.accountid.md) + +*Inherited from [AccountId](_accountid_.accountid.md).[fromU8a](_accountid_.accountid.md#fromu8a)* + +*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[fromU8a](_codec_u8afixed_.u8afixed.md#fromu8a)* + +*Defined in [AccountId.ts:50](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/AccountId.ts#L50)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [AccountId](_accountid_.accountid.md) + +___ + + +## toHex + +▸ **toHex**(): `string` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* + +*Defined in [codec/U8a.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L45)* + +**Returns:** `string` + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [AccountId](_accountid_.accountid.md).[toJSON](_accountid_.accountid.md#tojson)* + +*Overrides [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* + +*Defined in [AccountId.ts:56](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/AccountId.ts#L56)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [AccountId](_accountid_.accountid.md).[toString](_accountid_.accountid.md#tostring)* + +*Overrides [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* + +*Defined in [AccountId.ts:60](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/AccountId.ts#L60)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L53)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## `` decode + +▸ **decode**(value: * `string` | `Uint8Array` | `Array`<`number`>*): `Uint8Array` + +*Inherited from [AccountId](_accountid_.accountid.md).[decode](_accountid_.accountid.md#decode)* + +*Defined in [AccountId.ts:34](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/AccountId.ts#L34)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| value | `string` | `Uint8Array` | `Array`<`number`>| + +**Returns:** `Uint8Array` + +___ + + +## `` encode + +▸ **encode**(value: *`Uint8Array`*): `string` + +*Inherited from [AccountId](_accountid_.accountid.md).[encode](_accountid_.accountid.md#encode)* + +*Defined in [AccountId.ts:30](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/AccountId.ts#L30)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| value | `Uint8Array` | + +**Returns:** `string` + +___ + diff --git a/docs/types/classes/_balance_.balance.md b/docs/types/classes/_balance_.balance.md new file mode 100644 index 0000000000..6f6ffa9aec --- /dev/null +++ b/docs/types/classes/_balance_.balance.md @@ -0,0 +1,399 @@ + + +# Hierarchy + +↳ [U128](_u128_.u128.md) + +**↳ Balance** + +# Constructors + + + +## constructor + +⊕ **new Balance**(value?: *[AnyNumber](../modules/_types_d_.md#anynumber)*): [Balance](_balance_.balance.md) + +*Inherited from [U128](_u128_.u128.md).[constructor](_u128_.u128.md#constructor)* + +*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* + +*Defined in [U128.ts:9](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/U128.ts#L9)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | [AnyNumber](../modules/_types_d_.md#anynumber) | + +**Returns:** [Balance](_balance_.balance.md) + +___ + +# Properties + + + +## raw + +**● raw**: *`BN`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Methods + + + +## add + +▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* + +*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L95)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [UInt](_codec_uint_.uint.md).[byteLength](_codec_uint_.uint.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/UInt.ts:53](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L53)* + +**Returns:** `number` + +___ + + +## cmp + +▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` + +*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* + +*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `number` + +___ + + +## div + +▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* + +*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L107)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [UInt](_codec_uint_.uint.md) + +*Inherited from [UInt](_codec_uint_.uint.md).[fromJSON](_codec_uint_.uint.md#fromjson)* + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L57)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [UInt](_codec_uint_.uint.md) + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [UInt](_codec_uint_.uint.md) + +*Inherited from [UInt](_codec_uint_.uint.md).[fromU8a](_codec_uint_.uint.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/UInt.ts:63](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L63)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [UInt](_codec_uint_.uint.md) + +___ + + +## gt + +▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* + +*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L129)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## gte + +▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* + +*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L135)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## isZero + +▸ **isZero**(): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* + +*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L113)* + +**Returns:** `boolean` + +___ + + +## lt + +▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* + +*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L117)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## lte + +▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* + +*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L123)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## mul + +▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* + +*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L141)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## sub + +▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* + +*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L147)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## toBn + +▸ **toBn**(): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* + +*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L85)* + +**Returns:** `BN` + +___ + + +## toHex + +▸ **toHex**(): `string` + +*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* + +*Defined in [codec/UInt.ts:69](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L69)* + +**Returns:** `string` + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L73)* + +**Returns:** `any` + +___ + + +## toNumber + +▸ **toNumber**(): `number` + +*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* + +*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L89)* + +**Returns:** `number` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/UInt.ts:81](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L81)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L77)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## `` decode + +▸ **decode**(value: *[AnyNumber](../modules/_types_d_.md#anynumber)*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[decode](_codec_uint_.uint.md#decode)* + +*Defined in [codec/UInt.ts:38](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L38)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| value | [AnyNumber](../modules/_types_d_.md#anynumber) | + +**Returns:** `BN` + +___ + diff --git a/docs/types/classes/_bft_.bftauthoritysignature.md b/docs/types/classes/_bft_.bftauthoritysignature.md new file mode 100644 index 0000000000..511d496012 --- /dev/null +++ b/docs/types/classes/_bft_.bftauthoritysignature.md @@ -0,0 +1,315 @@ + + +# Type parameters +#### S +#### T +#### V +#### E +# Hierarchy + +↳ [Tuple](_codec_tuple_.tuple.md) + +**↳ BftAuthoritySignature** + +# Constructors + + + +## constructor + +⊕ **new BftAuthoritySignature**(value?: *[BftAuthoritySignatureValue](../modules/_bft_.md#bftauthoritysignaturevalue)*): [BftAuthoritySignature](_bft_.bftauthoritysignature.md) + +*Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* + +*Defined in [Bft.ts:22](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bft.ts#L22)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | [BftAuthoritySignatureValue](../modules/_bft_.md#bftauthoritysignaturevalue) | + +**Returns:** [BftAuthoritySignature](_bft_.bftauthoritysignature.md) + +___ + +# Properties + + + +## `` _Types + +**● _Types**: *`E`* + +*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* + +*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)* + +___ + + +## `` _jsonMap + +**● _jsonMap**: *`Map`<`keyof S`, `string`>* + +*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* + +*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)* + +___ + + +## raw + +**● raw**: *`T`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## Type + +getType(): `E` + +*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* + +*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)* + +**Returns:** `E` + +___ + + +## authorityId + +getauthorityId(): [AuthorityId](_authorityid_.authorityid.md) + +*Defined in [Bft.ts:30](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bft.ts#L30)* + +**Returns:** [AuthorityId](_authorityid_.authorityid.md) + +___ + + +## signature + +getsignature(): [Signature](_signature_.signature.md) + +*Defined in [Bft.ts:34](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bft.ts#L34)* + +**Returns:** [Signature](_signature_.signature.md) + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Tuple](_codec_tuple_.tuple.md)<`S`, `T`, `V`> + +*Inherited from [Tuple](_codec_tuple_.tuple.md).[fromJSON](_codec_tuple_.tuple.md#fromjson)* + +*Overrides [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* + +*Defined in [codec/Tuple.ts:34](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Tuple.ts#L34)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Tuple](_codec_tuple_.tuple.md)<`S`, `T`, `V`> + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## get + +▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) + +*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* + +*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| index | `number` | + +**Returns:** [Base](_codec_base_.base.md) + +___ + + +## keys + +▸ **keys**(): `Array`<`string`> + +*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* + +*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)* + +**Returns:** `Array`<`string`> + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* + +*Overrides [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* + +*Defined in [codec/Tuple.ts:46](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Tuple.ts#L46)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## values + +▸ **values**(): `Array`<[Base](_codec_base_.base.md)> + +*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* + +*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)* + +**Returns:** `Array`<[Base](_codec_base_.base.md)> + +___ + + +## `` decode + +▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` + +*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* + +*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)* + +**Type parameters:** + +#### S +#### V +#### T +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | +| value | `V` | `Array`<`any`>| +| isTuple | `boolean` | + +**Returns:** `T` + +___ + + +## `` with + +▸ **with**<`S`>(Types: *`S`*): `object` + +*Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* + +*Overrides [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* + +*Defined in [codec/Tuple.ts:24](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Tuple.ts#L24)* + +**Type parameters:** + +#### S +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | + +**Returns:** `object` + +___ + diff --git a/docs/types/classes/_bft_.bfthashsignature.md b/docs/types/classes/_bft_.bfthashsignature.md new file mode 100644 index 0000000000..b16edd4ad5 --- /dev/null +++ b/docs/types/classes/_bft_.bfthashsignature.md @@ -0,0 +1,315 @@ + + +# Type parameters +#### S +#### T +#### V +#### E +# Hierarchy + +↳ [Tuple](_codec_tuple_.tuple.md) + +**↳ BftHashSignature** + +# Constructors + + + +## constructor + +⊕ **new BftHashSignature**(value?: *[BftHashSignatureValue](../modules/_bft_.md#bfthashsignaturevalue)*): [BftHashSignature](_bft_.bfthashsignature.md) + +*Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* + +*Defined in [Bft.ts:46](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bft.ts#L46)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | [BftHashSignatureValue](../modules/_bft_.md#bfthashsignaturevalue) | + +**Returns:** [BftHashSignature](_bft_.bfthashsignature.md) + +___ + +# Properties + + + +## `` _Types + +**● _Types**: *`E`* + +*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* + +*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)* + +___ + + +## `` _jsonMap + +**● _jsonMap**: *`Map`<`keyof S`, `string`>* + +*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* + +*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)* + +___ + + +## raw + +**● raw**: *`T`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## Type + +getType(): `E` + +*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* + +*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)* + +**Returns:** `E` + +___ + + +## hash + +gethash(): [Hash](_hash_.hash.md) + +*Defined in [Bft.ts:54](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bft.ts#L54)* + +**Returns:** [Hash](_hash_.hash.md) + +___ + + +## signature + +getsignature(): [Signature](_signature_.signature.md) + +*Defined in [Bft.ts:58](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bft.ts#L58)* + +**Returns:** [Signature](_signature_.signature.md) + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Tuple](_codec_tuple_.tuple.md)<`S`, `T`, `V`> + +*Inherited from [Tuple](_codec_tuple_.tuple.md).[fromJSON](_codec_tuple_.tuple.md#fromjson)* + +*Overrides [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* + +*Defined in [codec/Tuple.ts:34](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Tuple.ts#L34)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Tuple](_codec_tuple_.tuple.md)<`S`, `T`, `V`> + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## get + +▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) + +*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* + +*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| index | `number` | + +**Returns:** [Base](_codec_base_.base.md) + +___ + + +## keys + +▸ **keys**(): `Array`<`string`> + +*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* + +*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)* + +**Returns:** `Array`<`string`> + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* + +*Overrides [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* + +*Defined in [codec/Tuple.ts:46](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Tuple.ts#L46)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## values + +▸ **values**(): `Array`<[Base](_codec_base_.base.md)> + +*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* + +*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)* + +**Returns:** `Array`<[Base](_codec_base_.base.md)> + +___ + + +## `` decode + +▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` + +*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* + +*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)* + +**Type parameters:** + +#### S +#### V +#### T +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | +| value | `V` | `Array`<`any`>| +| isTuple | `boolean` | + +**Returns:** `T` + +___ + + +## `` with + +▸ **with**<`S`>(Types: *`S`*): `object` + +*Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* + +*Overrides [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* + +*Defined in [codec/Tuple.ts:24](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Tuple.ts#L24)* + +**Type parameters:** + +#### S +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | + +**Returns:** `object` + +___ + diff --git a/docs/types/classes/_bft_.justification.md b/docs/types/classes/_bft_.justification.md new file mode 100644 index 0000000000..e93948c9d7 --- /dev/null +++ b/docs/types/classes/_bft_.justification.md @@ -0,0 +1,324 @@ + + +# Type parameters +#### S +#### T +#### V +#### E +# Hierarchy + +↳ [Struct](_codec_struct_.struct.md) + +**↳ Justification** + +# Constructors + + + +## constructor + +⊕ **new Justification**(value?: *[JustificationValue](../modules/_bft_.md#justificationvalue)*): [Justification](_bft_.justification.md) + +*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* + +*Defined in [Bft.ts:69](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bft.ts#L69)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | [JustificationValue](../modules/_bft_.md#justificationvalue) | + +**Returns:** [Justification](_bft_.justification.md) + +___ + +# Properties + + + +## `` _Types + +**● _Types**: *`E`* + +*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* + +*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)* + +___ + + +## `` _jsonMap + +**● _jsonMap**: *`Map`<`keyof S`, `string`>* + +*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* + +*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)* + +___ + + +## raw + +**● raw**: *`T`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## Type + +getType(): `E` + +*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* + +*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)* + +**Returns:** `E` + +___ + + +## hash + +gethash(): [Hash](_hash_.hash.md) + +*Defined in [Bft.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bft.ts#L80)* + +**Returns:** [Hash](_hash_.hash.md) + +___ + + +## round + +getround(): [U32](_u32_.u32.md) + +*Defined in [Bft.ts:84](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bft.ts#L84)* + +**Returns:** [U32](_u32_.u32.md) + +___ + + +## signatures + +getsignatures(): [Vector](_codec_vector_.vector.md)<[BftAuthoritySignature](_bft_.bftauthoritysignature.md)> + +*Defined in [Bft.ts:88](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bft.ts#L88)* + +**Returns:** [Vector](_codec_vector_.vector.md)<[BftAuthoritySignature](_bft_.bftauthoritysignature.md)> + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L86)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## get + +▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) + +*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* + +*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| index | `number` | + +**Returns:** [Base](_codec_base_.base.md) + +___ + + +## keys + +▸ **keys**(): `Array`<`string`> + +*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* + +*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)* + +**Returns:** `Array`<`string`> + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L115)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## values + +▸ **values**(): `Array`<[Base](_codec_base_.base.md)> + +*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* + +*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)* + +**Returns:** `Array`<[Base](_codec_base_.base.md)> + +___ + + +## `` decode + +▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` + +*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* + +*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)* + +**Type parameters:** + +#### S +#### V +#### T +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | +| value | `V` | `Array`<`any`>| +| isTuple | `boolean` | + +**Returns:** `T` + +___ + + +## `` with + +▸ **with**<`S`>(Types: *`S`*): `object` + +*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* + +*Defined in [codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L66)* + +**Type parameters:** + +#### S +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | + +**Returns:** `object` + +___ + diff --git a/docs/types/classes/_block_.block.md b/docs/types/classes/_block_.block.md new file mode 100644 index 0000000000..65c9c14ed2 --- /dev/null +++ b/docs/types/classes/_block_.block.md @@ -0,0 +1,324 @@ + + +# Type parameters +#### S +#### T +#### V +#### E +# Hierarchy + +↳ [Struct](_codec_struct_.struct.md) + +**↳ Block** + +# Constructors + + + +## constructor + +⊕ **new Block**(value?: *[BlockValue](../modules/_block_.md#blockvalue)*): [Block](_block_.block.md) + +*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* + +*Defined in [Block.ts:20](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Block.ts#L20)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | [BlockValue](../modules/_block_.md#blockvalue) | + +**Returns:** [Block](_block_.block.md) + +___ + +# Properties + + + +## `` _Types + +**● _Types**: *`E`* + +*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* + +*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)* + +___ + + +## `` _jsonMap + +**● _jsonMap**: *`Map`<`keyof S`, `string`>* + +*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* + +*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)* + +___ + + +## raw + +**● raw**: *`T`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## Type + +getType(): `E` + +*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* + +*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)* + +**Returns:** `E` + +___ + + +## extrinsics + +getextrinsics(): [Extrinsics](_extrinsics_.extrinsics.md) + +*Defined in [Block.ts:28](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Block.ts#L28)* + +**Returns:** [Extrinsics](_extrinsics_.extrinsics.md) + +___ + + +## hash + +gethash(): [Hash](_hash_.hash.md) + +*Defined in [Block.ts:33](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Block.ts#L33)* + +**Returns:** [Hash](_hash_.hash.md) + +___ + + +## header + +getheader(): [Header](_header_.header.md) + +*Defined in [Block.ts:39](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Block.ts#L39)* + +**Returns:** [Header](_header_.header.md) + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L86)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## get + +▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) + +*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* + +*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| index | `number` | + +**Returns:** [Base](_codec_base_.base.md) + +___ + + +## keys + +▸ **keys**(): `Array`<`string`> + +*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* + +*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)* + +**Returns:** `Array`<`string`> + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L115)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## values + +▸ **values**(): `Array`<[Base](_codec_base_.base.md)> + +*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* + +*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)* + +**Returns:** `Array`<[Base](_codec_base_.base.md)> + +___ + + +## `` decode + +▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` + +*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* + +*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)* + +**Type parameters:** + +#### S +#### V +#### T +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | +| value | `V` | `Array`<`any`>| +| isTuple | `boolean` | + +**Returns:** `T` + +___ + + +## `` with + +▸ **with**<`S`>(Types: *`S`*): `object` + +*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* + +*Defined in [codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L66)* + +**Type parameters:** + +#### S +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | + +**Returns:** `object` + +___ + diff --git a/docs/types/classes/_blocknumber_.blocknumber.md b/docs/types/classes/_blocknumber_.blocknumber.md new file mode 100644 index 0000000000..f3cf5ca9ee --- /dev/null +++ b/docs/types/classes/_blocknumber_.blocknumber.md @@ -0,0 +1,399 @@ + + +# Hierarchy + +↳ [U64](_u64_.u64.md) + +**↳ BlockNumber** + +# Constructors + + + +## constructor + +⊕ **new BlockNumber**(value?: *[AnyNumber](../modules/_types_d_.md#anynumber)*): [BlockNumber](_blocknumber_.blocknumber.md) + +*Inherited from [U64](_u64_.u64.md).[constructor](_u64_.u64.md#constructor)* + +*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* + +*Defined in [U64.ts:9](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/U64.ts#L9)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | [AnyNumber](../modules/_types_d_.md#anynumber) | + +**Returns:** [BlockNumber](_blocknumber_.blocknumber.md) + +___ + +# Properties + + + +## raw + +**● raw**: *`BN`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Methods + + + +## add + +▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* + +*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L95)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [UInt](_codec_uint_.uint.md).[byteLength](_codec_uint_.uint.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/UInt.ts:53](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L53)* + +**Returns:** `number` + +___ + + +## cmp + +▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` + +*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* + +*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `number` + +___ + + +## div + +▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* + +*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L107)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [UInt](_codec_uint_.uint.md) + +*Inherited from [UInt](_codec_uint_.uint.md).[fromJSON](_codec_uint_.uint.md#fromjson)* + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L57)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [UInt](_codec_uint_.uint.md) + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [UInt](_codec_uint_.uint.md) + +*Inherited from [UInt](_codec_uint_.uint.md).[fromU8a](_codec_uint_.uint.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/UInt.ts:63](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L63)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [UInt](_codec_uint_.uint.md) + +___ + + +## gt + +▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* + +*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L129)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## gte + +▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* + +*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L135)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## isZero + +▸ **isZero**(): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* + +*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L113)* + +**Returns:** `boolean` + +___ + + +## lt + +▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* + +*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L117)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## lte + +▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* + +*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L123)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## mul + +▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* + +*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L141)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## sub + +▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* + +*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L147)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## toBn + +▸ **toBn**(): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* + +*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L85)* + +**Returns:** `BN` + +___ + + +## toHex + +▸ **toHex**(): `string` + +*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* + +*Defined in [codec/UInt.ts:69](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L69)* + +**Returns:** `string` + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L73)* + +**Returns:** `any` + +___ + + +## toNumber + +▸ **toNumber**(): `number` + +*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* + +*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L89)* + +**Returns:** `number` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/UInt.ts:81](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L81)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L77)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## `` decode + +▸ **decode**(value: *[AnyNumber](../modules/_types_d_.md#anynumber)*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[decode](_codec_uint_.uint.md#decode)* + +*Defined in [codec/UInt.ts:38](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L38)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| value | [AnyNumber](../modules/_types_d_.md#anynumber) | + +**Returns:** `BN` + +___ + diff --git a/docs/types/classes/_bool_.bool.md b/docs/types/classes/_bool_.bool.md new file mode 100644 index 0000000000..f9177cade6 --- /dev/null +++ b/docs/types/classes/_bool_.bool.md @@ -0,0 +1,143 @@ + + +# Hierarchy + + [Base](_codec_base_.base.md)<`boolean`> + +**↳ Bool** + +# Constructors + + + +## constructor + +⊕ **new Bool**(value?: * [Bool](_bool_.bool.md) | `boolean`*): [Bool](_bool_.bool.md) + +*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* + +*Defined in [Bool.ts:7](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bool.ts#L7)* + +**Parameters:** + +| Param | Type | Default value | +| ------ | ------ | ------ | +| `Default value` value | [Bool](_bool_.bool.md) | `boolean`| false | + +**Returns:** [Bool](_bool_.bool.md) + +___ + +# Properties + + + +## raw + +**● raw**: *`boolean`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [Bool.ts:16](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bool.ts#L16)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Bool](_bool_.bool.md) + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [Bool.ts:20](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bool.ts#L20)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Bool](_bool_.bool.md) + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Bool](_bool_.bool.md) + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [Bool.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bool.ts#L26)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Bool](_bool_.bool.md) + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [Bool.ts:32](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bool.ts#L32)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [Bool.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bool.ts#L40)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [Bool.ts:36](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bool.ts#L36)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + diff --git a/docs/types/classes/_bytes_.bytes.md b/docs/types/classes/_bytes_.bytes.md new file mode 100644 index 0000000000..7851a1e207 --- /dev/null +++ b/docs/types/classes/_bytes_.bytes.md @@ -0,0 +1,191 @@ + + +# Hierarchy + +↳ [U8a](_codec_u8a_.u8a.md) + +**↳ Bytes** + +↳ [Extrinsic](_extrinsic_.extrinsic.md) + +↳ [StorageData](_storagedata_.storagedata.md) + +↳ [StorageKey](_storagekey_.storagekey.md) + +# Constructors + + + +## constructor + +⊕ **new Bytes**(value?: *[AnyU8a](../modules/_types_d_.md#anyu8a)*): [Bytes](_bytes_.bytes.md) + +*Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* + +*Defined in [Bytes.ts:16](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bytes.ts#L16)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | [AnyU8a](../modules/_types_d_.md#anyu8a) | + +**Returns:** [Bytes](_bytes_.bytes.md) + +___ + +# Properties + + + +## `` _length + +**● _length**: *[Length](_codec_length_.length.md)* + +*Defined in [Bytes.ts:16](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bytes.ts#L16)* + +___ + + +## raw + +**● raw**: *`Uint8Array`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## length + +getlength(): `number` + +*Overrides [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* + +*Defined in [Bytes.ts:24](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bytes.ts#L24)* + +**Returns:** `number` + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Overrides [U8a](_codec_u8a_.u8a.md).[byteLength](_codec_u8a_.u8a.md#bytelength)* + +*Defined in [Bytes.ts:28](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bytes.ts#L28)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Bytes](_bytes_.bytes.md) + +*Overrides [U8a](_codec_u8a_.u8a.md).[fromJSON](_codec_u8a_.u8a.md#fromjson)* + +*Defined in [Bytes.ts:32](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bytes.ts#L32)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Bytes](_bytes_.bytes.md) + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Bytes](_bytes_.bytes.md) + +*Overrides [U8a](_codec_u8a_.u8a.md).[fromU8a](_codec_u8a_.u8a.md#fromu8a)* + +*Defined in [Bytes.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bytes.ts#L40)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Bytes](_bytes_.bytes.md) + +___ + + +## toHex + +▸ **toHex**(): `string` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* + +*Defined in [codec/U8a.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L45)* + +**Returns:** `string` + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/U8a.ts:49](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L49)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/U8a.ts:57](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L57)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* + +*Defined in [Bytes.ts:51](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bytes.ts#L51)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + diff --git a/docs/types/classes/_codec_base_.base.md b/docs/types/classes/_codec_base_.base.md new file mode 100644 index 0000000000..a0d25b8e8e --- /dev/null +++ b/docs/types/classes/_codec_base_.base.md @@ -0,0 +1,153 @@ + + +# Type parameters +#### T +# Hierarchy + +**Base** + +↳ [U8a](_codec_u8a_.u8a.md) + +↳ [Address](_address_.address.md) + +↳ [UInt](_codec_uint_.uint.md) + +↳ [Struct](_codec_struct_.struct.md) + +↳ [Length](_codec_length_.length.md) + +↳ [Vector](_codec_vector_.vector.md) + +↳ [Bool](_bool_.bool.md) + +↳ [Option](_codec_option_.option.md) + +↳ [Enum](_codec_enum_.enum.md) + +↳ [EnumType](_codec_enumtype_.enumtype.md) + +↳ [Text](_text_.text.md) + +↳ [Moment](_moment_.moment.md) + +↳ [Origin](_origin_.origin.md) + +# Constructors + + + +## constructor + +⊕ **new Base**(value?: *`any`*): [Base](_codec_base_.base.md) + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | `any` | + +**Returns:** [Base](_codec_base_.base.md) + +___ + +# Properties + + + +## raw + +**● raw**: *`T`* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Defined in [codec/Base.ts:25](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L25)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Base](_codec_base_.base.md)<`T`> + +*Defined in [codec/Base.ts:29](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L29)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Base](_codec_base_.base.md)<`T`> + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Base](_codec_base_.base.md)<`T`> + +*Defined in [codec/Base.ts:33](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L33)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Base](_codec_base_.base.md)<`T`> + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Defined in [codec/Base.ts:37](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L37)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Defined in [codec/Base.ts:41](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L41)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Defined in [codec/Base.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L45)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + diff --git a/docs/types/classes/_codec_compact_.compact.md b/docs/types/classes/_codec_compact_.compact.md new file mode 100644 index 0000000000..3a3f63091a --- /dev/null +++ b/docs/types/classes/_codec_compact_.compact.md @@ -0,0 +1,45 @@ + + +# Hierarchy + +**Compact** + +# Methods + + + +## `` decode + +▸ **decode**(input: *`Uint8Array`*, bitLength: *`BitLength`*): `BN` + +*Defined in [codec/Compact.ts:32](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Compact.ts#L32)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | +| bitLength | `BitLength` | + +**Returns:** `BN` + +___ + + +## `` encode + +▸ **encode**(length: *`BN`*, bitLength: *`BitLength`*): `Uint8Array` + +*Defined in [codec/Compact.ts:48](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Compact.ts#L48)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| length | `BN` | +| bitLength | `BitLength` | + +**Returns:** `Uint8Array` + +___ + diff --git a/docs/types/classes/_codec_enum_.enum.md b/docs/types/classes/_codec_enum_.enum.md new file mode 100644 index 0000000000..5abfd27c89 --- /dev/null +++ b/docs/types/classes/_codec_enum_.enum.md @@ -0,0 +1,161 @@ + + +# Hierarchy + + [Base](_codec_base_.base.md)<`number`> + +**↳ Enum** + +↳ [StorageFunctionModifier](_metadata_.storagefunctionmodifier.md) + +↳ [NewAccountOutcome](_newaccountoutcome_.newaccountoutcome.md) + +↳ [VoteThreshold](_votethreshold_.votethreshold.md) + +# Constructors + + + +## constructor + +⊕ **new Enum**(def: *`EnumDef`*, value?: * [Enum](_codec_enum_.enum.md) | `number`*): [Enum](_codec_enum_.enum.md) + +*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* + +*Defined in [codec/Enum.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Enum.ts#L19)* + +**Parameters:** + +| Param | Type | Default value | +| ------ | ------ | ------ | +| def | `EnumDef` | - | +| `Default value` value | [Enum](_codec_enum_.enum.md) | `number`| 0 | + +**Returns:** [Enum](_codec_enum_.enum.md) + +___ + +# Properties + + + +## raw + +**● raw**: *`number`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/Enum.ts:31](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Enum.ts#L31)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Enum](_codec_enum_.enum.md) + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/Enum.ts:35](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Enum.ts#L35)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Enum](_codec_enum_.enum.md) + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Enum](_codec_enum_.enum.md) + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/Enum.ts:42](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Enum.ts#L42)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Enum](_codec_enum_.enum.md) + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/Enum.ts:49](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Enum.ts#L49)* + +**Returns:** `any` + +___ + + +## toNumber + +▸ **toNumber**(): `number` + +*Defined in [codec/Enum.ts:57](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Enum.ts#L57)* + +**Returns:** `number` + +___ + + +## toString + +▸ **toString**(): `string` + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/Enum.ts:61](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Enum.ts#L61)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/Enum.ts:53](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Enum.ts#L53)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + diff --git a/docs/types/classes/_codec_enumtype_.enumtype.md b/docs/types/classes/_codec_enumtype_.enumtype.md new file mode 100644 index 0000000000..0764eda395 --- /dev/null +++ b/docs/types/classes/_codec_enumtype_.enumtype.md @@ -0,0 +1,194 @@ + + +# Type parameters +#### T +# Hierarchy + + [Base](_codec_base_.base.md)<[Base](_codec_base_.base.md)<`T`>> + +**↳ EnumType** + +↳ [StorageFunctionType](_metadata_.storagefunctiontype.md) + +↳ [MisbehaviorKind](_misbehaviorreport_.misbehaviorkind.md) + +# Constructors + + + +## constructor + +⊕ **new EnumType**(def: *`TypesDef`*, index?: * `number` | [EnumType](_codec_enumtype_.enumtype.md)<`T`>*, value?: *`any`*): [EnumType](_codec_enumtype_.enumtype.md) + +*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* + +*Defined in [codec/EnumType.ts:22](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/EnumType.ts#L22)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| def | `TypesDef` | +| `Optional` index | `number` | [EnumType](_codec_enumtype_.enumtype.md)<`T`>| +| `Optional` value | `any` | + +**Returns:** [EnumType](_codec_enumtype_.enumtype.md) + +___ + +# Properties + + + +## raw + +**● raw**: *[Base](_codec_base_.base.md)<`T`>* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## Type + +getType(): `string` + +*Defined in [codec/EnumType.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/EnumType.ts#L40)* + +**Returns:** `string` + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/EnumType.ts:44](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/EnumType.ts#L44)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Base](_codec_base_.base.md)<[Base](_codec_base_.base.md)<`T`>> + +*Inherited from [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/Base.ts:29](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L29)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Base](_codec_base_.base.md)<[Base](_codec_base_.base.md)<`T`>> + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [EnumType](_codec_enumtype_.enumtype.md)<`T`> + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/EnumType.ts:48](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/EnumType.ts#L48)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [EnumType](_codec_enumtype_.enumtype.md)<`T`> + +___ + + +## setValue + +▸ **setValue**(index?: * [EnumType](_codec_enumtype_.enumtype.md)<`T`> | `number`*, value?: *`any`*): `void` + +*Defined in [codec/EnumType.ts:55](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/EnumType.ts#L55)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` index | [EnumType](_codec_enumtype_.enumtype.md)<`T`> | `number`| +| `Optional` value | `any` | + +**Returns:** `void` + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/EnumType.ts:72](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/EnumType.ts#L72)* + +**Returns:** `any` + +___ + + +## toNumber + +▸ **toNumber**(): `number` + +*Defined in [codec/EnumType.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/EnumType.ts#L76)* + +**Returns:** `number` + +___ + + +## toString + +▸ **toString**(): `string` + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/EnumType.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/EnumType.ts#L80)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/Base.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L45)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + diff --git a/docs/types/classes/_codec_length_.length.md b/docs/types/classes/_codec_length_.length.md new file mode 100644 index 0000000000..521591a2a3 --- /dev/null +++ b/docs/types/classes/_codec_length_.length.md @@ -0,0 +1,183 @@ + + +# Hierarchy + + [Base](_codec_base_.base.md)<`BN`> + +**↳ Length** + +# Constructors + + + +## constructor + +⊕ **new Length**(value?: *[AnyNumber](../modules/_types_d_.md#anynumber)*, bitLength?: *`BitLength`*): [Length](_codec_length_.length.md) + +*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* + +*Defined in [codec/Length.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Length.ts#L26)* + +**Parameters:** + +| Param | Type | Default value | +| ------ | ------ | ------ | +| `Default value` value | [AnyNumber](../modules/_types_d_.md#anynumber) | new BN(0) | +| `Default value` bitLength | `BitLength` | 32 | + +**Returns:** [Length](_codec_length_.length.md) + +___ + +# Properties + + + +## raw + +**● raw**: *`BN`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/Length.ts:36](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Length.ts#L36)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Base](_codec_base_.base.md)<`BN`> + +*Inherited from [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/Base.ts:29](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L29)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Base](_codec_base_.base.md)<`BN`> + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Length](_codec_length_.length.md) + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/Length.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Length.ts#L40)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Length](_codec_length_.length.md) + +___ + + +## setValue + +▸ **setValue**(value: * `BN` | `number`*): `void` + +*Defined in [codec/Length.ts:60](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Length.ts#L60)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| value | `BN` | `number`| + +**Returns:** `void` + +___ + + +## toHex + +▸ **toHex**(): `string` + +*Defined in [codec/Length.ts:46](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Length.ts#L46)* + +**Returns:** `string` + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/Base.ts:37](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L37)* + +**Returns:** `any` + +___ + + +## toNumber + +▸ **toNumber**(): `number` + +*Defined in [codec/Length.ts:50](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Length.ts#L50)* + +**Returns:** `number` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/Base.ts:41](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L41)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/Length.ts:54](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Length.ts#L54)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + diff --git a/docs/types/classes/_codec_option_.option.md b/docs/types/classes/_codec_option_.option.md new file mode 100644 index 0000000000..486a2c7318 --- /dev/null +++ b/docs/types/classes/_codec_option_.option.md @@ -0,0 +1,191 @@ + + +# Type parameters +#### T +# Hierarchy + + [Base](_codec_base_.base.md)<[Base](_codec_base_.base.md)<`T`>> + +**↳ Option** + +# Constructors + + + +## constructor + +⊕ **new Option**(Value: *`object`*, value?: *`any`*): [Option](_codec_option_.option.md) + +*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* + +*Defined in [codec/Option.ts:14](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Option.ts#L14)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Value | `object` | +| `Optional` value | `any` | + +**Returns:** [Option](_codec_option_.option.md) + +___ + +# Properties + + + +## raw + +**● raw**: *[Base](_codec_base_.base.md)<`T`>* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## isEmpty + +getisEmpty(): `boolean` + +*Defined in [codec/Option.ts:32](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Option.ts#L32)* + +**Returns:** `boolean` + +___ + + +## value + +getvalue(): `T` | `undefined` + +*Defined in [codec/Option.ts:36](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Option.ts#L36)* + +**Returns:** `T` | `undefined` + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/Option.ts:42](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Option.ts#L42)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Option](_codec_option_.option.md)<`T`> + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/Option.ts:50](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Option.ts#L50)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Option](_codec_option_.option.md)<`T`> + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Option](_codec_option_.option.md)<`T`> + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/Option.ts:60](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Option.ts#L60)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Option](_codec_option_.option.md)<`T`> + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/Option.ts:70](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Option.ts#L70)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/Option.ts:91](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Option.ts#L91)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/Option.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Option.ts#L76)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## `` with + +▸ **with**<`O`>(Type: *`object`*): `object` + +*Defined in [codec/Option.ts:24](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Option.ts#L24)* + +**Type parameters:** + +#### O +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Type | `object` | + +**Returns:** `object` + +___ + diff --git a/docs/types/classes/_codec_struct_.struct.md b/docs/types/classes/_codec_struct_.struct.md new file mode 100644 index 0000000000..da5f93ef47 --- /dev/null +++ b/docs/types/classes/_codec_struct_.struct.md @@ -0,0 +1,314 @@ + + +# Type parameters +#### S +#### T +#### V +#### E +# Hierarchy + + [Base](_codec_base_.base.md)<`T`> + +**↳ Struct** + +↳ [Digest](_header_.digest.md) + +↳ [Header](_header_.header.md) + +↳ [Block](_block_.block.md) + +↳ [Tuple](_codec_tuple_.tuple.md) + +↳ [EventMetadata](_metadata_.eventmetadata.md) + +↳ [OuterEventMetadataEvent](_metadata_.outereventmetadataevent.md) + +↳ [OuterEventMetadata](_metadata_.outereventmetadata.md) + +↳ [FunctionArgumentMetadata](_metadata_.functionargumentmetadata.md) + +↳ [FunctionMetadata](_metadata_.functionmetadata.md) + +↳ [CallMetadata](_metadata_.callmetadata.md) + +↳ [ModuleMetadata](_metadata_.modulemetadata.md) + +↳ [StorageFunctionType$Map](_metadata_.storagefunctiontype_map.md) + +↳ [StorageFunctionMetadata](_metadata_.storagefunctionmetadata.md) + +↳ [StorageMetadata](_metadata_.storagemetadata.md) + +↳ [RuntimeModuleMetadata](_metadata_.runtimemodulemetadata.md) + +↳ [RuntimeMetadata](_metadata_.runtimemetadata.md) + +↳ [KeyValue](_keyvalue_.keyvalue.md) + +↳ [Justification](_bft_.justification.md) + +↳ [BftAtReport](_misbehaviorreport_.bftatreport.md) + +↳ [MisbehaviorReport](_misbehaviorreport_.misbehaviorreport.md) + +↳ [RuntimeVersion](_runtimeversion_.runtimeversion.md) + +↳ [SignedBlock](_signedblock_.signedblock.md) + +↳ [StorageChangeSet](_storagechangeset_.storagechangeset.md) + +↳ [ValidatorPrefs](_validatorprefs_.validatorprefs.md) + +# Constructors + + + +## constructor + +⊕ **new Struct**(Types: *`S`*, value?: * `V` | `Array`<`any`>*, jsonMap?: *`Map`<`keyof S`, `string`>*, isTuple?: *`boolean`*): [Struct](_codec_struct_.struct.md) + +*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* + +*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)* + +**Parameters:** + +| Param | Type | Default value | +| ------ | ------ | ------ | +| Types | `S` | - | +| `Default value` value | `V` | `Array`<`any`>| {} as V | +| `Default value` jsonMap | `Map`<`keyof S`, `string`> | new Map() | +| `Default value` isTuple | `boolean` | false | + +**Returns:** [Struct](_codec_struct_.struct.md) + +___ + +# Properties + + + +## `` _Types + +**● _Types**: *`E`* + +*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)* + +___ + + +## `` _jsonMap + +**● _jsonMap**: *`Map`<`keyof S`, `string`>* + +*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)* + +___ + + +## raw + +**● raw**: *`T`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## Type + +getType(): `E` + +*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)* + +**Returns:** `E` + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L86)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## get + +▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) + +*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| index | `number` | + +**Returns:** [Base](_codec_base_.base.md) + +___ + + +## keys + +▸ **keys**(): `Array`<`string`> + +*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)* + +**Returns:** `Array`<`string`> + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L115)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## values + +▸ **values**(): `Array`<[Base](_codec_base_.base.md)> + +*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)* + +**Returns:** `Array`<[Base](_codec_base_.base.md)> + +___ + + +## `` decode + +▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` + +*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)* + +**Type parameters:** + +#### S +#### V +#### T +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | +| value | `V` | `Array`<`any`>| +| isTuple | `boolean` | + +**Returns:** `T` + +___ + + +## `` with + +▸ **with**<`S`>(Types: *`S`*): `object` + +*Defined in [codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L66)* + +**Type parameters:** + +#### S +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | + +**Returns:** `object` + +___ + diff --git a/docs/types/classes/_codec_tuple_.tuple.md b/docs/types/classes/_codec_tuple_.tuple.md new file mode 100644 index 0000000000..4893b25613 --- /dev/null +++ b/docs/types/classes/_codec_tuple_.tuple.md @@ -0,0 +1,295 @@ + + +# Type parameters +#### S +#### T +#### V +#### E +# Hierarchy + +↳ [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`> + +**↳ Tuple** + +↳ [KeyValueOption](_keyvalue_.keyvalueoption.md) + +↳ [BftAuthoritySignature](_bft_.bftauthoritysignature.md) + +↳ [BftHashSignature](_bft_.bfthashsignature.md) + +# Constructors + + + +## constructor + +⊕ **new Tuple**(Types: *`S`*, value?: * `V` | `Array`<`any`>*, jsonMap?: *`Map`<`keyof S`, `string`>*): [Tuple](_codec_tuple_.tuple.md) + +*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* + +*Defined in [codec/Tuple.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Tuple.ts#L19)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | +| `Optional` value | `V` | `Array`<`any`>| +| `Optional` jsonMap | `Map`<`keyof S`, `string`> | + +**Returns:** [Tuple](_codec_tuple_.tuple.md) + +___ + +# Properties + + + +## `` _Types + +**● _Types**: *`E`* + +*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* + +*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)* + +___ + + +## `` _jsonMap + +**● _jsonMap**: *`Map`<`keyof S`, `string`>* + +*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* + +*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)* + +___ + + +## raw + +**● raw**: *`T`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## Type + +getType(): `E` + +*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* + +*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)* + +**Returns:** `E` + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Tuple](_codec_tuple_.tuple.md)<`S`, `T`, `V`> + +*Overrides [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* + +*Defined in [codec/Tuple.ts:34](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Tuple.ts#L34)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Tuple](_codec_tuple_.tuple.md)<`S`, `T`, `V`> + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## get + +▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) + +*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* + +*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| index | `number` | + +**Returns:** [Base](_codec_base_.base.md) + +___ + + +## keys + +▸ **keys**(): `Array`<`string`> + +*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* + +*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)* + +**Returns:** `Array`<`string`> + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Overrides [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* + +*Defined in [codec/Tuple.ts:46](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Tuple.ts#L46)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## values + +▸ **values**(): `Array`<[Base](_codec_base_.base.md)> + +*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* + +*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)* + +**Returns:** `Array`<[Base](_codec_base_.base.md)> + +___ + + +## `` decode + +▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` + +*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* + +*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)* + +**Type parameters:** + +#### S +#### V +#### T +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | +| value | `V` | `Array`<`any`>| +| isTuple | `boolean` | + +**Returns:** `T` + +___ + + +## `` with + +▸ **with**<`S`>(Types: *`S`*): `object` + +*Overrides [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* + +*Defined in [codec/Tuple.ts:24](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Tuple.ts#L24)* + +**Type parameters:** + +#### S +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | + +**Returns:** `object` + +___ + diff --git a/docs/types/classes/_codec_u8a_.u8a.md b/docs/types/classes/_codec_u8a_.u8a.md new file mode 100644 index 0000000000..277cf7c4ed --- /dev/null +++ b/docs/types/classes/_codec_u8a_.u8a.md @@ -0,0 +1,174 @@ + + +# Hierarchy + + [Base](_codec_base_.base.md)<`Uint8Array`> + +**↳ U8a** + +↳ [AccountIndex](_accountindex_.accountindex.md) + +↳ [Bytes](_bytes_.bytes.md) + +↳ [U8aFixed](_codec_u8afixed_.u8afixed.md) + +# Constructors + + + +## constructor + +⊕ **new U8a**(value?: *[AnyU8a](../modules/_types_d_.md#anyu8a)*): [U8a](_codec_u8a_.u8a.md) + +*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* + +*Defined in [codec/U8a.ts:16](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L16)* + +**Parameters:** + +| Param | Type | Default value | +| ------ | ------ | ------ | +| `Default value` value | [AnyU8a](../modules/_types_d_.md#anyu8a) | new Uint8Array() | + +**Returns:** [U8a](_codec_u8a_.u8a.md) + +___ + +# Properties + + + +## raw + +**● raw**: *`Uint8Array`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## length + +getlength(): `number` + +*Defined in [codec/U8a.ts:25](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L25)* + +**Returns:** `number` + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/U8a.ts:29](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L29)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [U8a](_codec_u8a_.u8a.md) + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L33)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [U8a](_codec_u8a_.u8a.md) + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [U8a](_codec_u8a_.u8a.md) + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L39)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [U8a](_codec_u8a_.u8a.md) + +___ + + +## toHex + +▸ **toHex**(): `string` + +*Defined in [codec/U8a.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L45)* + +**Returns:** `string` + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/U8a.ts:49](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L49)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/U8a.ts:57](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L57)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L53)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + diff --git a/docs/types/classes/_codec_u8afixed_.u8afixed.md b/docs/types/classes/_codec_u8afixed_.u8afixed.md new file mode 100644 index 0000000000..0d43730f5d --- /dev/null +++ b/docs/types/classes/_codec_u8afixed_.u8afixed.md @@ -0,0 +1,194 @@ + + +# Hierarchy + +↳ [U8a](_codec_u8a_.u8a.md) + +**↳ U8aFixed** + +↳ [H256](_h256_.h256.md) + +↳ [H512](_h512_.h512.md) + +↳ [AccountId](_accountid_.accountid.md) + +# Constructors + + + +## constructor + +⊕ **new U8aFixed**(value?: *[AnyU8a](../modules/_types_d_.md#anyu8a)*, bitLength?: *`BitLength`*): [U8aFixed](_codec_u8afixed_.u8afixed.md) + +*Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* + +*Defined in [codec/U8aFixed.ts:14](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8aFixed.ts#L14)* + +**Parameters:** + +| Param | Type | Default value | +| ------ | ------ | ------ | +| `Default value` value | [AnyU8a](../modules/_types_d_.md#anyu8a) | new Uint8Array() | +| `Default value` bitLength | `BitLength` | 256 | + +**Returns:** [U8aFixed](_codec_u8afixed_.u8afixed.md) + +___ + +# Properties + + + +## `` _bitLength + +**● _bitLength**: *`number`* + +*Defined in [codec/U8aFixed.ts:14](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8aFixed.ts#L14)* + +___ + + +## raw + +**● raw**: *`Uint8Array`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## length + +getlength(): `number` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* + +*Defined in [codec/U8a.ts:25](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L25)* + +**Returns:** `number` + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Overrides [U8a](_codec_u8a_.u8a.md).[byteLength](_codec_u8a_.u8a.md#bytelength)* + +*Defined in [codec/U8aFixed.ts:28](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8aFixed.ts#L28)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [U8aFixed](_codec_u8afixed_.u8afixed.md) + +*Overrides [U8a](_codec_u8a_.u8a.md).[fromJSON](_codec_u8a_.u8a.md#fromjson)* + +*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8aFixed.ts#L32)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [U8aFixed](_codec_u8afixed_.u8afixed.md) + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [U8aFixed](_codec_u8afixed_.u8afixed.md) + +*Overrides [U8a](_codec_u8a_.u8a.md).[fromU8a](_codec_u8a_.u8a.md#fromu8a)* + +*Defined in [codec/U8aFixed.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8aFixed.ts#L40)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [U8aFixed](_codec_u8afixed_.u8afixed.md) + +___ + + +## toHex + +▸ **toHex**(): `string` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* + +*Defined in [codec/U8a.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L45)* + +**Returns:** `string` + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/U8a.ts:49](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L49)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/U8a.ts:57](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L57)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L53)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + diff --git a/docs/types/classes/_codec_uint_.uint.md b/docs/types/classes/_codec_uint_.uint.md new file mode 100644 index 0000000000..ffeb22c7c1 --- /dev/null +++ b/docs/types/classes/_codec_uint_.uint.md @@ -0,0 +1,370 @@ + + +# Hierarchy + + [Base](_codec_base_.base.md)<`BN`> + +**↳ UInt** + +↳ [U128](_u128_.u128.md) + +↳ [U64](_u64_.u64.md) + +↳ [U16](_u16_.u16.md) + +↳ [U32](_u32_.u32.md) + +↳ [U8](_u8_.u8.md) + +↳ [U256](_u256_.u256.md) + +# Constructors + + + +## constructor + +⊕ **new UInt**(value?: *[AnyNumber](../modules/_types_d_.md#anynumber)*, bitLength?: *`BitLength`*): [UInt](_codec_uint_.uint.md) + +*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* + +*Defined in [codec/UInt.ts:28](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L28)* + +**Parameters:** + +| Param | Type | Default value | +| ------ | ------ | ------ | +| `Default value` value | [AnyNumber](../modules/_types_d_.md#anynumber) | 0 | +| `Default value` bitLength | `BitLength` | 64 | + +**Returns:** [UInt](_codec_uint_.uint.md) + +___ + +# Properties + + + +## raw + +**● raw**: *`BN`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Methods + + + +## add + +▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L95)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## byteLength + +▸ **byteLength**(): `number` + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/UInt.ts:53](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L53)* + +**Returns:** `number` + +___ + + +## cmp + +▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` + +*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `number` + +___ + + +## div + +▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L107)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [UInt](_codec_uint_.uint.md) + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L57)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [UInt](_codec_uint_.uint.md) + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [UInt](_codec_uint_.uint.md) + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/UInt.ts:63](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L63)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [UInt](_codec_uint_.uint.md) + +___ + + +## gt + +▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L129)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## gte + +▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L135)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## isZero + +▸ **isZero**(): `boolean` + +*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L113)* + +**Returns:** `boolean` + +___ + + +## lt + +▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L117)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## lte + +▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L123)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## mul + +▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L141)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## sub + +▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L147)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## toBn + +▸ **toBn**(): `BN` + +*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L85)* + +**Returns:** `BN` + +___ + + +## toHex + +▸ **toHex**(): `string` + +*Defined in [codec/UInt.ts:69](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L69)* + +**Returns:** `string` + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L73)* + +**Returns:** `any` + +___ + + +## toNumber + +▸ **toNumber**(): `number` + +*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L89)* + +**Returns:** `number` + +___ + + +## toString + +▸ **toString**(): `string` + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/UInt.ts:81](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L81)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L77)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## `` decode + +▸ **decode**(value: *[AnyNumber](../modules/_types_d_.md#anynumber)*): `BN` + +*Defined in [codec/UInt.ts:38](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L38)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| value | [AnyNumber](../modules/_types_d_.md#anynumber) | + +**Returns:** `BN` + +___ + diff --git a/docs/types/classes/_codec_vector_.vector.md b/docs/types/classes/_codec_vector_.vector.md new file mode 100644 index 0000000000..5ef294e6cc --- /dev/null +++ b/docs/types/classes/_codec_vector_.vector.md @@ -0,0 +1,319 @@ + + +# Type parameters +#### T : [Base](_codec_base_.base.md) +# Hierarchy + + [Base](_codec_base_.base.md)<`Array`<`T`>> + +**↳ Vector** + +↳ [Extrinsics](_extrinsics_.extrinsics.md) + +# Constructors + + + +## constructor + +⊕ **new Vector**(Type: *`object`*, value?: *`Array`<`any`>*): [Vector](_codec_vector_.vector.md) + +*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* + +*Defined in [codec/Vector.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L19)* + +**Parameters:** + +| Param | Type | Default value | +| ------ | ------ | ------ | +| Type | `object` | - | +| `Default value` value | `Array`<`any`> | [] as Array<any> | + +**Returns:** [Vector](_codec_vector_.vector.md) + +___ + +# Properties + + + +## raw + +**● raw**: *`Array`<`T`>* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## Type + +getType(): `string` + +*Defined in [codec/Vector.ts:42](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L42)* + +**Returns:** `string` + +___ + + +## length + +getlength(): `number` + +*Defined in [codec/Vector.ts:46](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L46)* + +**Returns:** `number` + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/Vector.ts:50](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L50)* + +**Returns:** `number` + +___ + + +## filter + +▸ **filter**(fn: *`function`*): `Array`<`T`> + +*Defined in [codec/Vector.ts:56](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L56)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| fn | `function` | + +**Returns:** `Array`<`T`> + +___ + + +## find + +▸ **find**(fn: *`function`*): `T` | `undefined` + +*Defined in [codec/Vector.ts:60](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L60)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| fn | `function` | + +**Returns:** `T` | `undefined` + +___ + + +## forEach + +▸ **forEach**(fn: *`function`*): `any` + +*Defined in [codec/Vector.ts:64](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L64)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| fn | `function` | + +**Returns:** `any` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Vector](_codec_vector_.vector.md)<`T`> + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/Vector.ts:68](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L68)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Vector](_codec_vector_.vector.md)<`T`> + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Vector](_codec_vector_.vector.md)<`T`> + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/Vector.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L76)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Vector](_codec_vector_.vector.md)<`T`> + +___ + + +## get + +▸ **get**(index: *`number`*): `T` + +*Defined in [codec/Vector.ts:93](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L93)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| index | `number` | + +**Returns:** `T` + +___ + + +## map + +▸ **map**<`O`>(fn: *`function`*): `Array`<`O`> + +*Defined in [codec/Vector.ts:97](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L97)* + +**Type parameters:** + +#### O +**Parameters:** + +| Param | Type | +| ------ | ------ | +| fn | `function` | + +**Returns:** `Array`<`O`> + +___ + + +## push + +▸ **push**(item: *`T`*): `void` + +*Defined in [codec/Vector.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| item | `T` | + +**Returns:** `void` + +___ + + +## reduce + +▸ **reduce**<`O`>(fn: *`function`*, initial: *`O`*): `O` + +*Defined in [codec/Vector.ts:106](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L106)* + +**Type parameters:** + +#### O +**Parameters:** + +| Param | Type | +| ------ | ------ | +| fn | `function` | +| initial | `O` | + +**Returns:** `O` + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/Vector.ts:110](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L110)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/Vector.ts:125](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L125)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/Vector.ts:116](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L116)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## `` with + +▸ **with**<`O`>(Type: *`object`*): `object` + +*Defined in [codec/Vector.ts:34](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L34)* + +**Type parameters:** + +#### O : [Base](_codec_base_.base.md) +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Type | `object` | + +**Returns:** `object` + +___ + diff --git a/docs/types/classes/_extrinsic_.extrinsic.md b/docs/types/classes/_extrinsic_.extrinsic.md new file mode 100644 index 0000000000..791b590588 --- /dev/null +++ b/docs/types/classes/_extrinsic_.extrinsic.md @@ -0,0 +1,212 @@ + + +# Hierarchy + +↳ [Bytes](_bytes_.bytes.md) + +**↳ Extrinsic** + +↳ [Proposal](_proposal_.proposal.md) + +# Constructors + + + +## constructor + +⊕ **new Extrinsic**(value?: *[AnyU8a](../modules/_types_d_.md#anyu8a)*): [Extrinsic](_extrinsic_.extrinsic.md) + +*Inherited from [Bytes](_bytes_.bytes.md).[constructor](_bytes_.bytes.md#constructor)* + +*Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* + +*Defined in [Bytes.ts:16](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bytes.ts#L16)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | [AnyU8a](../modules/_types_d_.md#anyu8a) | + +**Returns:** [Extrinsic](_extrinsic_.extrinsic.md) + +___ + +# Properties + + + +## `` _length + +**● _length**: *[Length](_codec_length_.length.md)* + +*Inherited from [Bytes](_bytes_.bytes.md).[_length](_bytes_.bytes.md#_length)* + +*Defined in [Bytes.ts:16](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bytes.ts#L16)* + +___ + + +## raw + +**● raw**: *`Uint8Array`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## hash + +gethash(): [Hash](_hash_.hash.md) + +*Defined in [Extrinsic.ts:16](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Extrinsic.ts#L16)* + +**Returns:** [Hash](_hash_.hash.md) + +___ + + +## length + +getlength(): `number` + +*Inherited from [Bytes](_bytes_.bytes.md).[length](_bytes_.bytes.md#length)* + +*Overrides [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* + +*Defined in [Bytes.ts:24](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bytes.ts#L24)* + +**Returns:** `number` + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [Bytes](_bytes_.bytes.md).[byteLength](_bytes_.bytes.md#bytelength)* + +*Overrides [U8a](_codec_u8a_.u8a.md).[byteLength](_codec_u8a_.u8a.md#bytelength)* + +*Defined in [Bytes.ts:28](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bytes.ts#L28)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Bytes](_bytes_.bytes.md) + +*Inherited from [Bytes](_bytes_.bytes.md).[fromJSON](_bytes_.bytes.md#fromjson)* + +*Overrides [U8a](_codec_u8a_.u8a.md).[fromJSON](_codec_u8a_.u8a.md#fromjson)* + +*Defined in [Bytes.ts:32](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bytes.ts#L32)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Bytes](_bytes_.bytes.md) + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Bytes](_bytes_.bytes.md) + +*Inherited from [Bytes](_bytes_.bytes.md).[fromU8a](_bytes_.bytes.md#fromu8a)* + +*Overrides [U8a](_codec_u8a_.u8a.md).[fromU8a](_codec_u8a_.u8a.md#fromu8a)* + +*Defined in [Bytes.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bytes.ts#L40)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Bytes](_bytes_.bytes.md) + +___ + + +## toHex + +▸ **toHex**(): `string` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* + +*Defined in [codec/U8a.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L45)* + +**Returns:** `string` + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/U8a.ts:49](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L49)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/U8a.ts:57](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L57)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [Bytes](_bytes_.bytes.md).[toU8a](_bytes_.bytes.md#tou8a)* + +*Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* + +*Defined in [Bytes.ts:51](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bytes.ts#L51)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + diff --git a/docs/types/classes/_extrinsics_.extrinsics.md b/docs/types/classes/_extrinsics_.extrinsics.md new file mode 100644 index 0000000000..f60a6d81a6 --- /dev/null +++ b/docs/types/classes/_extrinsics_.extrinsics.md @@ -0,0 +1,353 @@ + + +# Type parameters +#### T : [Base](_codec_base_.base.md) +# Hierarchy + +↳ [Vector](_codec_vector_.vector.md) + +**↳ Extrinsics** + +↳ [PendingExtrinsics](_pendingextrinsics_.pendingextrinsics.md) + +# Constructors + + + +## constructor + +⊕ **new Extrinsics**(Type: *`object`*, value?: *`Array`<`any`>*): [Extrinsics](_extrinsics_.extrinsics.md) + +*Inherited from [Vector](_codec_vector_.vector.md).[constructor](_codec_vector_.vector.md#constructor)* + +*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* + +*Defined in [codec/Vector.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L19)* + +**Parameters:** + +| Param | Type | Default value | +| ------ | ------ | ------ | +| Type | `object` | - | +| `Default value` value | `Array`<`any`> | [] as Array<any> | + +**Returns:** [Extrinsics](_extrinsics_.extrinsics.md) + +___ + +# Properties + + + +## raw + +**● raw**: *`Array`<`T`>* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## Type + +getType(): `string` + +*Inherited from [Vector](_codec_vector_.vector.md).[Type](_codec_vector_.vector.md#type)* + +*Defined in [codec/Vector.ts:42](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L42)* + +**Returns:** `string` + +___ + + +## length + +getlength(): `number` + +*Inherited from [Vector](_codec_vector_.vector.md).[length](_codec_vector_.vector.md#length)* + +*Defined in [codec/Vector.ts:46](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L46)* + +**Returns:** `number` + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [Vector](_codec_vector_.vector.md).[byteLength](_codec_vector_.vector.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/Vector.ts:50](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L50)* + +**Returns:** `number` + +___ + + +## filter + +▸ **filter**(fn: *`function`*): `Array`<`T`> + +*Inherited from [Vector](_codec_vector_.vector.md).[filter](_codec_vector_.vector.md#filter)* + +*Defined in [codec/Vector.ts:56](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L56)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| fn | `function` | + +**Returns:** `Array`<`T`> + +___ + + +## find + +▸ **find**(fn: *`function`*): `T` | `undefined` + +*Inherited from [Vector](_codec_vector_.vector.md).[find](_codec_vector_.vector.md#find)* + +*Defined in [codec/Vector.ts:60](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L60)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| fn | `function` | + +**Returns:** `T` | `undefined` + +___ + + +## forEach + +▸ **forEach**(fn: *`function`*): `any` + +*Inherited from [Vector](_codec_vector_.vector.md).[forEach](_codec_vector_.vector.md#foreach)* + +*Defined in [codec/Vector.ts:64](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L64)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| fn | `function` | + +**Returns:** `any` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Vector](_codec_vector_.vector.md)<`T`> + +*Inherited from [Vector](_codec_vector_.vector.md).[fromJSON](_codec_vector_.vector.md#fromjson)* + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/Vector.ts:68](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L68)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Vector](_codec_vector_.vector.md)<`T`> + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Vector](_codec_vector_.vector.md)<`T`> + +*Inherited from [Vector](_codec_vector_.vector.md).[fromU8a](_codec_vector_.vector.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/Vector.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L76)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Vector](_codec_vector_.vector.md)<`T`> + +___ + + +## get + +▸ **get**(index: *`number`*): `T` + +*Inherited from [Vector](_codec_vector_.vector.md).[get](_codec_vector_.vector.md#get)* + +*Defined in [codec/Vector.ts:93](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L93)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| index | `number` | + +**Returns:** `T` + +___ + + +## map + +▸ **map**<`O`>(fn: *`function`*): `Array`<`O`> + +*Inherited from [Vector](_codec_vector_.vector.md).[map](_codec_vector_.vector.md#map)* + +*Defined in [codec/Vector.ts:97](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L97)* + +**Type parameters:** + +#### O +**Parameters:** + +| Param | Type | +| ------ | ------ | +| fn | `function` | + +**Returns:** `Array`<`O`> + +___ + + +## push + +▸ **push**(item: *`T`*): `void` + +*Inherited from [Vector](_codec_vector_.vector.md).[push](_codec_vector_.vector.md#push)* + +*Defined in [codec/Vector.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| item | `T` | + +**Returns:** `void` + +___ + + +## reduce + +▸ **reduce**<`O`>(fn: *`function`*, initial: *`O`*): `O` + +*Inherited from [Vector](_codec_vector_.vector.md).[reduce](_codec_vector_.vector.md#reduce)* + +*Defined in [codec/Vector.ts:106](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L106)* + +**Type parameters:** + +#### O +**Parameters:** + +| Param | Type | +| ------ | ------ | +| fn | `function` | +| initial | `O` | + +**Returns:** `O` + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [Vector](_codec_vector_.vector.md).[toJSON](_codec_vector_.vector.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/Vector.ts:110](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L110)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [Vector](_codec_vector_.vector.md).[toString](_codec_vector_.vector.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/Vector.ts:125](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L125)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [Vector](_codec_vector_.vector.md).[toU8a](_codec_vector_.vector.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/Vector.ts:116](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L116)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## `` with + +▸ **with**<`O`>(Type: *`object`*): `object` + +*Inherited from [Vector](_codec_vector_.vector.md).[with](_codec_vector_.vector.md#with)* + +*Defined in [codec/Vector.ts:34](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L34)* + +**Type parameters:** + +#### O : [Base](_codec_base_.base.md) +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Type | `object` | + +**Returns:** `object` + +___ + diff --git a/docs/types/classes/_gas_.gas.md b/docs/types/classes/_gas_.gas.md new file mode 100644 index 0000000000..da44df7880 --- /dev/null +++ b/docs/types/classes/_gas_.gas.md @@ -0,0 +1,399 @@ + + +# Hierarchy + +↳ [U64](_u64_.u64.md) + +**↳ Gas** + +# Constructors + + + +## constructor + +⊕ **new Gas**(value?: *[AnyNumber](../modules/_types_d_.md#anynumber)*): [Gas](_gas_.gas.md) + +*Inherited from [U64](_u64_.u64.md).[constructor](_u64_.u64.md#constructor)* + +*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* + +*Defined in [U64.ts:9](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/U64.ts#L9)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | [AnyNumber](../modules/_types_d_.md#anynumber) | + +**Returns:** [Gas](_gas_.gas.md) + +___ + +# Properties + + + +## raw + +**● raw**: *`BN`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Methods + + + +## add + +▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* + +*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L95)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [UInt](_codec_uint_.uint.md).[byteLength](_codec_uint_.uint.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/UInt.ts:53](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L53)* + +**Returns:** `number` + +___ + + +## cmp + +▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` + +*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* + +*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `number` + +___ + + +## div + +▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* + +*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L107)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [UInt](_codec_uint_.uint.md) + +*Inherited from [UInt](_codec_uint_.uint.md).[fromJSON](_codec_uint_.uint.md#fromjson)* + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L57)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [UInt](_codec_uint_.uint.md) + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [UInt](_codec_uint_.uint.md) + +*Inherited from [UInt](_codec_uint_.uint.md).[fromU8a](_codec_uint_.uint.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/UInt.ts:63](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L63)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [UInt](_codec_uint_.uint.md) + +___ + + +## gt + +▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* + +*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L129)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## gte + +▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* + +*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L135)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## isZero + +▸ **isZero**(): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* + +*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L113)* + +**Returns:** `boolean` + +___ + + +## lt + +▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* + +*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L117)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## lte + +▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* + +*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L123)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## mul + +▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* + +*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L141)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## sub + +▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* + +*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L147)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## toBn + +▸ **toBn**(): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* + +*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L85)* + +**Returns:** `BN` + +___ + + +## toHex + +▸ **toHex**(): `string` + +*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* + +*Defined in [codec/UInt.ts:69](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L69)* + +**Returns:** `string` + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L73)* + +**Returns:** `any` + +___ + + +## toNumber + +▸ **toNumber**(): `number` + +*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* + +*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L89)* + +**Returns:** `number` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/UInt.ts:81](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L81)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L77)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## `` decode + +▸ **decode**(value: *[AnyNumber](../modules/_types_d_.md#anynumber)*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[decode](_codec_uint_.uint.md#decode)* + +*Defined in [codec/UInt.ts:38](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L38)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| value | [AnyNumber](../modules/_types_d_.md#anynumber) | + +**Returns:** `BN` + +___ + diff --git a/docs/types/classes/_h256_.h256.md b/docs/types/classes/_h256_.h256.md new file mode 100644 index 0000000000..20cf7c2716 --- /dev/null +++ b/docs/types/classes/_h256_.h256.md @@ -0,0 +1,197 @@ + + +# Hierarchy + +↳ [U8aFixed](_codec_u8afixed_.u8afixed.md) + +**↳ H256** + +↳ [Hash](_hash_.hash.md) + +# Constructors + + + +## constructor + +⊕ **new H256**(value?: *[AnyU8a](../modules/_types_d_.md#anyu8a)*): [H256](_h256_.h256.md) + +*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* + +*Defined in [H256.ts:11](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/H256.ts#L11)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | [AnyU8a](../modules/_types_d_.md#anyu8a) | + +**Returns:** [H256](_h256_.h256.md) + +___ + +# Properties + + + +## `` _bitLength + +**● _bitLength**: *`number`* + +*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[_bitLength](_codec_u8afixed_.u8afixed.md#_bitlength)* + +*Defined in [codec/U8aFixed.ts:14](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8aFixed.ts#L14)* + +___ + + +## raw + +**● raw**: *`Uint8Array`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## length + +getlength(): `number` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* + +*Defined in [codec/U8a.ts:25](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L25)* + +**Returns:** `number` + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[byteLength](_codec_u8afixed_.u8afixed.md#bytelength)* + +*Overrides [U8a](_codec_u8a_.u8a.md).[byteLength](_codec_u8a_.u8a.md#bytelength)* + +*Defined in [codec/U8aFixed.ts:28](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8aFixed.ts#L28)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [U8aFixed](_codec_u8afixed_.u8afixed.md) + +*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[fromJSON](_codec_u8afixed_.u8afixed.md#fromjson)* + +*Overrides [U8a](_codec_u8a_.u8a.md).[fromJSON](_codec_u8a_.u8a.md#fromjson)* + +*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8aFixed.ts#L32)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [U8aFixed](_codec_u8afixed_.u8afixed.md) + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [U8aFixed](_codec_u8afixed_.u8afixed.md) + +*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[fromU8a](_codec_u8afixed_.u8afixed.md#fromu8a)* + +*Overrides [U8a](_codec_u8a_.u8a.md).[fromU8a](_codec_u8a_.u8a.md#fromu8a)* + +*Defined in [codec/U8aFixed.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8aFixed.ts#L40)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [U8aFixed](_codec_u8afixed_.u8afixed.md) + +___ + + +## toHex + +▸ **toHex**(): `string` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* + +*Defined in [codec/U8a.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L45)* + +**Returns:** `string` + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/U8a.ts:49](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L49)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/U8a.ts:57](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L57)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L53)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + diff --git a/docs/types/classes/_h512_.h512.md b/docs/types/classes/_h512_.h512.md new file mode 100644 index 0000000000..87a8fc2072 --- /dev/null +++ b/docs/types/classes/_h512_.h512.md @@ -0,0 +1,197 @@ + + +# Hierarchy + +↳ [U8aFixed](_codec_u8afixed_.u8afixed.md) + +**↳ H512** + +↳ [Signature](_signature_.signature.md) + +# Constructors + + + +## constructor + +⊕ **new H512**(value?: *[AnyU8a](../modules/_types_d_.md#anyu8a)*): [H512](_h512_.h512.md) + +*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* + +*Defined in [H512.ts:10](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/H512.ts#L10)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | [AnyU8a](../modules/_types_d_.md#anyu8a) | + +**Returns:** [H512](_h512_.h512.md) + +___ + +# Properties + + + +## `` _bitLength + +**● _bitLength**: *`number`* + +*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[_bitLength](_codec_u8afixed_.u8afixed.md#_bitlength)* + +*Defined in [codec/U8aFixed.ts:14](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8aFixed.ts#L14)* + +___ + + +## raw + +**● raw**: *`Uint8Array`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## length + +getlength(): `number` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* + +*Defined in [codec/U8a.ts:25](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L25)* + +**Returns:** `number` + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[byteLength](_codec_u8afixed_.u8afixed.md#bytelength)* + +*Overrides [U8a](_codec_u8a_.u8a.md).[byteLength](_codec_u8a_.u8a.md#bytelength)* + +*Defined in [codec/U8aFixed.ts:28](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8aFixed.ts#L28)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [U8aFixed](_codec_u8afixed_.u8afixed.md) + +*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[fromJSON](_codec_u8afixed_.u8afixed.md#fromjson)* + +*Overrides [U8a](_codec_u8a_.u8a.md).[fromJSON](_codec_u8a_.u8a.md#fromjson)* + +*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8aFixed.ts#L32)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [U8aFixed](_codec_u8afixed_.u8afixed.md) + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [U8aFixed](_codec_u8afixed_.u8afixed.md) + +*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[fromU8a](_codec_u8afixed_.u8afixed.md#fromu8a)* + +*Overrides [U8a](_codec_u8a_.u8a.md).[fromU8a](_codec_u8a_.u8a.md#fromu8a)* + +*Defined in [codec/U8aFixed.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8aFixed.ts#L40)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [U8aFixed](_codec_u8afixed_.u8afixed.md) + +___ + + +## toHex + +▸ **toHex**(): `string` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* + +*Defined in [codec/U8a.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L45)* + +**Returns:** `string` + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/U8a.ts:49](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L49)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/U8a.ts:57](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L57)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L53)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + diff --git a/docs/types/classes/_hash_.hash.md b/docs/types/classes/_hash_.hash.md new file mode 100644 index 0000000000..3c5ea16d55 --- /dev/null +++ b/docs/types/classes/_hash_.hash.md @@ -0,0 +1,197 @@ + + +# Hierarchy + +↳ [H256](_h256_.h256.md) + +**↳ Hash** + +# Constructors + + + +## constructor + +⊕ **new Hash**(value?: *[AnyU8a](../modules/_types_d_.md#anyu8a)*): [Hash](_hash_.hash.md) + +*Inherited from [H256](_h256_.h256.md).[constructor](_h256_.h256.md#constructor)* + +*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* + +*Defined in [H256.ts:11](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/H256.ts#L11)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | [AnyU8a](../modules/_types_d_.md#anyu8a) | + +**Returns:** [Hash](_hash_.hash.md) + +___ + +# Properties + + + +## `` _bitLength + +**● _bitLength**: *`number`* + +*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[_bitLength](_codec_u8afixed_.u8afixed.md#_bitlength)* + +*Defined in [codec/U8aFixed.ts:14](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8aFixed.ts#L14)* + +___ + + +## raw + +**● raw**: *`Uint8Array`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## length + +getlength(): `number` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* + +*Defined in [codec/U8a.ts:25](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L25)* + +**Returns:** `number` + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[byteLength](_codec_u8afixed_.u8afixed.md#bytelength)* + +*Overrides [U8a](_codec_u8a_.u8a.md).[byteLength](_codec_u8a_.u8a.md#bytelength)* + +*Defined in [codec/U8aFixed.ts:28](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8aFixed.ts#L28)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [U8aFixed](_codec_u8afixed_.u8afixed.md) + +*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[fromJSON](_codec_u8afixed_.u8afixed.md#fromjson)* + +*Overrides [U8a](_codec_u8a_.u8a.md).[fromJSON](_codec_u8a_.u8a.md#fromjson)* + +*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8aFixed.ts#L32)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [U8aFixed](_codec_u8afixed_.u8afixed.md) + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [U8aFixed](_codec_u8afixed_.u8afixed.md) + +*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[fromU8a](_codec_u8afixed_.u8afixed.md#fromu8a)* + +*Overrides [U8a](_codec_u8a_.u8a.md).[fromU8a](_codec_u8a_.u8a.md#fromu8a)* + +*Defined in [codec/U8aFixed.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8aFixed.ts#L40)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [U8aFixed](_codec_u8afixed_.u8afixed.md) + +___ + + +## toHex + +▸ **toHex**(): `string` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* + +*Defined in [codec/U8a.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L45)* + +**Returns:** `string` + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/U8a.ts:49](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L49)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/U8a.ts:57](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L57)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L53)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + diff --git a/docs/types/classes/_header_.digest.md b/docs/types/classes/_header_.digest.md new file mode 100644 index 0000000000..48e14878c0 --- /dev/null +++ b/docs/types/classes/_header_.digest.md @@ -0,0 +1,302 @@ + + +# Type parameters +#### S +#### T +#### V +#### E +# Hierarchy + +↳ [Struct](_codec_struct_.struct.md) + +**↳ Digest** + +# Constructors + + + +## constructor + +⊕ **new Digest**(value?: *`DigestValue`*): [Digest](_header_.digest.md) + +*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* + +*Defined in [Header.ts:29](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Header.ts#L29)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | `DigestValue` | + +**Returns:** [Digest](_header_.digest.md) + +___ + +# Properties + + + +## `` _Types + +**● _Types**: *`E`* + +*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* + +*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)* + +___ + + +## `` _jsonMap + +**● _jsonMap**: *`Map`<`keyof S`, `string`>* + +*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* + +*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)* + +___ + + +## raw + +**● raw**: *`T`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## Type + +getType(): `E` + +*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* + +*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)* + +**Returns:** `E` + +___ + + +## logs + +getlogs(): [Vector](_codec_vector_.vector.md)<[Bytes](_bytes_.bytes.md)> + +*Defined in [Header.ts:36](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Header.ts#L36)* + +**Returns:** [Vector](_codec_vector_.vector.md)<[Bytes](_bytes_.bytes.md)> + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L86)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## get + +▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) + +*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* + +*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| index | `number` | + +**Returns:** [Base](_codec_base_.base.md) + +___ + + +## keys + +▸ **keys**(): `Array`<`string`> + +*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* + +*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)* + +**Returns:** `Array`<`string`> + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L115)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## values + +▸ **values**(): `Array`<[Base](_codec_base_.base.md)> + +*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* + +*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)* + +**Returns:** `Array`<[Base](_codec_base_.base.md)> + +___ + + +## `` decode + +▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` + +*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* + +*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)* + +**Type parameters:** + +#### S +#### V +#### T +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | +| value | `V` | `Array`<`any`>| +| isTuple | `boolean` | + +**Returns:** `T` + +___ + + +## `` with + +▸ **with**<`S`>(Types: *`S`*): `object` + +*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* + +*Defined in [codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L66)* + +**Type parameters:** + +#### S +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | + +**Returns:** `object` + +___ + diff --git a/docs/types/classes/_header_.header.md b/docs/types/classes/_header_.header.md new file mode 100644 index 0000000000..e59a0c77ee --- /dev/null +++ b/docs/types/classes/_header_.header.md @@ -0,0 +1,357 @@ + + +# Type parameters +#### S +#### T +#### V +#### E +# Hierarchy + +↳ [Struct](_codec_struct_.struct.md) + +**↳ Header** + +# Constructors + + + +## constructor + +⊕ **new Header**(value?: *[HeaderValue](../modules/_header_.md#headervalue)*): [Header](_header_.header.md) + +*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* + +*Defined in [Header.ts:42](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Header.ts#L42)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | [HeaderValue](../modules/_header_.md#headervalue) | + +**Returns:** [Header](_header_.header.md) + +___ + +# Properties + + + +## `` _Types + +**● _Types**: *`E`* + +*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* + +*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)* + +___ + + +## `` _jsonMap + +**● _jsonMap**: *`Map`<`keyof S`, `string`>* + +*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* + +*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)* + +___ + + +## raw + +**● raw**: *`T`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## Type + +getType(): `E` + +*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* + +*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)* + +**Returns:** `E` + +___ + + +## blockNumber + +getblockNumber(): [BlockNumber](_blocknumber_.blocknumber.md) + +*Defined in [Header.ts:53](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Header.ts#L53)* + +**Returns:** [BlockNumber](_blocknumber_.blocknumber.md) + +___ + + +## digest + +getdigest(): [Digest](_header_.digest.md) + +*Defined in [Header.ts:57](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Header.ts#L57)* + +**Returns:** [Digest](_header_.digest.md) + +___ + + +## extrinsicsRoot + +getextrinsicsRoot(): [Hash](_hash_.hash.md) + +*Defined in [Header.ts:61](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Header.ts#L61)* + +**Returns:** [Hash](_hash_.hash.md) + +___ + + +## hash + +gethash(): [Hash](_hash_.hash.md) + +*Defined in [Header.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Header.ts#L66)* + +**Returns:** [Hash](_hash_.hash.md) + +___ + + +## parentHash + +getparentHash(): [Hash](_hash_.hash.md) + +*Defined in [Header.ts:72](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Header.ts#L72)* + +**Returns:** [Hash](_hash_.hash.md) + +___ + + +## stateRoot + +getstateRoot(): [Hash](_hash_.hash.md) + +*Defined in [Header.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Header.ts#L76)* + +**Returns:** [Hash](_hash_.hash.md) + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L86)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## get + +▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) + +*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* + +*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| index | `number` | + +**Returns:** [Base](_codec_base_.base.md) + +___ + + +## keys + +▸ **keys**(): `Array`<`string`> + +*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* + +*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)* + +**Returns:** `Array`<`string`> + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L115)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## values + +▸ **values**(): `Array`<[Base](_codec_base_.base.md)> + +*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* + +*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)* + +**Returns:** `Array`<[Base](_codec_base_.base.md)> + +___ + + +## `` decode + +▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` + +*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* + +*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)* + +**Type parameters:** + +#### S +#### V +#### T +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | +| value | `V` | `Array`<`any`>| +| isTuple | `boolean` | + +**Returns:** `T` + +___ + + +## `` with + +▸ **with**<`S`>(Types: *`S`*): `object` + +*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* + +*Defined in [codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L66)* + +**Type parameters:** + +#### S +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | + +**Returns:** `object` + +___ + diff --git a/docs/types/classes/_keyvalue_.keyvalue.md b/docs/types/classes/_keyvalue_.keyvalue.md new file mode 100644 index 0000000000..f818e53e77 --- /dev/null +++ b/docs/types/classes/_keyvalue_.keyvalue.md @@ -0,0 +1,313 @@ + + +# Type parameters +#### S +#### T +#### V +#### E +# Hierarchy + +↳ [Struct](_codec_struct_.struct.md) + +**↳ KeyValue** + +# Constructors + + + +## constructor + +⊕ **new KeyValue**(value?: *`KeyValueValue`*): [KeyValue](_keyvalue_.keyvalue.md) + +*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* + +*Defined in [KeyValue.ts:22](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/KeyValue.ts#L22)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | `KeyValueValue` | + +**Returns:** [KeyValue](_keyvalue_.keyvalue.md) + +___ + +# Properties + + + +## `` _Types + +**● _Types**: *`E`* + +*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* + +*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)* + +___ + + +## `` _jsonMap + +**● _jsonMap**: *`Map`<`keyof S`, `string`>* + +*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* + +*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)* + +___ + + +## raw + +**● raw**: *`T`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## Type + +getType(): `E` + +*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* + +*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)* + +**Returns:** `E` + +___ + + +## key + +getkey(): [StorageKey](_storagekey_.storagekey.md) + +*Defined in [KeyValue.ts:30](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/KeyValue.ts#L30)* + +**Returns:** [StorageKey](_storagekey_.storagekey.md) + +___ + + +## value + +getvalue(): [StorageData](_storagedata_.storagedata.md) + +*Defined in [KeyValue.ts:34](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/KeyValue.ts#L34)* + +**Returns:** [StorageData](_storagedata_.storagedata.md) + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L86)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## get + +▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) + +*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* + +*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| index | `number` | + +**Returns:** [Base](_codec_base_.base.md) + +___ + + +## keys + +▸ **keys**(): `Array`<`string`> + +*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* + +*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)* + +**Returns:** `Array`<`string`> + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L115)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## values + +▸ **values**(): `Array`<[Base](_codec_base_.base.md)> + +*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* + +*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)* + +**Returns:** `Array`<[Base](_codec_base_.base.md)> + +___ + + +## `` decode + +▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` + +*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* + +*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)* + +**Type parameters:** + +#### S +#### V +#### T +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | +| value | `V` | `Array`<`any`>| +| isTuple | `boolean` | + +**Returns:** `T` + +___ + + +## `` with + +▸ **with**<`S`>(Types: *`S`*): `object` + +*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* + +*Defined in [codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L66)* + +**Type parameters:** + +#### S +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | + +**Returns:** `object` + +___ + diff --git a/docs/types/classes/_keyvalue_.keyvalueoption.md b/docs/types/classes/_keyvalue_.keyvalueoption.md new file mode 100644 index 0000000000..47db846e1a --- /dev/null +++ b/docs/types/classes/_keyvalue_.keyvalueoption.md @@ -0,0 +1,315 @@ + + +# Type parameters +#### S +#### T +#### V +#### E +# Hierarchy + +↳ [Tuple](_codec_tuple_.tuple.md) + +**↳ KeyValueOption** + +# Constructors + + + +## constructor + +⊕ **new KeyValueOption**(value?: *[KeyValueOptionValue](../modules/_keyvalue_.md#keyvalueoptionvalue)*): [KeyValueOption](_keyvalue_.keyvalueoption.md) + +*Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* + +*Defined in [KeyValue.ts:47](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/KeyValue.ts#L47)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | [KeyValueOptionValue](../modules/_keyvalue_.md#keyvalueoptionvalue) | + +**Returns:** [KeyValueOption](_keyvalue_.keyvalueoption.md) + +___ + +# Properties + + + +## `` _Types + +**● _Types**: *`E`* + +*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* + +*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)* + +___ + + +## `` _jsonMap + +**● _jsonMap**: *`Map`<`keyof S`, `string`>* + +*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* + +*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)* + +___ + + +## raw + +**● raw**: *`T`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## Type + +getType(): `E` + +*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* + +*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)* + +**Returns:** `E` + +___ + + +## key + +getkey(): [StorageKey](_storagekey_.storagekey.md) + +*Defined in [KeyValue.ts:55](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/KeyValue.ts#L55)* + +**Returns:** [StorageKey](_storagekey_.storagekey.md) + +___ + + +## value + +getvalue(): [Option](_codec_option_.option.md)<[StorageData](_storagedata_.storagedata.md)> + +*Defined in [KeyValue.ts:59](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/KeyValue.ts#L59)* + +**Returns:** [Option](_codec_option_.option.md)<[StorageData](_storagedata_.storagedata.md)> + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Tuple](_codec_tuple_.tuple.md)<`S`, `T`, `V`> + +*Inherited from [Tuple](_codec_tuple_.tuple.md).[fromJSON](_codec_tuple_.tuple.md#fromjson)* + +*Overrides [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* + +*Defined in [codec/Tuple.ts:34](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Tuple.ts#L34)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Tuple](_codec_tuple_.tuple.md)<`S`, `T`, `V`> + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## get + +▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) + +*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* + +*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| index | `number` | + +**Returns:** [Base](_codec_base_.base.md) + +___ + + +## keys + +▸ **keys**(): `Array`<`string`> + +*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* + +*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)* + +**Returns:** `Array`<`string`> + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* + +*Overrides [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* + +*Defined in [codec/Tuple.ts:46](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Tuple.ts#L46)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## values + +▸ **values**(): `Array`<[Base](_codec_base_.base.md)> + +*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* + +*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)* + +**Returns:** `Array`<[Base](_codec_base_.base.md)> + +___ + + +## `` decode + +▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` + +*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* + +*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)* + +**Type parameters:** + +#### S +#### V +#### T +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | +| value | `V` | `Array`<`any`>| +| isTuple | `boolean` | + +**Returns:** `T` + +___ + + +## `` with + +▸ **with**<`S`>(Types: *`S`*): `object` + +*Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* + +*Overrides [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* + +*Defined in [codec/Tuple.ts:24](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Tuple.ts#L24)* + +**Type parameters:** + +#### S +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | + +**Returns:** `object` + +___ + diff --git a/docs/types/classes/_metadata_.callmetadata.md b/docs/types/classes/_metadata_.callmetadata.md new file mode 100644 index 0000000000..a1f5c49bc1 --- /dev/null +++ b/docs/types/classes/_metadata_.callmetadata.md @@ -0,0 +1,313 @@ + + +# Type parameters +#### S +#### T +#### V +#### E +# Hierarchy + +↳ [Struct](_codec_struct_.struct.md) + +**↳ CallMetadata** + +# Constructors + + + +## constructor + +⊕ **new CallMetadata**(value?: *`any`*): [CallMetadata](_metadata_.callmetadata.md) + +*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* + +*Defined in [Metadata.ts:123](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L123)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | `any` | + +**Returns:** [CallMetadata](_metadata_.callmetadata.md) + +___ + +# Properties + + + +## `` _Types + +**● _Types**: *`E`* + +*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* + +*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)* + +___ + + +## `` _jsonMap + +**● _jsonMap**: *`Map`<`keyof S`, `string`>* + +*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* + +*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)* + +___ + + +## raw + +**● raw**: *`T`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## Type + +getType(): `E` + +*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* + +*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)* + +**Returns:** `E` + +___ + + +## functions + +getfunctions(): [Vector](_codec_vector_.vector.md)<[FunctionMetadata](_metadata_.functionmetadata.md)> + +*Defined in [Metadata.ts:131](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L131)* + +**Returns:** [Vector](_codec_vector_.vector.md)<[FunctionMetadata](_metadata_.functionmetadata.md)> + +___ + + +## name + +getname(): [Text](_text_.text.md) + +*Defined in [Metadata.ts:135](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L135)* + +**Returns:** [Text](_text_.text.md) + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L86)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## get + +▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) + +*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* + +*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| index | `number` | + +**Returns:** [Base](_codec_base_.base.md) + +___ + + +## keys + +▸ **keys**(): `Array`<`string`> + +*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* + +*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)* + +**Returns:** `Array`<`string`> + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L115)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## values + +▸ **values**(): `Array`<[Base](_codec_base_.base.md)> + +*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* + +*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)* + +**Returns:** `Array`<[Base](_codec_base_.base.md)> + +___ + + +## `` decode + +▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` + +*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* + +*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)* + +**Type parameters:** + +#### S +#### V +#### T +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | +| value | `V` | `Array`<`any`>| +| isTuple | `boolean` | + +**Returns:** `T` + +___ + + +## `` with + +▸ **with**<`S`>(Types: *`S`*): `object` + +*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* + +*Defined in [codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L66)* + +**Type parameters:** + +#### S +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | + +**Returns:** `object` + +___ + diff --git a/docs/types/classes/_metadata_.eventmetadata.md b/docs/types/classes/_metadata_.eventmetadata.md new file mode 100644 index 0000000000..672df8b6ab --- /dev/null +++ b/docs/types/classes/_metadata_.eventmetadata.md @@ -0,0 +1,324 @@ + + +# Type parameters +#### S +#### T +#### V +#### E +# Hierarchy + +↳ [Struct](_codec_struct_.struct.md) + +**↳ EventMetadata** + +# Constructors + + + +## constructor + +⊕ **new EventMetadata**(value?: *`any`*): [EventMetadata](_metadata_.eventmetadata.md) + +*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* + +*Defined in [Metadata.ts:23](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L23)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | `any` | + +**Returns:** [EventMetadata](_metadata_.eventmetadata.md) + +___ + +# Properties + + + +## `` _Types + +**● _Types**: *`E`* + +*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* + +*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)* + +___ + + +## `` _jsonMap + +**● _jsonMap**: *`Map`<`keyof S`, `string`>* + +*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* + +*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)* + +___ + + +## raw + +**● raw**: *`T`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## Type + +getType(): `E` + +*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* + +*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)* + +**Returns:** `E` + +___ + + +## arguments + +getarguments(): [Vector](_codec_vector_.vector.md)<[Type](_type_.type.md)> + +*Defined in [Metadata.ts:32](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L32)* + +**Returns:** [Vector](_codec_vector_.vector.md)<[Type](_type_.type.md)> + +___ + + +## documentation + +getdocumentation(): [Vector](_codec_vector_.vector.md)<[Text](_text_.text.md)> + +*Defined in [Metadata.ts:36](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L36)* + +**Returns:** [Vector](_codec_vector_.vector.md)<[Text](_text_.text.md)> + +___ + + +## name + +getname(): [Text](_text_.text.md) + +*Defined in [Metadata.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L40)* + +**Returns:** [Text](_text_.text.md) + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L86)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## get + +▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) + +*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* + +*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| index | `number` | + +**Returns:** [Base](_codec_base_.base.md) + +___ + + +## keys + +▸ **keys**(): `Array`<`string`> + +*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* + +*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)* + +**Returns:** `Array`<`string`> + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L115)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## values + +▸ **values**(): `Array`<[Base](_codec_base_.base.md)> + +*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* + +*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)* + +**Returns:** `Array`<[Base](_codec_base_.base.md)> + +___ + + +## `` decode + +▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` + +*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* + +*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)* + +**Type parameters:** + +#### S +#### V +#### T +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | +| value | `V` | `Array`<`any`>| +| isTuple | `boolean` | + +**Returns:** `T` + +___ + + +## `` with + +▸ **with**<`S`>(Types: *`S`*): `object` + +*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* + +*Defined in [codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L66)* + +**Type parameters:** + +#### S +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | + +**Returns:** `object` + +___ + diff --git a/docs/types/classes/_metadata_.functionargumentmetadata.md b/docs/types/classes/_metadata_.functionargumentmetadata.md new file mode 100644 index 0000000000..8cddfd0e15 --- /dev/null +++ b/docs/types/classes/_metadata_.functionargumentmetadata.md @@ -0,0 +1,313 @@ + + +# Type parameters +#### S +#### T +#### V +#### E +# Hierarchy + +↳ [Struct](_codec_struct_.struct.md) + +**↳ FunctionArgumentMetadata** + +# Constructors + + + +## constructor + +⊕ **new FunctionArgumentMetadata**(value?: *`any`*): [FunctionArgumentMetadata](_metadata_.functionargumentmetadata.md) + +*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* + +*Defined in [Metadata.ts:79](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L79)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | `any` | + +**Returns:** [FunctionArgumentMetadata](_metadata_.functionargumentmetadata.md) + +___ + +# Properties + + + +## `` _Types + +**● _Types**: *`E`* + +*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* + +*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)* + +___ + + +## `` _jsonMap + +**● _jsonMap**: *`Map`<`keyof S`, `string`>* + +*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* + +*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)* + +___ + + +## raw + +**● raw**: *`T`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## Type + +getType(): `E` + +*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* + +*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)* + +**Returns:** `E` + +___ + + +## name + +getname(): [Text](_text_.text.md) + +*Defined in [Metadata.ts:87](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L87)* + +**Returns:** [Text](_text_.text.md) + +___ + + +## type + +gettype(): [Type](_type_.type.md) + +*Defined in [Metadata.ts:91](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L91)* + +**Returns:** [Type](_type_.type.md) + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L86)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## get + +▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) + +*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* + +*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| index | `number` | + +**Returns:** [Base](_codec_base_.base.md) + +___ + + +## keys + +▸ **keys**(): `Array`<`string`> + +*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* + +*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)* + +**Returns:** `Array`<`string`> + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L115)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## values + +▸ **values**(): `Array`<[Base](_codec_base_.base.md)> + +*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* + +*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)* + +**Returns:** `Array`<[Base](_codec_base_.base.md)> + +___ + + +## `` decode + +▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` + +*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* + +*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)* + +**Type parameters:** + +#### S +#### V +#### T +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | +| value | `V` | `Array`<`any`>| +| isTuple | `boolean` | + +**Returns:** `T` + +___ + + +## `` with + +▸ **with**<`S`>(Types: *`S`*): `object` + +*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* + +*Defined in [codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L66)* + +**Type parameters:** + +#### S +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | + +**Returns:** `object` + +___ + diff --git a/docs/types/classes/_metadata_.functionmetadata.md b/docs/types/classes/_metadata_.functionmetadata.md new file mode 100644 index 0000000000..2450112b70 --- /dev/null +++ b/docs/types/classes/_metadata_.functionmetadata.md @@ -0,0 +1,335 @@ + + +# Type parameters +#### S +#### T +#### V +#### E +# Hierarchy + +↳ [Struct](_codec_struct_.struct.md) + +**↳ FunctionMetadata** + +# Constructors + + + +## constructor + +⊕ **new FunctionMetadata**(value?: *`any`*): [FunctionMetadata](_metadata_.functionmetadata.md) + +*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* + +*Defined in [Metadata.ts:96](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L96)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | `any` | + +**Returns:** [FunctionMetadata](_metadata_.functionmetadata.md) + +___ + +# Properties + + + +## `` _Types + +**● _Types**: *`E`* + +*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* + +*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)* + +___ + + +## `` _jsonMap + +**● _jsonMap**: *`Map`<`keyof S`, `string`>* + +*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* + +*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)* + +___ + + +## raw + +**● raw**: *`T`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## Type + +getType(): `E` + +*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* + +*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)* + +**Returns:** `E` + +___ + + +## arguments + +getarguments(): [Vector](_codec_vector_.vector.md)<[FunctionArgumentMetadata](_metadata_.functionargumentmetadata.md)> + +*Defined in [Metadata.ts:106](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L106)* + +**Returns:** [Vector](_codec_vector_.vector.md)<[FunctionArgumentMetadata](_metadata_.functionargumentmetadata.md)> + +___ + + +## documentation + +getdocumentation(): [Vector](_codec_vector_.vector.md)<[Text](_text_.text.md)> + +*Defined in [Metadata.ts:110](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L110)* + +**Returns:** [Vector](_codec_vector_.vector.md)<[Text](_text_.text.md)> + +___ + + +## id + +getid(): [U16](_u16_.u16.md) + +*Defined in [Metadata.ts:114](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L114)* + +**Returns:** [U16](_u16_.u16.md) + +___ + + +## name + +getname(): [Text](_text_.text.md) + +*Defined in [Metadata.ts:118](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L118)* + +**Returns:** [Text](_text_.text.md) + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L86)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## get + +▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) + +*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* + +*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| index | `number` | + +**Returns:** [Base](_codec_base_.base.md) + +___ + + +## keys + +▸ **keys**(): `Array`<`string`> + +*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* + +*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)* + +**Returns:** `Array`<`string`> + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L115)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## values + +▸ **values**(): `Array`<[Base](_codec_base_.base.md)> + +*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* + +*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)* + +**Returns:** `Array`<[Base](_codec_base_.base.md)> + +___ + + +## `` decode + +▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` + +*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* + +*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)* + +**Type parameters:** + +#### S +#### V +#### T +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | +| value | `V` | `Array`<`any`>| +| isTuple | `boolean` | + +**Returns:** `T` + +___ + + +## `` with + +▸ **with**<`S`>(Types: *`S`*): `object` + +*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* + +*Defined in [codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L66)* + +**Type parameters:** + +#### S +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | + +**Returns:** `object` + +___ + diff --git a/docs/types/classes/_metadata_.modulemetadata.md b/docs/types/classes/_metadata_.modulemetadata.md new file mode 100644 index 0000000000..e0a8b303e4 --- /dev/null +++ b/docs/types/classes/_metadata_.modulemetadata.md @@ -0,0 +1,313 @@ + + +# Type parameters +#### S +#### T +#### V +#### E +# Hierarchy + +↳ [Struct](_codec_struct_.struct.md) + +**↳ ModuleMetadata** + +# Constructors + + + +## constructor + +⊕ **new ModuleMetadata**(value?: *`any`*): [ModuleMetadata](_metadata_.modulemetadata.md) + +*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* + +*Defined in [Metadata.ts:140](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L140)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | `any` | + +**Returns:** [ModuleMetadata](_metadata_.modulemetadata.md) + +___ + +# Properties + + + +## `` _Types + +**● _Types**: *`E`* + +*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* + +*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)* + +___ + + +## `` _jsonMap + +**● _jsonMap**: *`Map`<`keyof S`, `string`>* + +*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* + +*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)* + +___ + + +## raw + +**● raw**: *`T`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## Type + +getType(): `E` + +*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* + +*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)* + +**Returns:** `E` + +___ + + +## call + +getcall(): [CallMetadata](_metadata_.callmetadata.md) + +*Defined in [Metadata.ts:148](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L148)* + +**Returns:** [CallMetadata](_metadata_.callmetadata.md) + +___ + + +## name + +getname(): [Text](_text_.text.md) + +*Defined in [Metadata.ts:152](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L152)* + +**Returns:** [Text](_text_.text.md) + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L86)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## get + +▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) + +*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* + +*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| index | `number` | + +**Returns:** [Base](_codec_base_.base.md) + +___ + + +## keys + +▸ **keys**(): `Array`<`string`> + +*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* + +*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)* + +**Returns:** `Array`<`string`> + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L115)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## values + +▸ **values**(): `Array`<[Base](_codec_base_.base.md)> + +*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* + +*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)* + +**Returns:** `Array`<[Base](_codec_base_.base.md)> + +___ + + +## `` decode + +▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` + +*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* + +*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)* + +**Type parameters:** + +#### S +#### V +#### T +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | +| value | `V` | `Array`<`any`>| +| isTuple | `boolean` | + +**Returns:** `T` + +___ + + +## `` with + +▸ **with**<`S`>(Types: *`S`*): `object` + +*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* + +*Defined in [codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L66)* + +**Type parameters:** + +#### S +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | + +**Returns:** `object` + +___ + diff --git a/docs/types/classes/_metadata_.outereventmetadata.md b/docs/types/classes/_metadata_.outereventmetadata.md new file mode 100644 index 0000000000..e6c531f902 --- /dev/null +++ b/docs/types/classes/_metadata_.outereventmetadata.md @@ -0,0 +1,313 @@ + + +# Type parameters +#### S +#### T +#### V +#### E +# Hierarchy + +↳ [Struct](_codec_struct_.struct.md) + +**↳ OuterEventMetadata** + +# Constructors + + + +## constructor + +⊕ **new OuterEventMetadata**(value?: *`any`*): [OuterEventMetadata](_metadata_.outereventmetadata.md) + +*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* + +*Defined in [Metadata.ts:62](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L62)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | `any` | + +**Returns:** [OuterEventMetadata](_metadata_.outereventmetadata.md) + +___ + +# Properties + + + +## `` _Types + +**● _Types**: *`E`* + +*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* + +*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)* + +___ + + +## `` _jsonMap + +**● _jsonMap**: *`Map`<`keyof S`, `string`>* + +*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* + +*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)* + +___ + + +## raw + +**● raw**: *`T`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## Type + +getType(): `E` + +*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* + +*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)* + +**Returns:** `E` + +___ + + +## events + +getevents(): [Vector](_codec_vector_.vector.md)<[OuterEventMetadataEvent](_metadata_.outereventmetadataevent.md)> + +*Defined in [Metadata.ts:70](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L70)* + +**Returns:** [Vector](_codec_vector_.vector.md)<[OuterEventMetadataEvent](_metadata_.outereventmetadataevent.md)> + +___ + + +## name + +getname(): [Text](_text_.text.md) + +*Defined in [Metadata.ts:74](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L74)* + +**Returns:** [Text](_text_.text.md) + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L86)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## get + +▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) + +*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* + +*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| index | `number` | + +**Returns:** [Base](_codec_base_.base.md) + +___ + + +## keys + +▸ **keys**(): `Array`<`string`> + +*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* + +*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)* + +**Returns:** `Array`<`string`> + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L115)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## values + +▸ **values**(): `Array`<[Base](_codec_base_.base.md)> + +*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* + +*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)* + +**Returns:** `Array`<[Base](_codec_base_.base.md)> + +___ + + +## `` decode + +▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` + +*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* + +*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)* + +**Type parameters:** + +#### S +#### V +#### T +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | +| value | `V` | `Array`<`any`>| +| isTuple | `boolean` | + +**Returns:** `T` + +___ + + +## `` with + +▸ **with**<`S`>(Types: *`S`*): `object` + +*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* + +*Defined in [codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L66)* + +**Type parameters:** + +#### S +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | + +**Returns:** `object` + +___ + diff --git a/docs/types/classes/_metadata_.outereventmetadataevent.md b/docs/types/classes/_metadata_.outereventmetadataevent.md new file mode 100644 index 0000000000..9dd918237e --- /dev/null +++ b/docs/types/classes/_metadata_.outereventmetadataevent.md @@ -0,0 +1,313 @@ + + +# Type parameters +#### S +#### T +#### V +#### E +# Hierarchy + +↳ [Struct](_codec_struct_.struct.md) + +**↳ OuterEventMetadataEvent** + +# Constructors + + + +## constructor + +⊕ **new OuterEventMetadataEvent**(value?: *`any`*): [OuterEventMetadataEvent](_metadata_.outereventmetadataevent.md) + +*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* + +*Defined in [Metadata.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L45)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | `any` | + +**Returns:** [OuterEventMetadataEvent](_metadata_.outereventmetadataevent.md) + +___ + +# Properties + + + +## `` _Types + +**● _Types**: *`E`* + +*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* + +*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)* + +___ + + +## `` _jsonMap + +**● _jsonMap**: *`Map`<`keyof S`, `string`>* + +*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* + +*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)* + +___ + + +## raw + +**● raw**: *`T`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## Type + +getType(): `E` + +*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* + +*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)* + +**Returns:** `E` + +___ + + +## events + +getevents(): [Vector](_codec_vector_.vector.md)<[EventMetadata](_metadata_.eventmetadata.md)> + +*Defined in [Metadata.ts:53](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L53)* + +**Returns:** [Vector](_codec_vector_.vector.md)<[EventMetadata](_metadata_.eventmetadata.md)> + +___ + + +## name + +getname(): [Text](_text_.text.md) + +*Defined in [Metadata.ts:57](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L57)* + +**Returns:** [Text](_text_.text.md) + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L86)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## get + +▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) + +*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* + +*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| index | `number` | + +**Returns:** [Base](_codec_base_.base.md) + +___ + + +## keys + +▸ **keys**(): `Array`<`string`> + +*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* + +*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)* + +**Returns:** `Array`<`string`> + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L115)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## values + +▸ **values**(): `Array`<[Base](_codec_base_.base.md)> + +*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* + +*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)* + +**Returns:** `Array`<[Base](_codec_base_.base.md)> + +___ + + +## `` decode + +▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` + +*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* + +*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)* + +**Type parameters:** + +#### S +#### V +#### T +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | +| value | `V` | `Array`<`any`>| +| isTuple | `boolean` | + +**Returns:** `T` + +___ + + +## `` with + +▸ **with**<`S`>(Types: *`S`*): `object` + +*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* + +*Defined in [codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L66)* + +**Type parameters:** + +#### S +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | + +**Returns:** `object` + +___ + diff --git a/docs/types/classes/_metadata_.runtimemetadata.md b/docs/types/classes/_metadata_.runtimemetadata.md new file mode 100644 index 0000000000..89dbfad88a --- /dev/null +++ b/docs/types/classes/_metadata_.runtimemetadata.md @@ -0,0 +1,320 @@ + + +# Type parameters +#### S +#### T +#### V +#### E +# Hierarchy + +↳ [Struct](_codec_struct_.struct.md) + +**↳ RuntimeMetadata** + +# Constructors + + + +## constructor + +⊕ **new RuntimeMetadata**(value?: *`any`*): [RuntimeMetadata](_metadata_.runtimemetadata.md) + +*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* + +*Defined in [Metadata.ts:280](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L280)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | `any` | + +**Returns:** [RuntimeMetadata](_metadata_.runtimemetadata.md) + +___ + +# Properties + + + +## `` _Types + +**● _Types**: *`E`* + +*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* + +*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)* + +___ + + +## `` _jsonMap + +**● _jsonMap**: *`Map`<`keyof S`, `string`>* + +*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* + +*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)* + +___ + + +## raw + +**● raw**: *`T`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## Type + +getType(): `E` + +*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* + +*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)* + +**Returns:** `E` + +___ + + +## events + +getevents(): [Vector](_codec_vector_.vector.md)<[OuterEventMetadataEvent](_metadata_.outereventmetadataevent.md)> + +*Defined in [Metadata.ts:303](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L303)* + +**Returns:** [Vector](_codec_vector_.vector.md)<[OuterEventMetadataEvent](_metadata_.outereventmetadataevent.md)> + +___ + + +## modules + +getmodules(): [Vector](_codec_vector_.vector.md)<[RuntimeModuleMetadata](_metadata_.runtimemodulemetadata.md)> + +*Defined in [Metadata.ts:307](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L307)* + +**Returns:** [Vector](_codec_vector_.vector.md)<[RuntimeModuleMetadata](_metadata_.runtimemodulemetadata.md)> + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: * `Uint8Array` | `string` | `Array`<`number`>*): [RuntimeMetadata](_metadata_.runtimemetadata.md) + +*Overrides [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* + +*Defined in [Metadata.ts:290](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L290)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | `string` | `Array`<`number`>| + +**Returns:** [RuntimeMetadata](_metadata_.runtimemetadata.md) + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## get + +▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) + +*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* + +*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| index | `number` | + +**Returns:** [Base](_codec_base_.base.md) + +___ + + +## getUniqTypes + +▸ **getUniqTypes**(): `Array`<`string`> + +*Defined in [Metadata.ts:312](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L312)* + +**Returns:** `Array`<`string`> + +___ + + +## keys + +▸ **keys**(): `Array`<`string`> + +*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* + +*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)* + +**Returns:** `Array`<`string`> + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Overrides [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* + +*Defined in [Metadata.ts:299](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L299)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## values + +▸ **values**(): `Array`<[Base](_codec_base_.base.md)> + +*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* + +*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)* + +**Returns:** `Array`<[Base](_codec_base_.base.md)> + +___ + + +## `` decode + +▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` + +*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* + +*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)* + +**Type parameters:** + +#### S +#### V +#### T +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | +| value | `V` | `Array`<`any`>| +| isTuple | `boolean` | + +**Returns:** `T` + +___ + + +## `` with + +▸ **with**<`S`>(Types: *`S`*): `object` + +*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* + +*Defined in [codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L66)* + +**Type parameters:** + +#### S +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | + +**Returns:** `object` + +___ + diff --git a/docs/types/classes/_metadata_.runtimemodulemetadata.md b/docs/types/classes/_metadata_.runtimemodulemetadata.md new file mode 100644 index 0000000000..5a8edd9824 --- /dev/null +++ b/docs/types/classes/_metadata_.runtimemodulemetadata.md @@ -0,0 +1,324 @@ + + +# Type parameters +#### S +#### T +#### V +#### E +# Hierarchy + +↳ [Struct](_codec_struct_.struct.md) + +**↳ RuntimeModuleMetadata** + +# Constructors + + + +## constructor + +⊕ **new RuntimeModuleMetadata**(value?: *`any`*): [RuntimeModuleMetadata](_metadata_.runtimemodulemetadata.md) + +*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* + +*Defined in [Metadata.ts:258](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L258)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | `any` | + +**Returns:** [RuntimeModuleMetadata](_metadata_.runtimemodulemetadata.md) + +___ + +# Properties + + + +## `` _Types + +**● _Types**: *`E`* + +*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* + +*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)* + +___ + + +## `` _jsonMap + +**● _jsonMap**: *`Map`<`keyof S`, `string`>* + +*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* + +*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)* + +___ + + +## raw + +**● raw**: *`T`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## Type + +getType(): `E` + +*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* + +*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)* + +**Returns:** `E` + +___ + + +## module + +getmodule(): [ModuleMetadata](_metadata_.modulemetadata.md) + +*Defined in [Metadata.ts:267](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L267)* + +**Returns:** [ModuleMetadata](_metadata_.modulemetadata.md) + +___ + + +## prefix + +getprefix(): [Text](_text_.text.md) + +*Defined in [Metadata.ts:271](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L271)* + +**Returns:** [Text](_text_.text.md) + +___ + + +## storage + +getstorage(): [StorageMetadata](_metadata_.storagemetadata.md) | `undefined` + +*Defined in [Metadata.ts:275](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L275)* + +**Returns:** [StorageMetadata](_metadata_.storagemetadata.md) | `undefined` + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L86)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## get + +▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) + +*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* + +*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| index | `number` | + +**Returns:** [Base](_codec_base_.base.md) + +___ + + +## keys + +▸ **keys**(): `Array`<`string`> + +*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* + +*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)* + +**Returns:** `Array`<`string`> + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L115)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## values + +▸ **values**(): `Array`<[Base](_codec_base_.base.md)> + +*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* + +*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)* + +**Returns:** `Array`<[Base](_codec_base_.base.md)> + +___ + + +## `` decode + +▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` + +*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* + +*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)* + +**Type parameters:** + +#### S +#### V +#### T +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | +| value | `V` | `Array`<`any`>| +| isTuple | `boolean` | + +**Returns:** `T` + +___ + + +## `` with + +▸ **with**<`S`>(Types: *`S`*): `object` + +*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* + +*Defined in [codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L66)* + +**Type parameters:** + +#### S +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | + +**Returns:** `object` + +___ + diff --git a/docs/types/classes/_metadata_.storagefunctionmetadata.md b/docs/types/classes/_metadata_.storagefunctionmetadata.md new file mode 100644 index 0000000000..14255a23f4 --- /dev/null +++ b/docs/types/classes/_metadata_.storagefunctionmetadata.md @@ -0,0 +1,335 @@ + + +# Type parameters +#### S +#### T +#### V +#### E +# Hierarchy + +↳ [Struct](_codec_struct_.struct.md) + +**↳ StorageFunctionMetadata** + +# Constructors + + + +## constructor + +⊕ **new StorageFunctionMetadata**(value?: *`StorageFunctionMetadataValue`*): [StorageFunctionMetadata](_metadata_.storagefunctionmetadata.md) + +*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* + +*Defined in [Metadata.ts:214](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L214)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | `StorageFunctionMetadataValue` | + +**Returns:** [StorageFunctionMetadata](_metadata_.storagefunctionmetadata.md) + +___ + +# Properties + + + +## `` _Types + +**● _Types**: *`E`* + +*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* + +*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)* + +___ + + +## `` _jsonMap + +**● _jsonMap**: *`Map`<`keyof S`, `string`>* + +*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* + +*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)* + +___ + + +## raw + +**● raw**: *`T`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## Type + +getType(): `E` + +*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* + +*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)* + +**Returns:** `E` + +___ + + +## documentation + +getdocumentation(): [Vector](_codec_vector_.vector.md)<[Text](_text_.text.md)> + +*Defined in [Metadata.ts:224](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L224)* + +**Returns:** [Vector](_codec_vector_.vector.md)<[Text](_text_.text.md)> + +___ + + +## modifier + +getmodifier(): [StorageFunctionModifier](_metadata_.storagefunctionmodifier.md) + +*Defined in [Metadata.ts:232](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L232)* + +**Returns:** [StorageFunctionModifier](_metadata_.storagefunctionmodifier.md) + +___ + + +## name + +getname(): [Text](_text_.text.md) + +*Defined in [Metadata.ts:228](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L228)* + +**Returns:** [Text](_text_.text.md) + +___ + + +## type + +gettype(): [StorageFunctionType](_metadata_.storagefunctiontype.md) + +*Defined in [Metadata.ts:236](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L236)* + +**Returns:** [StorageFunctionType](_metadata_.storagefunctiontype.md) + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L86)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## get + +▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) + +*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* + +*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| index | `number` | + +**Returns:** [Base](_codec_base_.base.md) + +___ + + +## keys + +▸ **keys**(): `Array`<`string`> + +*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* + +*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)* + +**Returns:** `Array`<`string`> + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L115)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## values + +▸ **values**(): `Array`<[Base](_codec_base_.base.md)> + +*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* + +*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)* + +**Returns:** `Array`<[Base](_codec_base_.base.md)> + +___ + + +## `` decode + +▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` + +*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* + +*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)* + +**Type parameters:** + +#### S +#### V +#### T +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | +| value | `V` | `Array`<`any`>| +| isTuple | `boolean` | + +**Returns:** `T` + +___ + + +## `` with + +▸ **with**<`S`>(Types: *`S`*): `object` + +*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* + +*Defined in [codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L66)* + +**Type parameters:** + +#### S +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | + +**Returns:** `object` + +___ + diff --git a/docs/types/classes/_metadata_.storagefunctionmodifier.md b/docs/types/classes/_metadata_.storagefunctionmodifier.md new file mode 100644 index 0000000000..5e1060037c --- /dev/null +++ b/docs/types/classes/_metadata_.storagefunctionmodifier.md @@ -0,0 +1,168 @@ + + +# Hierarchy + +↳ [Enum](_codec_enum_.enum.md) + +**↳ StorageFunctionModifier** + +# Constructors + + + +## constructor + +⊕ **new StorageFunctionModifier**(value?: *`any`*): [StorageFunctionModifier](_metadata_.storagefunctionmodifier.md) + +*Overrides [Enum](_codec_enum_.enum.md).[constructor](_codec_enum_.enum.md#constructor)* + +*Defined in [Metadata.ts:157](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L157)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | `any` | + +**Returns:** [StorageFunctionModifier](_metadata_.storagefunctionmodifier.md) + +___ + +# Properties + + + +## raw + +**● raw**: *`number`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [Enum](_codec_enum_.enum.md).[byteLength](_codec_enum_.enum.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/Enum.ts:31](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Enum.ts#L31)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Enum](_codec_enum_.enum.md) + +*Inherited from [Enum](_codec_enum_.enum.md).[fromJSON](_codec_enum_.enum.md#fromjson)* + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/Enum.ts:35](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Enum.ts#L35)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Enum](_codec_enum_.enum.md) + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Enum](_codec_enum_.enum.md) + +*Inherited from [Enum](_codec_enum_.enum.md).[fromU8a](_codec_enum_.enum.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/Enum.ts:42](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Enum.ts#L42)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Enum](_codec_enum_.enum.md) + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [Enum](_codec_enum_.enum.md).[toJSON](_codec_enum_.enum.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/Enum.ts:49](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Enum.ts#L49)* + +**Returns:** `any` + +___ + + +## toNumber + +▸ **toNumber**(): `number` + +*Inherited from [Enum](_codec_enum_.enum.md).[toNumber](_codec_enum_.enum.md#tonumber)* + +*Defined in [codec/Enum.ts:57](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Enum.ts#L57)* + +**Returns:** `number` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [Enum](_codec_enum_.enum.md).[toString](_codec_enum_.enum.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/Enum.ts:61](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Enum.ts#L61)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [Enum](_codec_enum_.enum.md).[toU8a](_codec_enum_.enum.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/Enum.ts:53](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Enum.ts#L53)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + diff --git a/docs/types/classes/_metadata_.storagefunctiontype.md b/docs/types/classes/_metadata_.storagefunctiontype.md new file mode 100644 index 0000000000..b841eb03fe --- /dev/null +++ b/docs/types/classes/_metadata_.storagefunctiontype.md @@ -0,0 +1,232 @@ + + +# Hierarchy + +↳ [EnumType](_codec_enumtype_.enumtype.md)< [Type](_type_.type.md) | [StorageFunctionType$Map](_metadata_.storagefunctiontype_map.md)> + +**↳ StorageFunctionType** + +# Constructors + + + +## constructor + +⊕ **new StorageFunctionType**(index?: * `undefined` | `number`*, value?: *`any`*): [StorageFunctionType](_metadata_.storagefunctiontype.md) + +*Overrides [EnumType](_codec_enumtype_.enumtype.md).[constructor](_codec_enumtype_.enumtype.md#constructor)* + +*Defined in [Metadata.ts:180](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L180)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` index | `undefined` | `number`| +| `Optional` value | `any` | + +**Returns:** [StorageFunctionType](_metadata_.storagefunctiontype.md) + +___ + +# Properties + + + +## raw + +**● raw**: *[Base](_codec_base_.base.md)< [Type](_type_.type.md) | [StorageFunctionType$Map](_metadata_.storagefunctiontype_map.md)>* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## Type + +getType(): `string` + +*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[Type](_codec_enumtype_.enumtype.md#type)* + +*Defined in [codec/EnumType.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/EnumType.ts#L40)* + +**Returns:** `string` + +___ + + +## asMap + +getasMap(): [StorageFunctionType$Map](_metadata_.storagefunctiontype_map.md) + +*Defined in [Metadata.ts:192](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L192)* + +**Returns:** [StorageFunctionType$Map](_metadata_.storagefunctiontype_map.md) + +___ + + +## asType + +getasType(): [Type](_type_.type.md) + +*Defined in [Metadata.ts:196](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L196)* + +**Returns:** [Type](_type_.type.md) + +___ + + +## isMap + +getisMap(): `boolean` + +*Defined in [Metadata.ts:188](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L188)* + +**Returns:** `boolean` + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[byteLength](_codec_enumtype_.enumtype.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/EnumType.ts:44](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/EnumType.ts#L44)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Base](_codec_base_.base.md)<[Base](_codec_base_.base.md)< [Type](_type_.type.md) | [StorageFunctionType$Map](_metadata_.storagefunctiontype_map.md)>> + +*Inherited from [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/Base.ts:29](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L29)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Base](_codec_base_.base.md)<[Base](_codec_base_.base.md)< [Type](_type_.type.md) | [StorageFunctionType$Map](_metadata_.storagefunctiontype_map.md)>> + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [EnumType](_codec_enumtype_.enumtype.md)< [Type](_type_.type.md) | [StorageFunctionType$Map](_metadata_.storagefunctiontype_map.md)> + +*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[fromU8a](_codec_enumtype_.enumtype.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/EnumType.ts:48](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/EnumType.ts#L48)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [EnumType](_codec_enumtype_.enumtype.md)< [Type](_type_.type.md) | [StorageFunctionType$Map](_metadata_.storagefunctiontype_map.md)> + +___ + + +## setValue + +▸ **setValue**(index?: * [EnumType](_codec_enumtype_.enumtype.md)< [Type](_type_.type.md) | [StorageFunctionType$Map](_metadata_.storagefunctiontype_map.md)> | `number`*, value?: *`any`*): `void` + +*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[setValue](_codec_enumtype_.enumtype.md#setvalue)* + +*Defined in [codec/EnumType.ts:55](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/EnumType.ts#L55)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` index | [EnumType](_codec_enumtype_.enumtype.md)< [Type](_type_.type.md) | [StorageFunctionType$Map](_metadata_.storagefunctiontype_map.md)> | `number`| +| `Optional` value | `any` | + +**Returns:** `void` + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toJSON](_codec_enumtype_.enumtype.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/EnumType.ts:72](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/EnumType.ts#L72)* + +**Returns:** `any` + +___ + + +## toNumber + +▸ **toNumber**(): `number` + +*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)* + +*Defined in [codec/EnumType.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/EnumType.ts#L76)* + +**Returns:** `number` + +___ + + +## toString + +▸ **toString**(): `string` + +*Overrides [EnumType](_codec_enumtype_.enumtype.md).[toString](_codec_enumtype_.enumtype.md#tostring)* + +*Defined in [Metadata.ts:200](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L200)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/Base.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L45)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + diff --git a/docs/types/classes/_metadata_.storagefunctiontype_map.md b/docs/types/classes/_metadata_.storagefunctiontype_map.md new file mode 100644 index 0000000000..b53d995c06 --- /dev/null +++ b/docs/types/classes/_metadata_.storagefunctiontype_map.md @@ -0,0 +1,313 @@ + + +# Type parameters +#### S +#### T +#### V +#### E +# Hierarchy + +↳ [Struct](_codec_struct_.struct.md) + +**↳ StorageFunctionType$Map** + +# Constructors + + + +## constructor + +⊕ **new StorageFunctionType$Map**(value?: *`any`*): [StorageFunctionType$Map](_metadata_.storagefunctiontype_map.md) + +*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* + +*Defined in [Metadata.ts:163](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L163)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | `any` | + +**Returns:** [StorageFunctionType$Map](_metadata_.storagefunctiontype_map.md) + +___ + +# Properties + + + +## `` _Types + +**● _Types**: *`E`* + +*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* + +*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)* + +___ + + +## `` _jsonMap + +**● _jsonMap**: *`Map`<`keyof S`, `string`>* + +*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* + +*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)* + +___ + + +## raw + +**● raw**: *`T`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## Type + +getType(): `E` + +*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* + +*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)* + +**Returns:** `E` + +___ + + +## key + +getkey(): [Type](_type_.type.md) + +*Defined in [Metadata.ts:171](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L171)* + +**Returns:** [Type](_type_.type.md) + +___ + + +## value + +getvalue(): [Type](_type_.type.md) + +*Defined in [Metadata.ts:175](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L175)* + +**Returns:** [Type](_type_.type.md) + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L86)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## get + +▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) + +*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* + +*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| index | `number` | + +**Returns:** [Base](_codec_base_.base.md) + +___ + + +## keys + +▸ **keys**(): `Array`<`string`> + +*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* + +*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)* + +**Returns:** `Array`<`string`> + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L115)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## values + +▸ **values**(): `Array`<[Base](_codec_base_.base.md)> + +*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* + +*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)* + +**Returns:** `Array`<[Base](_codec_base_.base.md)> + +___ + + +## `` decode + +▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` + +*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* + +*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)* + +**Type parameters:** + +#### S +#### V +#### T +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | +| value | `V` | `Array`<`any`>| +| isTuple | `boolean` | + +**Returns:** `T` + +___ + + +## `` with + +▸ **with**<`S`>(Types: *`S`*): `object` + +*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* + +*Defined in [codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L66)* + +**Type parameters:** + +#### S +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | + +**Returns:** `object` + +___ + diff --git a/docs/types/classes/_metadata_.storagemetadata.md b/docs/types/classes/_metadata_.storagemetadata.md new file mode 100644 index 0000000000..13450dda5d --- /dev/null +++ b/docs/types/classes/_metadata_.storagemetadata.md @@ -0,0 +1,313 @@ + + +# Type parameters +#### S +#### T +#### V +#### E +# Hierarchy + +↳ [Struct](_codec_struct_.struct.md) + +**↳ StorageMetadata** + +# Constructors + + + +## constructor + +⊕ **new StorageMetadata**(value?: *`any`*): [StorageMetadata](_metadata_.storagemetadata.md) + +*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* + +*Defined in [Metadata.ts:241](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L241)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | `any` | + +**Returns:** [StorageMetadata](_metadata_.storagemetadata.md) + +___ + +# Properties + + + +## `` _Types + +**● _Types**: *`E`* + +*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* + +*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)* + +___ + + +## `` _jsonMap + +**● _jsonMap**: *`Map`<`keyof S`, `string`>* + +*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* + +*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)* + +___ + + +## raw + +**● raw**: *`T`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## Type + +getType(): `E` + +*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* + +*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)* + +**Returns:** `E` + +___ + + +## functions + +getfunctions(): [Vector](_codec_vector_.vector.md)<[StorageFunctionMetadata](_metadata_.storagefunctionmetadata.md)> + +*Defined in [Metadata.ts:249](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L249)* + +**Returns:** [Vector](_codec_vector_.vector.md)<[StorageFunctionMetadata](_metadata_.storagefunctionmetadata.md)> + +___ + + +## prefix + +getprefix(): [Text](_text_.text.md) + +*Defined in [Metadata.ts:253](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L253)* + +**Returns:** [Text](_text_.text.md) + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L86)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## get + +▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) + +*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* + +*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| index | `number` | + +**Returns:** [Base](_codec_base_.base.md) + +___ + + +## keys + +▸ **keys**(): `Array`<`string`> + +*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* + +*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)* + +**Returns:** `Array`<`string`> + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L115)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## values + +▸ **values**(): `Array`<[Base](_codec_base_.base.md)> + +*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* + +*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)* + +**Returns:** `Array`<[Base](_codec_base_.base.md)> + +___ + + +## `` decode + +▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` + +*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* + +*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)* + +**Type parameters:** + +#### S +#### V +#### T +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | +| value | `V` | `Array`<`any`>| +| isTuple | `boolean` | + +**Returns:** `T` + +___ + + +## `` with + +▸ **with**<`S`>(Types: *`S`*): `object` + +*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* + +*Defined in [codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L66)* + +**Type parameters:** + +#### S +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | + +**Returns:** `object` + +___ + diff --git a/docs/types/classes/_misbehaviorreport_.bftatreport.md b/docs/types/classes/_misbehaviorreport_.bftatreport.md new file mode 100644 index 0000000000..71f92ee139 --- /dev/null +++ b/docs/types/classes/_misbehaviorreport_.bftatreport.md @@ -0,0 +1,328 @@ + + +# Type parameters +#### S +#### T +#### V +#### E +# Hierarchy + +↳ [Struct](_codec_struct_.struct.md) + +**↳ BftAtReport** + +↳ [BftDoublePrepare](_misbehaviorreport_.bftdoubleprepare.md) + +↳ [BftDoubleCommit](_misbehaviorreport_.bftdoublecommit.md) + +# Constructors + + + +## constructor + +⊕ **new BftAtReport**(value?: *`BftAtReportValue`*): [BftAtReport](_misbehaviorreport_.bftatreport.md) + +*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* + +*Defined in [MisbehaviorReport.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/MisbehaviorReport.ts#L27)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | `BftAtReportValue` | + +**Returns:** [BftAtReport](_misbehaviorreport_.bftatreport.md) + +___ + +# Properties + + + +## `` _Types + +**● _Types**: *`E`* + +*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* + +*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)* + +___ + + +## `` _jsonMap + +**● _jsonMap**: *`Map`<`keyof S`, `string`>* + +*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* + +*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)* + +___ + + +## raw + +**● raw**: *`T`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## Type + +getType(): `E` + +*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* + +*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)* + +**Returns:** `E` + +___ + + +## a + +geta(): [BftHashSignature](_bft_.bfthashsignature.md) + +*Defined in [MisbehaviorReport.ts:36](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/MisbehaviorReport.ts#L36)* + +**Returns:** [BftHashSignature](_bft_.bfthashsignature.md) + +___ + + +## b + +getb(): [BftHashSignature](_bft_.bfthashsignature.md) + +*Defined in [MisbehaviorReport.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/MisbehaviorReport.ts#L40)* + +**Returns:** [BftHashSignature](_bft_.bfthashsignature.md) + +___ + + +## round + +getround(): [U32](_u32_.u32.md) + +*Defined in [MisbehaviorReport.ts:44](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/MisbehaviorReport.ts#L44)* + +**Returns:** [U32](_u32_.u32.md) + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L86)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## get + +▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) + +*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* + +*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| index | `number` | + +**Returns:** [Base](_codec_base_.base.md) + +___ + + +## keys + +▸ **keys**(): `Array`<`string`> + +*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* + +*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)* + +**Returns:** `Array`<`string`> + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L115)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## values + +▸ **values**(): `Array`<[Base](_codec_base_.base.md)> + +*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* + +*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)* + +**Returns:** `Array`<[Base](_codec_base_.base.md)> + +___ + + +## `` decode + +▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` + +*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* + +*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)* + +**Type parameters:** + +#### S +#### V +#### T +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | +| value | `V` | `Array`<`any`>| +| isTuple | `boolean` | + +**Returns:** `T` + +___ + + +## `` with + +▸ **with**<`S`>(Types: *`S`*): `object` + +*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* + +*Defined in [codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L66)* + +**Type parameters:** + +#### S +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | + +**Returns:** `object` + +___ + diff --git a/docs/types/classes/_misbehaviorreport_.bftdoublecommit.md b/docs/types/classes/_misbehaviorreport_.bftdoublecommit.md new file mode 100644 index 0000000000..5c4f8d985b --- /dev/null +++ b/docs/types/classes/_misbehaviorreport_.bftdoublecommit.md @@ -0,0 +1,332 @@ + + +# Type parameters +#### S +#### T +#### V +#### E +# Hierarchy + +↳ [BftAtReport](_misbehaviorreport_.bftatreport.md) + +**↳ BftDoubleCommit** + +# Constructors + + + +## constructor + +⊕ **new BftDoubleCommit**(value?: *`BftAtReportValue`*): [BftDoubleCommit](_misbehaviorreport_.bftdoublecommit.md) + +*Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[constructor](_misbehaviorreport_.bftatreport.md#constructor)* + +*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* + +*Defined in [MisbehaviorReport.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/MisbehaviorReport.ts#L27)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | `BftAtReportValue` | + +**Returns:** [BftDoubleCommit](_misbehaviorreport_.bftdoublecommit.md) + +___ + +# Properties + + + +## `` _Types + +**● _Types**: *`E`* + +*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* + +*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)* + +___ + + +## `` _jsonMap + +**● _jsonMap**: *`Map`<`keyof S`, `string`>* + +*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* + +*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)* + +___ + + +## raw + +**● raw**: *`T`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## Type + +getType(): `E` + +*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* + +*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)* + +**Returns:** `E` + +___ + + +## a + +geta(): [BftHashSignature](_bft_.bfthashsignature.md) + +*Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[a](_misbehaviorreport_.bftatreport.md#a)* + +*Defined in [MisbehaviorReport.ts:36](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/MisbehaviorReport.ts#L36)* + +**Returns:** [BftHashSignature](_bft_.bfthashsignature.md) + +___ + + +## b + +getb(): [BftHashSignature](_bft_.bfthashsignature.md) + +*Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[b](_misbehaviorreport_.bftatreport.md#b)* + +*Defined in [MisbehaviorReport.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/MisbehaviorReport.ts#L40)* + +**Returns:** [BftHashSignature](_bft_.bfthashsignature.md) + +___ + + +## round + +getround(): [U32](_u32_.u32.md) + +*Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[round](_misbehaviorreport_.bftatreport.md#round)* + +*Defined in [MisbehaviorReport.ts:44](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/MisbehaviorReport.ts#L44)* + +**Returns:** [U32](_u32_.u32.md) + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L86)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## get + +▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) + +*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* + +*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| index | `number` | + +**Returns:** [Base](_codec_base_.base.md) + +___ + + +## keys + +▸ **keys**(): `Array`<`string`> + +*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* + +*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)* + +**Returns:** `Array`<`string`> + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L115)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## values + +▸ **values**(): `Array`<[Base](_codec_base_.base.md)> + +*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* + +*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)* + +**Returns:** `Array`<[Base](_codec_base_.base.md)> + +___ + + +## `` decode + +▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` + +*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* + +*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)* + +**Type parameters:** + +#### S +#### V +#### T +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | +| value | `V` | `Array`<`any`>| +| isTuple | `boolean` | + +**Returns:** `T` + +___ + + +## `` with + +▸ **with**<`S`>(Types: *`S`*): `object` + +*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* + +*Defined in [codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L66)* + +**Type parameters:** + +#### S +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | + +**Returns:** `object` + +___ + diff --git a/docs/types/classes/_misbehaviorreport_.bftdoubleprepare.md b/docs/types/classes/_misbehaviorreport_.bftdoubleprepare.md new file mode 100644 index 0000000000..a0374f7ffc --- /dev/null +++ b/docs/types/classes/_misbehaviorreport_.bftdoubleprepare.md @@ -0,0 +1,332 @@ + + +# Type parameters +#### S +#### T +#### V +#### E +# Hierarchy + +↳ [BftAtReport](_misbehaviorreport_.bftatreport.md) + +**↳ BftDoublePrepare** + +# Constructors + + + +## constructor + +⊕ **new BftDoublePrepare**(value?: *`BftAtReportValue`*): [BftDoublePrepare](_misbehaviorreport_.bftdoubleprepare.md) + +*Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[constructor](_misbehaviorreport_.bftatreport.md#constructor)* + +*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* + +*Defined in [MisbehaviorReport.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/MisbehaviorReport.ts#L27)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | `BftAtReportValue` | + +**Returns:** [BftDoublePrepare](_misbehaviorreport_.bftdoubleprepare.md) + +___ + +# Properties + + + +## `` _Types + +**● _Types**: *`E`* + +*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* + +*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)* + +___ + + +## `` _jsonMap + +**● _jsonMap**: *`Map`<`keyof S`, `string`>* + +*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* + +*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)* + +___ + + +## raw + +**● raw**: *`T`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## Type + +getType(): `E` + +*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* + +*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)* + +**Returns:** `E` + +___ + + +## a + +geta(): [BftHashSignature](_bft_.bfthashsignature.md) + +*Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[a](_misbehaviorreport_.bftatreport.md#a)* + +*Defined in [MisbehaviorReport.ts:36](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/MisbehaviorReport.ts#L36)* + +**Returns:** [BftHashSignature](_bft_.bfthashsignature.md) + +___ + + +## b + +getb(): [BftHashSignature](_bft_.bfthashsignature.md) + +*Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[b](_misbehaviorreport_.bftatreport.md#b)* + +*Defined in [MisbehaviorReport.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/MisbehaviorReport.ts#L40)* + +**Returns:** [BftHashSignature](_bft_.bfthashsignature.md) + +___ + + +## round + +getround(): [U32](_u32_.u32.md) + +*Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[round](_misbehaviorreport_.bftatreport.md#round)* + +*Defined in [MisbehaviorReport.ts:44](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/MisbehaviorReport.ts#L44)* + +**Returns:** [U32](_u32_.u32.md) + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L86)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## get + +▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) + +*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* + +*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| index | `number` | + +**Returns:** [Base](_codec_base_.base.md) + +___ + + +## keys + +▸ **keys**(): `Array`<`string`> + +*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* + +*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)* + +**Returns:** `Array`<`string`> + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L115)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## values + +▸ **values**(): `Array`<[Base](_codec_base_.base.md)> + +*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* + +*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)* + +**Returns:** `Array`<[Base](_codec_base_.base.md)> + +___ + + +## `` decode + +▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` + +*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* + +*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)* + +**Type parameters:** + +#### S +#### V +#### T +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | +| value | `V` | `Array`<`any`>| +| isTuple | `boolean` | + +**Returns:** `T` + +___ + + +## `` with + +▸ **with**<`S`>(Types: *`S`*): `object` + +*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* + +*Defined in [codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L66)* + +**Type parameters:** + +#### S +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | + +**Returns:** `object` + +___ + diff --git a/docs/types/classes/_misbehaviorreport_.misbehaviorkind.md b/docs/types/classes/_misbehaviorreport_.misbehaviorkind.md new file mode 100644 index 0000000000..d23952d706 --- /dev/null +++ b/docs/types/classes/_misbehaviorreport_.misbehaviorkind.md @@ -0,0 +1,201 @@ + + +# Hierarchy + +↳ [EnumType](_codec_enumtype_.enumtype.md)< [BftDoublePrepare](_misbehaviorreport_.bftdoubleprepare.md) | [BftDoubleCommit](_misbehaviorreport_.bftdoublecommit.md)> + +**↳ MisbehaviorKind** + +# Constructors + + + +## constructor + +⊕ **new MisbehaviorKind**(index?: *`number`*, value?: *`BftAtReportValue`*): [MisbehaviorKind](_misbehaviorreport_.misbehaviorkind.md) + +*Overrides [EnumType](_codec_enumtype_.enumtype.md).[constructor](_codec_enumtype_.enumtype.md#constructor)* + +*Defined in [MisbehaviorReport.ts:57](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/MisbehaviorReport.ts#L57)* + +**Parameters:** + +| Param | Type | Default value | +| ------ | ------ | ------ | +| `Default value` index | `number` | 17 | +| `Optional` value | `BftAtReportValue` | - | + +**Returns:** [MisbehaviorKind](_misbehaviorreport_.misbehaviorkind.md) + +___ + +# Properties + + + +## raw + +**● raw**: *[Base](_codec_base_.base.md)< [BftDoublePrepare](_misbehaviorreport_.bftdoubleprepare.md) | [BftDoubleCommit](_misbehaviorreport_.bftdoublecommit.md)>* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## Type + +getType(): `string` + +*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[Type](_codec_enumtype_.enumtype.md#type)* + +*Defined in [codec/EnumType.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/EnumType.ts#L40)* + +**Returns:** `string` + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[byteLength](_codec_enumtype_.enumtype.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/EnumType.ts:44](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/EnumType.ts#L44)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Base](_codec_base_.base.md)<[Base](_codec_base_.base.md)< [BftDoublePrepare](_misbehaviorreport_.bftdoubleprepare.md) | [BftDoubleCommit](_misbehaviorreport_.bftdoublecommit.md)>> + +*Inherited from [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/Base.ts:29](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L29)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Base](_codec_base_.base.md)<[Base](_codec_base_.base.md)< [BftDoublePrepare](_misbehaviorreport_.bftdoubleprepare.md) | [BftDoubleCommit](_misbehaviorreport_.bftdoublecommit.md)>> + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [EnumType](_codec_enumtype_.enumtype.md)< [BftDoublePrepare](_misbehaviorreport_.bftdoubleprepare.md) | [BftDoubleCommit](_misbehaviorreport_.bftdoublecommit.md)> + +*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[fromU8a](_codec_enumtype_.enumtype.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/EnumType.ts:48](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/EnumType.ts#L48)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [EnumType](_codec_enumtype_.enumtype.md)< [BftDoublePrepare](_misbehaviorreport_.bftdoubleprepare.md) | [BftDoubleCommit](_misbehaviorreport_.bftdoublecommit.md)> + +___ + + +## setValue + +▸ **setValue**(index?: * [EnumType](_codec_enumtype_.enumtype.md)< [BftDoublePrepare](_misbehaviorreport_.bftdoubleprepare.md) | [BftDoubleCommit](_misbehaviorreport_.bftdoublecommit.md)> | `number`*, value?: *`any`*): `void` + +*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[setValue](_codec_enumtype_.enumtype.md#setvalue)* + +*Defined in [codec/EnumType.ts:55](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/EnumType.ts#L55)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` index | [EnumType](_codec_enumtype_.enumtype.md)< [BftDoublePrepare](_misbehaviorreport_.bftdoubleprepare.md) | [BftDoubleCommit](_misbehaviorreport_.bftdoublecommit.md)> | `number`| +| `Optional` value | `any` | + +**Returns:** `void` + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toJSON](_codec_enumtype_.enumtype.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/EnumType.ts:72](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/EnumType.ts#L72)* + +**Returns:** `any` + +___ + + +## toNumber + +▸ **toNumber**(): `number` + +*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)* + +*Defined in [codec/EnumType.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/EnumType.ts#L76)* + +**Returns:** `number` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toString](_codec_enumtype_.enumtype.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/EnumType.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/EnumType.ts#L80)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/Base.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L45)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + diff --git a/docs/types/classes/_misbehaviorreport_.misbehaviorreport.md b/docs/types/classes/_misbehaviorreport_.misbehaviorreport.md new file mode 100644 index 0000000000..5a2d3d2f93 --- /dev/null +++ b/docs/types/classes/_misbehaviorreport_.misbehaviorreport.md @@ -0,0 +1,335 @@ + + +# Type parameters +#### S +#### T +#### V +#### E +# Hierarchy + +↳ [Struct](_codec_struct_.struct.md) + +**↳ MisbehaviorReport** + +# Constructors + + + +## constructor + +⊕ **new MisbehaviorReport**(value?: *`MisbehaviorReportValue`*): [MisbehaviorReport](_misbehaviorreport_.misbehaviorreport.md) + +*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* + +*Defined in [MisbehaviorReport.ts:72](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/MisbehaviorReport.ts#L72)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | `MisbehaviorReportValue` | + +**Returns:** [MisbehaviorReport](_misbehaviorreport_.misbehaviorreport.md) + +___ + +# Properties + + + +## `` _Types + +**● _Types**: *`E`* + +*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* + +*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)* + +___ + + +## `` _jsonMap + +**● _jsonMap**: *`Map`<`keyof S`, `string`>* + +*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* + +*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)* + +___ + + +## raw + +**● raw**: *`T`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## Type + +getType(): `E` + +*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* + +*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)* + +**Returns:** `E` + +___ + + +## misbehavior + +getmisbehavior(): [MisbehaviorKind](_misbehaviorreport_.misbehaviorkind.md) + +*Defined in [MisbehaviorReport.ts:82](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/MisbehaviorReport.ts#L82)* + +**Returns:** [MisbehaviorKind](_misbehaviorreport_.misbehaviorkind.md) + +___ + + +## parentHash + +getparentHash(): [Hash](_hash_.hash.md) + +*Defined in [MisbehaviorReport.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/MisbehaviorReport.ts#L86)* + +**Returns:** [Hash](_hash_.hash.md) + +___ + + +## parentNumber + +getparentNumber(): [BlockNumber](_blocknumber_.blocknumber.md) + +*Defined in [MisbehaviorReport.ts:90](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/MisbehaviorReport.ts#L90)* + +**Returns:** [BlockNumber](_blocknumber_.blocknumber.md) + +___ + + +## target + +gettarget(): [AuthorityId](_authorityid_.authorityid.md) + +*Defined in [MisbehaviorReport.ts:94](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/MisbehaviorReport.ts#L94)* + +**Returns:** [AuthorityId](_authorityid_.authorityid.md) + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L86)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## get + +▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) + +*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* + +*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| index | `number` | + +**Returns:** [Base](_codec_base_.base.md) + +___ + + +## keys + +▸ **keys**(): `Array`<`string`> + +*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* + +*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)* + +**Returns:** `Array`<`string`> + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L115)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## values + +▸ **values**(): `Array`<[Base](_codec_base_.base.md)> + +*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* + +*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)* + +**Returns:** `Array`<[Base](_codec_base_.base.md)> + +___ + + +## `` decode + +▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` + +*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* + +*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)* + +**Type parameters:** + +#### S +#### V +#### T +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | +| value | `V` | `Array`<`any`>| +| isTuple | `boolean` | + +**Returns:** `T` + +___ + + +## `` with + +▸ **with**<`S`>(Types: *`S`*): `object` + +*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* + +*Defined in [codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L66)* + +**Type parameters:** + +#### S +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | + +**Returns:** `object` + +___ + diff --git a/docs/types/classes/_moment_.moment.md b/docs/types/classes/_moment_.moment.md new file mode 100644 index 0000000000..d79b23081f --- /dev/null +++ b/docs/types/classes/_moment_.moment.md @@ -0,0 +1,193 @@ + + +# Hierarchy + + [Base](_codec_base_.base.md)<`Date`> + +**↳ Moment** + +# Constructors + + + +## constructor + +⊕ **new Moment**(value?: * `Uint8Array` | [Moment](_moment_.moment.md) | `Date` | `BN` | `number`*): [Moment](_moment_.moment.md) + +*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* + +*Defined in [Moment.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Moment.ts#L19)* + +**Parameters:** + +| Param | Type | Default value | +| ------ | ------ | ------ | +| `Default value` value | `Uint8Array` | [Moment](_moment_.moment.md) | `Date` | `BN` | `number`| 0 | + +**Returns:** [Moment](_moment_.moment.md) + +___ + +# Properties + + + +## raw + +**● raw**: *`Date`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [Moment.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Moment.ts#L40)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Moment](_moment_.moment.md) + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [Moment.ts:44](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Moment.ts#L44)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Moment](_moment_.moment.md) + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Moment](_moment_.moment.md) + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [Moment.ts:50](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Moment.ts#L50)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Moment](_moment_.moment.md) + +___ + + +## getTime + +▸ **getTime**(): `number` + +*Defined in [Moment.ts:58](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Moment.ts#L58)* + +**Returns:** `number` + +___ + + +## toBn + +▸ **toBn**(): `BN` + +*Defined in [Moment.ts:74](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Moment.ts#L74)* + +**Returns:** `BN` + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [Moment.ts:62](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Moment.ts#L62)* + +**Returns:** `any` + +___ + + +## toNumber + +▸ **toNumber**(): `number` + +*Defined in [Moment.ts:78](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Moment.ts#L78)* + +**Returns:** `number` + +___ + + +## toString + +▸ **toString**(): `string` + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [Moment.ts:70](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Moment.ts#L70)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [Moment.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Moment.ts#L66)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## `` decode + +▸ **decode**(value: * `Uint8Array` | [Moment](_moment_.moment.md) | `number` | `BN`*): `Date` + +*Defined in [Moment.ts:28](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Moment.ts#L28)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| value | `Uint8Array` | [Moment](_moment_.moment.md) | `number` | `BN`| + +**Returns:** `Date` + +___ + diff --git a/docs/types/classes/_newaccountoutcome_.newaccountoutcome.md b/docs/types/classes/_newaccountoutcome_.newaccountoutcome.md new file mode 100644 index 0000000000..47d8923d9f --- /dev/null +++ b/docs/types/classes/_newaccountoutcome_.newaccountoutcome.md @@ -0,0 +1,168 @@ + + +# Hierarchy + +↳ [Enum](_codec_enum_.enum.md) + +**↳ NewAccountOutcome** + +# Constructors + + + +## constructor + +⊕ **new NewAccountOutcome**(index?: * `undefined` | `number`*): [NewAccountOutcome](_newaccountoutcome_.newaccountoutcome.md) + +*Overrides [Enum](_codec_enum_.enum.md).[constructor](_codec_enum_.enum.md#constructor)* + +*Defined in [NewAccountOutcome.ts:8](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/NewAccountOutcome.ts#L8)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` index | `undefined` | `number`| + +**Returns:** [NewAccountOutcome](_newaccountoutcome_.newaccountoutcome.md) + +___ + +# Properties + + + +## raw + +**● raw**: *`number`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [Enum](_codec_enum_.enum.md).[byteLength](_codec_enum_.enum.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/Enum.ts:31](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Enum.ts#L31)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Enum](_codec_enum_.enum.md) + +*Inherited from [Enum](_codec_enum_.enum.md).[fromJSON](_codec_enum_.enum.md#fromjson)* + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/Enum.ts:35](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Enum.ts#L35)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Enum](_codec_enum_.enum.md) + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Enum](_codec_enum_.enum.md) + +*Inherited from [Enum](_codec_enum_.enum.md).[fromU8a](_codec_enum_.enum.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/Enum.ts:42](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Enum.ts#L42)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Enum](_codec_enum_.enum.md) + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [Enum](_codec_enum_.enum.md).[toJSON](_codec_enum_.enum.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/Enum.ts:49](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Enum.ts#L49)* + +**Returns:** `any` + +___ + + +## toNumber + +▸ **toNumber**(): `number` + +*Inherited from [Enum](_codec_enum_.enum.md).[toNumber](_codec_enum_.enum.md#tonumber)* + +*Defined in [codec/Enum.ts:57](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Enum.ts#L57)* + +**Returns:** `number` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [Enum](_codec_enum_.enum.md).[toString](_codec_enum_.enum.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/Enum.ts:61](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Enum.ts#L61)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [Enum](_codec_enum_.enum.md).[toU8a](_codec_enum_.enum.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/Enum.ts:53](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Enum.ts#L53)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + diff --git a/docs/types/classes/_nonce_.index.md b/docs/types/classes/_nonce_.index.md new file mode 100644 index 0000000000..a0620c66d7 --- /dev/null +++ b/docs/types/classes/_nonce_.index.md @@ -0,0 +1,399 @@ + + +# Hierarchy + +↳ [U32](_u32_.u32.md) + +**↳ Index** + +# Constructors + + + +## constructor + +⊕ **new Index**(value?: *[AnyNumber](../modules/_types_d_.md#anynumber)*): [Index](_nonce_.index.md) + +*Inherited from [U32](_u32_.u32.md).[constructor](_u32_.u32.md#constructor)* + +*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* + +*Defined in [U32.ts:9](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/U32.ts#L9)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | [AnyNumber](../modules/_types_d_.md#anynumber) | + +**Returns:** [Index](_nonce_.index.md) + +___ + +# Properties + + + +## raw + +**● raw**: *`BN`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Methods + + + +## add + +▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* + +*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L95)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [UInt](_codec_uint_.uint.md).[byteLength](_codec_uint_.uint.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/UInt.ts:53](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L53)* + +**Returns:** `number` + +___ + + +## cmp + +▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` + +*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* + +*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `number` + +___ + + +## div + +▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* + +*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L107)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [UInt](_codec_uint_.uint.md) + +*Inherited from [UInt](_codec_uint_.uint.md).[fromJSON](_codec_uint_.uint.md#fromjson)* + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L57)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [UInt](_codec_uint_.uint.md) + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [UInt](_codec_uint_.uint.md) + +*Inherited from [UInt](_codec_uint_.uint.md).[fromU8a](_codec_uint_.uint.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/UInt.ts:63](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L63)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [UInt](_codec_uint_.uint.md) + +___ + + +## gt + +▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* + +*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L129)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## gte + +▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* + +*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L135)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## isZero + +▸ **isZero**(): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* + +*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L113)* + +**Returns:** `boolean` + +___ + + +## lt + +▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* + +*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L117)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## lte + +▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* + +*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L123)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## mul + +▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* + +*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L141)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## sub + +▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* + +*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L147)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## toBn + +▸ **toBn**(): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* + +*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L85)* + +**Returns:** `BN` + +___ + + +## toHex + +▸ **toHex**(): `string` + +*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* + +*Defined in [codec/UInt.ts:69](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L69)* + +**Returns:** `string` + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L73)* + +**Returns:** `any` + +___ + + +## toNumber + +▸ **toNumber**(): `number` + +*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* + +*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L89)* + +**Returns:** `number` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/UInt.ts:81](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L81)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L77)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## `` decode + +▸ **decode**(value: *[AnyNumber](../modules/_types_d_.md#anynumber)*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[decode](_codec_uint_.uint.md#decode)* + +*Defined in [codec/UInt.ts:38](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L38)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| value | [AnyNumber](../modules/_types_d_.md#anynumber) | + +**Returns:** `BN` + +___ + diff --git a/docs/types/classes/_origin_.origin.md b/docs/types/classes/_origin_.origin.md new file mode 100644 index 0000000000..22c1738001 --- /dev/null +++ b/docs/types/classes/_origin_.origin.md @@ -0,0 +1,139 @@ + + +# Type parameters +#### T +# Hierarchy + + [Base](_codec_base_.base.md) + +**↳ Origin** + +# Constructors + + + +## constructor + +⊕ **new Origin**(): [Origin](_origin_.origin.md) + +*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* + +*Defined in [Origin.ts:8](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Origin.ts#L8)* + +**Returns:** [Origin](_origin_.origin.md) + +___ + +# Properties + + + +## raw + +**● raw**: *`T`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/Base.ts:25](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L25)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Base](_codec_base_.base.md)<`T`> + +*Inherited from [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/Base.ts:29](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L29)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Base](_codec_base_.base.md)<`T`> + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Base](_codec_base_.base.md)<`T`> + +*Inherited from [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/Base.ts:33](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L33)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Base](_codec_base_.base.md)<`T`> + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/Base.ts:37](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L37)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/Base.ts:41](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L41)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/Base.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L45)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + diff --git a/docs/types/classes/_parachainid_.parachainid.md b/docs/types/classes/_parachainid_.parachainid.md new file mode 100644 index 0000000000..bdf9811c3e --- /dev/null +++ b/docs/types/classes/_parachainid_.parachainid.md @@ -0,0 +1,399 @@ + + +# Hierarchy + +↳ [U64](_u64_.u64.md) + +**↳ ParachainId** + +# Constructors + + + +## constructor + +⊕ **new ParachainId**(value?: *[AnyNumber](../modules/_types_d_.md#anynumber)*): [ParachainId](_parachainid_.parachainid.md) + +*Inherited from [U64](_u64_.u64.md).[constructor](_u64_.u64.md#constructor)* + +*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* + +*Defined in [U64.ts:9](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/U64.ts#L9)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | [AnyNumber](../modules/_types_d_.md#anynumber) | + +**Returns:** [ParachainId](_parachainid_.parachainid.md) + +___ + +# Properties + + + +## raw + +**● raw**: *`BN`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Methods + + + +## add + +▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* + +*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L95)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [UInt](_codec_uint_.uint.md).[byteLength](_codec_uint_.uint.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/UInt.ts:53](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L53)* + +**Returns:** `number` + +___ + + +## cmp + +▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` + +*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* + +*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `number` + +___ + + +## div + +▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* + +*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L107)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [UInt](_codec_uint_.uint.md) + +*Inherited from [UInt](_codec_uint_.uint.md).[fromJSON](_codec_uint_.uint.md#fromjson)* + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L57)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [UInt](_codec_uint_.uint.md) + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [UInt](_codec_uint_.uint.md) + +*Inherited from [UInt](_codec_uint_.uint.md).[fromU8a](_codec_uint_.uint.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/UInt.ts:63](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L63)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [UInt](_codec_uint_.uint.md) + +___ + + +## gt + +▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* + +*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L129)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## gte + +▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* + +*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L135)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## isZero + +▸ **isZero**(): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* + +*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L113)* + +**Returns:** `boolean` + +___ + + +## lt + +▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* + +*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L117)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## lte + +▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* + +*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L123)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## mul + +▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* + +*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L141)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## sub + +▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* + +*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L147)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## toBn + +▸ **toBn**(): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* + +*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L85)* + +**Returns:** `BN` + +___ + + +## toHex + +▸ **toHex**(): `string` + +*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* + +*Defined in [codec/UInt.ts:69](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L69)* + +**Returns:** `string` + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L73)* + +**Returns:** `any` + +___ + + +## toNumber + +▸ **toNumber**(): `number` + +*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* + +*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L89)* + +**Returns:** `number` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/UInt.ts:81](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L81)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L77)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## `` decode + +▸ **decode**(value: *[AnyNumber](../modules/_types_d_.md#anynumber)*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[decode](_codec_uint_.uint.md#decode)* + +*Defined in [codec/UInt.ts:38](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L38)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| value | [AnyNumber](../modules/_types_d_.md#anynumber) | + +**Returns:** `BN` + +___ + diff --git a/docs/types/classes/_pendingextrinsics_.pendingextrinsics.md b/docs/types/classes/_pendingextrinsics_.pendingextrinsics.md new file mode 100644 index 0000000000..0b8bc829b2 --- /dev/null +++ b/docs/types/classes/_pendingextrinsics_.pendingextrinsics.md @@ -0,0 +1,351 @@ + + +# Type parameters +#### T : [Base](_codec_base_.base.md) +# Hierarchy + +↳ [Extrinsics](_extrinsics_.extrinsics.md) + +**↳ PendingExtrinsics** + +# Constructors + + + +## constructor + +⊕ **new PendingExtrinsics**(Type: *`object`*, value?: *`Array`<`any`>*): [PendingExtrinsics](_pendingextrinsics_.pendingextrinsics.md) + +*Inherited from [Vector](_codec_vector_.vector.md).[constructor](_codec_vector_.vector.md#constructor)* + +*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* + +*Defined in [codec/Vector.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L19)* + +**Parameters:** + +| Param | Type | Default value | +| ------ | ------ | ------ | +| Type | `object` | - | +| `Default value` value | `Array`<`any`> | [] as Array<any> | + +**Returns:** [PendingExtrinsics](_pendingextrinsics_.pendingextrinsics.md) + +___ + +# Properties + + + +## raw + +**● raw**: *`Array`<`T`>* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## Type + +getType(): `string` + +*Inherited from [Vector](_codec_vector_.vector.md).[Type](_codec_vector_.vector.md#type)* + +*Defined in [codec/Vector.ts:42](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L42)* + +**Returns:** `string` + +___ + + +## length + +getlength(): `number` + +*Inherited from [Vector](_codec_vector_.vector.md).[length](_codec_vector_.vector.md#length)* + +*Defined in [codec/Vector.ts:46](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L46)* + +**Returns:** `number` + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [Vector](_codec_vector_.vector.md).[byteLength](_codec_vector_.vector.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/Vector.ts:50](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L50)* + +**Returns:** `number` + +___ + + +## filter + +▸ **filter**(fn: *`function`*): `Array`<`T`> + +*Inherited from [Vector](_codec_vector_.vector.md).[filter](_codec_vector_.vector.md#filter)* + +*Defined in [codec/Vector.ts:56](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L56)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| fn | `function` | + +**Returns:** `Array`<`T`> + +___ + + +## find + +▸ **find**(fn: *`function`*): `T` | `undefined` + +*Inherited from [Vector](_codec_vector_.vector.md).[find](_codec_vector_.vector.md#find)* + +*Defined in [codec/Vector.ts:60](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L60)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| fn | `function` | + +**Returns:** `T` | `undefined` + +___ + + +## forEach + +▸ **forEach**(fn: *`function`*): `any` + +*Inherited from [Vector](_codec_vector_.vector.md).[forEach](_codec_vector_.vector.md#foreach)* + +*Defined in [codec/Vector.ts:64](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L64)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| fn | `function` | + +**Returns:** `any` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Vector](_codec_vector_.vector.md)<`T`> + +*Inherited from [Vector](_codec_vector_.vector.md).[fromJSON](_codec_vector_.vector.md#fromjson)* + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/Vector.ts:68](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L68)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Vector](_codec_vector_.vector.md)<`T`> + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Vector](_codec_vector_.vector.md)<`T`> + +*Inherited from [Vector](_codec_vector_.vector.md).[fromU8a](_codec_vector_.vector.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/Vector.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L76)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Vector](_codec_vector_.vector.md)<`T`> + +___ + + +## get + +▸ **get**(index: *`number`*): `T` + +*Inherited from [Vector](_codec_vector_.vector.md).[get](_codec_vector_.vector.md#get)* + +*Defined in [codec/Vector.ts:93](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L93)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| index | `number` | + +**Returns:** `T` + +___ + + +## map + +▸ **map**<`O`>(fn: *`function`*): `Array`<`O`> + +*Inherited from [Vector](_codec_vector_.vector.md).[map](_codec_vector_.vector.md#map)* + +*Defined in [codec/Vector.ts:97](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L97)* + +**Type parameters:** + +#### O +**Parameters:** + +| Param | Type | +| ------ | ------ | +| fn | `function` | + +**Returns:** `Array`<`O`> + +___ + + +## push + +▸ **push**(item: *`T`*): `void` + +*Inherited from [Vector](_codec_vector_.vector.md).[push](_codec_vector_.vector.md#push)* + +*Defined in [codec/Vector.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| item | `T` | + +**Returns:** `void` + +___ + + +## reduce + +▸ **reduce**<`O`>(fn: *`function`*, initial: *`O`*): `O` + +*Inherited from [Vector](_codec_vector_.vector.md).[reduce](_codec_vector_.vector.md#reduce)* + +*Defined in [codec/Vector.ts:106](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L106)* + +**Type parameters:** + +#### O +**Parameters:** + +| Param | Type | +| ------ | ------ | +| fn | `function` | +| initial | `O` | + +**Returns:** `O` + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [Vector](_codec_vector_.vector.md).[toJSON](_codec_vector_.vector.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/Vector.ts:110](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L110)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [Vector](_codec_vector_.vector.md).[toString](_codec_vector_.vector.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/Vector.ts:125](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L125)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [Vector](_codec_vector_.vector.md).[toU8a](_codec_vector_.vector.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/Vector.ts:116](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L116)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## `` with + +▸ **with**<`O`>(Type: *`object`*): `object` + +*Inherited from [Vector](_codec_vector_.vector.md).[with](_codec_vector_.vector.md#with)* + +*Defined in [codec/Vector.ts:34](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L34)* + +**Type parameters:** + +#### O : [Base](_codec_base_.base.md) +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Type | `object` | + +**Returns:** `object` + +___ + diff --git a/docs/types/classes/_perbill_.perbill.md b/docs/types/classes/_perbill_.perbill.md new file mode 100644 index 0000000000..dab7e7fbb5 --- /dev/null +++ b/docs/types/classes/_perbill_.perbill.md @@ -0,0 +1,399 @@ + + +# Hierarchy + +↳ [U32](_u32_.u32.md) + +**↳ Perbill** + +# Constructors + + + +## constructor + +⊕ **new Perbill**(value?: *[AnyNumber](../modules/_types_d_.md#anynumber)*): [Perbill](_perbill_.perbill.md) + +*Inherited from [U32](_u32_.u32.md).[constructor](_u32_.u32.md#constructor)* + +*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* + +*Defined in [U32.ts:9](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/U32.ts#L9)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | [AnyNumber](../modules/_types_d_.md#anynumber) | + +**Returns:** [Perbill](_perbill_.perbill.md) + +___ + +# Properties + + + +## raw + +**● raw**: *`BN`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Methods + + + +## add + +▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* + +*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L95)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [UInt](_codec_uint_.uint.md).[byteLength](_codec_uint_.uint.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/UInt.ts:53](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L53)* + +**Returns:** `number` + +___ + + +## cmp + +▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` + +*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* + +*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `number` + +___ + + +## div + +▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* + +*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L107)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [UInt](_codec_uint_.uint.md) + +*Inherited from [UInt](_codec_uint_.uint.md).[fromJSON](_codec_uint_.uint.md#fromjson)* + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L57)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [UInt](_codec_uint_.uint.md) + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [UInt](_codec_uint_.uint.md) + +*Inherited from [UInt](_codec_uint_.uint.md).[fromU8a](_codec_uint_.uint.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/UInt.ts:63](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L63)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [UInt](_codec_uint_.uint.md) + +___ + + +## gt + +▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* + +*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L129)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## gte + +▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* + +*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L135)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## isZero + +▸ **isZero**(): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* + +*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L113)* + +**Returns:** `boolean` + +___ + + +## lt + +▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* + +*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L117)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## lte + +▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* + +*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L123)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## mul + +▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* + +*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L141)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## sub + +▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* + +*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L147)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## toBn + +▸ **toBn**(): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* + +*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L85)* + +**Returns:** `BN` + +___ + + +## toHex + +▸ **toHex**(): `string` + +*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* + +*Defined in [codec/UInt.ts:69](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L69)* + +**Returns:** `string` + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L73)* + +**Returns:** `any` + +___ + + +## toNumber + +▸ **toNumber**(): `number` + +*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* + +*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L89)* + +**Returns:** `number` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/UInt.ts:81](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L81)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L77)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## `` decode + +▸ **decode**(value: *[AnyNumber](../modules/_types_d_.md#anynumber)*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[decode](_codec_uint_.uint.md#decode)* + +*Defined in [codec/UInt.ts:38](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L38)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| value | [AnyNumber](../modules/_types_d_.md#anynumber) | + +**Returns:** `BN` + +___ + diff --git a/docs/types/classes/_permill_.permill.md b/docs/types/classes/_permill_.permill.md new file mode 100644 index 0000000000..3a45ffb612 --- /dev/null +++ b/docs/types/classes/_permill_.permill.md @@ -0,0 +1,399 @@ + + +# Hierarchy + +↳ [U32](_u32_.u32.md) + +**↳ Permill** + +# Constructors + + + +## constructor + +⊕ **new Permill**(value?: *[AnyNumber](../modules/_types_d_.md#anynumber)*): [Permill](_permill_.permill.md) + +*Inherited from [U32](_u32_.u32.md).[constructor](_u32_.u32.md#constructor)* + +*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* + +*Defined in [U32.ts:9](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/U32.ts#L9)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | [AnyNumber](../modules/_types_d_.md#anynumber) | + +**Returns:** [Permill](_permill_.permill.md) + +___ + +# Properties + + + +## raw + +**● raw**: *`BN`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Methods + + + +## add + +▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* + +*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L95)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [UInt](_codec_uint_.uint.md).[byteLength](_codec_uint_.uint.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/UInt.ts:53](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L53)* + +**Returns:** `number` + +___ + + +## cmp + +▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` + +*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* + +*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `number` + +___ + + +## div + +▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* + +*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L107)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [UInt](_codec_uint_.uint.md) + +*Inherited from [UInt](_codec_uint_.uint.md).[fromJSON](_codec_uint_.uint.md#fromjson)* + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L57)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [UInt](_codec_uint_.uint.md) + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [UInt](_codec_uint_.uint.md) + +*Inherited from [UInt](_codec_uint_.uint.md).[fromU8a](_codec_uint_.uint.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/UInt.ts:63](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L63)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [UInt](_codec_uint_.uint.md) + +___ + + +## gt + +▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* + +*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L129)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## gte + +▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* + +*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L135)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## isZero + +▸ **isZero**(): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* + +*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L113)* + +**Returns:** `boolean` + +___ + + +## lt + +▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* + +*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L117)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## lte + +▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* + +*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L123)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## mul + +▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* + +*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L141)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## sub + +▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* + +*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L147)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## toBn + +▸ **toBn**(): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* + +*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L85)* + +**Returns:** `BN` + +___ + + +## toHex + +▸ **toHex**(): `string` + +*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* + +*Defined in [codec/UInt.ts:69](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L69)* + +**Returns:** `string` + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L73)* + +**Returns:** `any` + +___ + + +## toNumber + +▸ **toNumber**(): `number` + +*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* + +*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L89)* + +**Returns:** `number` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/UInt.ts:81](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L81)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L77)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## `` decode + +▸ **decode**(value: *[AnyNumber](../modules/_types_d_.md#anynumber)*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[decode](_codec_uint_.uint.md#decode)* + +*Defined in [codec/UInt.ts:38](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L38)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| value | [AnyNumber](../modules/_types_d_.md#anynumber) | + +**Returns:** `BN` + +___ + diff --git a/docs/types/classes/_propindex_.propindex.md b/docs/types/classes/_propindex_.propindex.md new file mode 100644 index 0000000000..dae91933c7 --- /dev/null +++ b/docs/types/classes/_propindex_.propindex.md @@ -0,0 +1,399 @@ + + +# Hierarchy + +↳ [U32](_u32_.u32.md) + +**↳ PropIndex** + +# Constructors + + + +## constructor + +⊕ **new PropIndex**(value?: *[AnyNumber](../modules/_types_d_.md#anynumber)*): [PropIndex](_propindex_.propindex.md) + +*Inherited from [U32](_u32_.u32.md).[constructor](_u32_.u32.md#constructor)* + +*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* + +*Defined in [U32.ts:9](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/U32.ts#L9)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | [AnyNumber](../modules/_types_d_.md#anynumber) | + +**Returns:** [PropIndex](_propindex_.propindex.md) + +___ + +# Properties + + + +## raw + +**● raw**: *`BN`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Methods + + + +## add + +▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* + +*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L95)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [UInt](_codec_uint_.uint.md).[byteLength](_codec_uint_.uint.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/UInt.ts:53](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L53)* + +**Returns:** `number` + +___ + + +## cmp + +▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` + +*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* + +*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `number` + +___ + + +## div + +▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* + +*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L107)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [UInt](_codec_uint_.uint.md) + +*Inherited from [UInt](_codec_uint_.uint.md).[fromJSON](_codec_uint_.uint.md#fromjson)* + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L57)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [UInt](_codec_uint_.uint.md) + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [UInt](_codec_uint_.uint.md) + +*Inherited from [UInt](_codec_uint_.uint.md).[fromU8a](_codec_uint_.uint.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/UInt.ts:63](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L63)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [UInt](_codec_uint_.uint.md) + +___ + + +## gt + +▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* + +*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L129)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## gte + +▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* + +*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L135)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## isZero + +▸ **isZero**(): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* + +*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L113)* + +**Returns:** `boolean` + +___ + + +## lt + +▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* + +*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L117)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## lte + +▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* + +*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L123)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## mul + +▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* + +*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L141)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## sub + +▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* + +*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L147)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## toBn + +▸ **toBn**(): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* + +*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L85)* + +**Returns:** `BN` + +___ + + +## toHex + +▸ **toHex**(): `string` + +*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* + +*Defined in [codec/UInt.ts:69](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L69)* + +**Returns:** `string` + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L73)* + +**Returns:** `any` + +___ + + +## toNumber + +▸ **toNumber**(): `number` + +*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* + +*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L89)* + +**Returns:** `number` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/UInt.ts:81](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L81)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L77)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## `` decode + +▸ **decode**(value: *[AnyNumber](../modules/_types_d_.md#anynumber)*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[decode](_codec_uint_.uint.md#decode)* + +*Defined in [codec/UInt.ts:38](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L38)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| value | [AnyNumber](../modules/_types_d_.md#anynumber) | + +**Returns:** `BN` + +___ + diff --git a/docs/types/classes/_proposal_.proposal.md b/docs/types/classes/_proposal_.proposal.md new file mode 100644 index 0000000000..28706d1dd6 --- /dev/null +++ b/docs/types/classes/_proposal_.proposal.md @@ -0,0 +1,212 @@ + + +# Hierarchy + +↳ [Extrinsic](_extrinsic_.extrinsic.md) + +**↳ Proposal** + +# Constructors + + + +## constructor + +⊕ **new Proposal**(value?: *[AnyU8a](../modules/_types_d_.md#anyu8a)*): [Proposal](_proposal_.proposal.md) + +*Inherited from [Bytes](_bytes_.bytes.md).[constructor](_bytes_.bytes.md#constructor)* + +*Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* + +*Defined in [Bytes.ts:16](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bytes.ts#L16)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | [AnyU8a](../modules/_types_d_.md#anyu8a) | + +**Returns:** [Proposal](_proposal_.proposal.md) + +___ + +# Properties + + + +## `` _length + +**● _length**: *[Length](_codec_length_.length.md)* + +*Inherited from [Bytes](_bytes_.bytes.md).[_length](_bytes_.bytes.md#_length)* + +*Defined in [Bytes.ts:16](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bytes.ts#L16)* + +___ + + +## raw + +**● raw**: *`Uint8Array`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## hash + +gethash(): [Hash](_hash_.hash.md) + +*Inherited from [Extrinsic](_extrinsic_.extrinsic.md).[hash](_extrinsic_.extrinsic.md#hash)* + +*Defined in [Extrinsic.ts:16](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Extrinsic.ts#L16)* + +**Returns:** [Hash](_hash_.hash.md) + +___ + + +## length + +getlength(): `number` + +*Inherited from [Bytes](_bytes_.bytes.md).[length](_bytes_.bytes.md#length)* + +*Overrides [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* + +*Defined in [Bytes.ts:24](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bytes.ts#L24)* + +**Returns:** `number` + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [Bytes](_bytes_.bytes.md).[byteLength](_bytes_.bytes.md#bytelength)* + +*Overrides [U8a](_codec_u8a_.u8a.md).[byteLength](_codec_u8a_.u8a.md#bytelength)* + +*Defined in [Bytes.ts:28](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bytes.ts#L28)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Bytes](_bytes_.bytes.md) + +*Inherited from [Bytes](_bytes_.bytes.md).[fromJSON](_bytes_.bytes.md#fromjson)* + +*Overrides [U8a](_codec_u8a_.u8a.md).[fromJSON](_codec_u8a_.u8a.md#fromjson)* + +*Defined in [Bytes.ts:32](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bytes.ts#L32)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Bytes](_bytes_.bytes.md) + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Bytes](_bytes_.bytes.md) + +*Inherited from [Bytes](_bytes_.bytes.md).[fromU8a](_bytes_.bytes.md#fromu8a)* + +*Overrides [U8a](_codec_u8a_.u8a.md).[fromU8a](_codec_u8a_.u8a.md#fromu8a)* + +*Defined in [Bytes.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bytes.ts#L40)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Bytes](_bytes_.bytes.md) + +___ + + +## toHex + +▸ **toHex**(): `string` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* + +*Defined in [codec/U8a.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L45)* + +**Returns:** `string` + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/U8a.ts:49](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L49)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/U8a.ts:57](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L57)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [Bytes](_bytes_.bytes.md).[toU8a](_bytes_.bytes.md#tou8a)* + +*Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* + +*Defined in [Bytes.ts:51](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bytes.ts#L51)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + diff --git a/docs/types/classes/_proposalindex_.proposalindex.md b/docs/types/classes/_proposalindex_.proposalindex.md new file mode 100644 index 0000000000..8ec8ab3dfb --- /dev/null +++ b/docs/types/classes/_proposalindex_.proposalindex.md @@ -0,0 +1,399 @@ + + +# Hierarchy + +↳ [U32](_u32_.u32.md) + +**↳ ProposalIndex** + +# Constructors + + + +## constructor + +⊕ **new ProposalIndex**(value?: *[AnyNumber](../modules/_types_d_.md#anynumber)*): [ProposalIndex](_proposalindex_.proposalindex.md) + +*Inherited from [U32](_u32_.u32.md).[constructor](_u32_.u32.md#constructor)* + +*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* + +*Defined in [U32.ts:9](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/U32.ts#L9)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | [AnyNumber](../modules/_types_d_.md#anynumber) | + +**Returns:** [ProposalIndex](_proposalindex_.proposalindex.md) + +___ + +# Properties + + + +## raw + +**● raw**: *`BN`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Methods + + + +## add + +▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* + +*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L95)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [UInt](_codec_uint_.uint.md).[byteLength](_codec_uint_.uint.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/UInt.ts:53](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L53)* + +**Returns:** `number` + +___ + + +## cmp + +▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` + +*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* + +*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `number` + +___ + + +## div + +▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* + +*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L107)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [UInt](_codec_uint_.uint.md) + +*Inherited from [UInt](_codec_uint_.uint.md).[fromJSON](_codec_uint_.uint.md#fromjson)* + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L57)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [UInt](_codec_uint_.uint.md) + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [UInt](_codec_uint_.uint.md) + +*Inherited from [UInt](_codec_uint_.uint.md).[fromU8a](_codec_uint_.uint.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/UInt.ts:63](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L63)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [UInt](_codec_uint_.uint.md) + +___ + + +## gt + +▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* + +*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L129)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## gte + +▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* + +*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L135)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## isZero + +▸ **isZero**(): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* + +*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L113)* + +**Returns:** `boolean` + +___ + + +## lt + +▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* + +*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L117)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## lte + +▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* + +*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L123)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## mul + +▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* + +*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L141)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## sub + +▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* + +*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L147)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## toBn + +▸ **toBn**(): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* + +*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L85)* + +**Returns:** `BN` + +___ + + +## toHex + +▸ **toHex**(): `string` + +*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* + +*Defined in [codec/UInt.ts:69](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L69)* + +**Returns:** `string` + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L73)* + +**Returns:** `any` + +___ + + +## toNumber + +▸ **toNumber**(): `number` + +*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* + +*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L89)* + +**Returns:** `number` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/UInt.ts:81](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L81)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L77)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## `` decode + +▸ **decode**(value: *[AnyNumber](../modules/_types_d_.md#anynumber)*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[decode](_codec_uint_.uint.md#decode)* + +*Defined in [codec/UInt.ts:38](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L38)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| value | [AnyNumber](../modules/_types_d_.md#anynumber) | + +**Returns:** `BN` + +___ + diff --git a/docs/types/classes/_rawaddress_.rawaddress.md b/docs/types/classes/_rawaddress_.rawaddress.md new file mode 100644 index 0000000000..0a0436a871 --- /dev/null +++ b/docs/types/classes/_rawaddress_.rawaddress.md @@ -0,0 +1,215 @@ + + +# Hierarchy + +↳ [Address](_address_.address.md) + +**↳ RawAddress** + +# Constructors + + + +## constructor + +⊕ **new RawAddress**(value?: * [Address](_address_.address.md) | [AccountId](_accountid_.accountid.md) | [AccountIndex](_accountindex_.accountindex.md) | `string` | `Uint8Array`*): [RawAddress](_rawaddress_.rawaddress.md) + +*Inherited from [Address](_address_.address.md).[constructor](_address_.address.md#constructor)* + +*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* + +*Defined in [Address.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Address.ts#L19)* + +**Parameters:** + +| Param | Type | Default value | +| ------ | ------ | ------ | +| `Default value` value | [Address](_address_.address.md) | [AccountId](_accountid_.accountid.md) | [AccountIndex](_accountindex_.accountindex.md) | `string` | `Uint8Array`| new Uint8Array() | + +**Returns:** [RawAddress](_rawaddress_.rawaddress.md) + +___ + +# Properties + + + +## raw + +**● raw**: * [AccountId](_accountid_.accountid.md) | [AccountIndex](_accountindex_.accountindex.md) +* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [Address](_address_.address.md).[byteLength](_address_.address.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [Address.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Address.ts#L86)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Address](_address_.address.md) + +*Inherited from [Address](_address_.address.md).[fromJSON](_address_.address.md#fromjson)* + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [Address.ts:90](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Address.ts#L90)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Address](_address_.address.md) + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Address](_address_.address.md) + +*Inherited from [Address](_address_.address.md).[fromU8a](_address_.address.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [Address.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Address.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Address](_address_.address.md) + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [Address](_address_.address.md).[toJSON](_address_.address.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [Address.ts:109](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Address.ts#L109)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [Address](_address_.address.md).[toString](_address_.address.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [Address.ts:113](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Address.ts#L113)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [Address](_address_.address.md).[toU8a](_address_.address.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [Address.ts:117](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Address.ts#L117)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## `` decode + +▸ **decode**(value: * [AccountId](_accountid_.accountid.md) | [AccountIndex](_accountindex_.accountindex.md) | `string` | `Uint8Array` | `Array`<`number`>*): [AccountId](_accountid_.accountid.md) | [AccountIndex](_accountindex_.accountindex.md) + +*Inherited from [Address](_address_.address.md).[decode](_address_.address.md#decode)* + +*Defined in [Address.ts:28](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Address.ts#L28)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| value | [AccountId](_accountid_.accountid.md) | [AccountIndex](_accountindex_.accountindex.md) | `string` | `Uint8Array` | `Array`<`number`>| + +**Returns:** [AccountId](_accountid_.accountid.md) | [AccountIndex](_accountindex_.accountindex.md) + +___ + + +## `` readLength + +▸ **readLength**(input: *`Uint8Array`*): `number` + +*Inherited from [Address](_address_.address.md).[readLength](_address_.address.md#readlength)* + +*Defined in [Address.ts:52](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Address.ts#L52)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** `number` + +___ + + +## `` writeLength + +▸ **writeLength**(length: *`number`*): `Uint8Array` + +*Inherited from [Address](_address_.address.md).[writeLength](_address_.address.md#writelength)* + +*Defined in [Address.ts:70](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Address.ts#L70)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| length | `number` | + +**Returns:** `Uint8Array` + +___ + diff --git a/docs/types/classes/_referendumindex_.referendumindex.md b/docs/types/classes/_referendumindex_.referendumindex.md new file mode 100644 index 0000000000..a69a0ef8d0 --- /dev/null +++ b/docs/types/classes/_referendumindex_.referendumindex.md @@ -0,0 +1,399 @@ + + +# Hierarchy + +↳ [U32](_u32_.u32.md) + +**↳ ReferendumIndex** + +# Constructors + + + +## constructor + +⊕ **new ReferendumIndex**(value?: *[AnyNumber](../modules/_types_d_.md#anynumber)*): [ReferendumIndex](_referendumindex_.referendumindex.md) + +*Inherited from [U32](_u32_.u32.md).[constructor](_u32_.u32.md#constructor)* + +*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* + +*Defined in [U32.ts:9](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/U32.ts#L9)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | [AnyNumber](../modules/_types_d_.md#anynumber) | + +**Returns:** [ReferendumIndex](_referendumindex_.referendumindex.md) + +___ + +# Properties + + + +## raw + +**● raw**: *`BN`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Methods + + + +## add + +▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* + +*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L95)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [UInt](_codec_uint_.uint.md).[byteLength](_codec_uint_.uint.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/UInt.ts:53](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L53)* + +**Returns:** `number` + +___ + + +## cmp + +▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` + +*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* + +*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `number` + +___ + + +## div + +▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* + +*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L107)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [UInt](_codec_uint_.uint.md) + +*Inherited from [UInt](_codec_uint_.uint.md).[fromJSON](_codec_uint_.uint.md#fromjson)* + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L57)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [UInt](_codec_uint_.uint.md) + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [UInt](_codec_uint_.uint.md) + +*Inherited from [UInt](_codec_uint_.uint.md).[fromU8a](_codec_uint_.uint.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/UInt.ts:63](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L63)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [UInt](_codec_uint_.uint.md) + +___ + + +## gt + +▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* + +*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L129)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## gte + +▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* + +*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L135)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## isZero + +▸ **isZero**(): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* + +*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L113)* + +**Returns:** `boolean` + +___ + + +## lt + +▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* + +*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L117)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## lte + +▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* + +*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L123)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## mul + +▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* + +*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L141)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## sub + +▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* + +*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L147)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## toBn + +▸ **toBn**(): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* + +*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L85)* + +**Returns:** `BN` + +___ + + +## toHex + +▸ **toHex**(): `string` + +*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* + +*Defined in [codec/UInt.ts:69](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L69)* + +**Returns:** `string` + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L73)* + +**Returns:** `any` + +___ + + +## toNumber + +▸ **toNumber**(): `number` + +*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* + +*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L89)* + +**Returns:** `number` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/UInt.ts:81](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L81)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L77)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## `` decode + +▸ **decode**(value: *[AnyNumber](../modules/_types_d_.md#anynumber)*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[decode](_codec_uint_.uint.md#decode)* + +*Defined in [codec/UInt.ts:38](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L38)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| value | [AnyNumber](../modules/_types_d_.md#anynumber) | + +**Returns:** `BN` + +___ + diff --git a/docs/types/classes/_runtimeversion_.runtimeversion.md b/docs/types/classes/_runtimeversion_.runtimeversion.md new file mode 100644 index 0000000000..d94af29f60 --- /dev/null +++ b/docs/types/classes/_runtimeversion_.runtimeversion.md @@ -0,0 +1,357 @@ + + +# Type parameters +#### S +#### T +#### V +#### E +# Hierarchy + +↳ [Struct](_codec_struct_.struct.md) + +**↳ RuntimeVersion** + +# Constructors + + + +## constructor + +⊕ **new RuntimeVersion**(value?: *`RuntimeVersionValue`*): [RuntimeVersion](_runtimeversion_.runtimeversion.md) + +*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* + +*Defined in [RuntimeVersion.ts:51](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/RuntimeVersion.ts#L51)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | `RuntimeVersionValue` | + +**Returns:** [RuntimeVersion](_runtimeversion_.runtimeversion.md) + +___ + +# Properties + + + +## `` _Types + +**● _Types**: *`E`* + +*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* + +*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)* + +___ + + +## `` _jsonMap + +**● _jsonMap**: *`Map`<`keyof S`, `string`>* + +*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* + +*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)* + +___ + + +## raw + +**● raw**: *`T`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## Type + +getType(): `E` + +*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* + +*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)* + +**Returns:** `E` + +___ + + +## apis + +getapis(): [Vector](_codec_vector_.vector.md)<`RuntimeVersionApi`> + +*Defined in [RuntimeVersion.ts:69](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/RuntimeVersion.ts#L69)* + +**Returns:** [Vector](_codec_vector_.vector.md)<`RuntimeVersionApi`> + +___ + + +## authoringVersion + +getauthoringVersion(): [U32](_u32_.u32.md) + +*Defined in [RuntimeVersion.ts:73](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/RuntimeVersion.ts#L73)* + +**Returns:** [U32](_u32_.u32.md) + +___ + + +## implName + +getimplName(): [Text](_text_.text.md) + +*Defined in [RuntimeVersion.ts:77](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/RuntimeVersion.ts#L77)* + +**Returns:** [Text](_text_.text.md) + +___ + + +## implVersion + +getimplVersion(): [U32](_u32_.u32.md) + +*Defined in [RuntimeVersion.ts:81](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/RuntimeVersion.ts#L81)* + +**Returns:** [U32](_u32_.u32.md) + +___ + + +## specName + +getspecName(): [Text](_text_.text.md) + +*Defined in [RuntimeVersion.ts:85](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/RuntimeVersion.ts#L85)* + +**Returns:** [Text](_text_.text.md) + +___ + + +## specVersion + +getspecVersion(): [U32](_u32_.u32.md) + +*Defined in [RuntimeVersion.ts:89](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/RuntimeVersion.ts#L89)* + +**Returns:** [U32](_u32_.u32.md) + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L86)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## get + +▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) + +*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* + +*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| index | `number` | + +**Returns:** [Base](_codec_base_.base.md) + +___ + + +## keys + +▸ **keys**(): `Array`<`string`> + +*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* + +*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)* + +**Returns:** `Array`<`string`> + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L115)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## values + +▸ **values**(): `Array`<[Base](_codec_base_.base.md)> + +*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* + +*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)* + +**Returns:** `Array`<[Base](_codec_base_.base.md)> + +___ + + +## `` decode + +▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` + +*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* + +*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)* + +**Type parameters:** + +#### S +#### V +#### T +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | +| value | `V` | `Array`<`any`>| +| isTuple | `boolean` | + +**Returns:** `T` + +___ + + +## `` with + +▸ **with**<`S`>(Types: *`S`*): `object` + +*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* + +*Defined in [codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L66)* + +**Type parameters:** + +#### S +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | + +**Returns:** `object` + +___ + diff --git a/docs/types/classes/_signature_.signature.md b/docs/types/classes/_signature_.signature.md new file mode 100644 index 0000000000..4a75cd7d7e --- /dev/null +++ b/docs/types/classes/_signature_.signature.md @@ -0,0 +1,197 @@ + + +# Hierarchy + +↳ [H512](_h512_.h512.md) + +**↳ Signature** + +# Constructors + + + +## constructor + +⊕ **new Signature**(value?: *[AnyU8a](../modules/_types_d_.md#anyu8a)*): [Signature](_signature_.signature.md) + +*Inherited from [H512](_h512_.h512.md).[constructor](_h512_.h512.md#constructor)* + +*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* + +*Defined in [H512.ts:10](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/H512.ts#L10)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | [AnyU8a](../modules/_types_d_.md#anyu8a) | + +**Returns:** [Signature](_signature_.signature.md) + +___ + +# Properties + + + +## `` _bitLength + +**● _bitLength**: *`number`* + +*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[_bitLength](_codec_u8afixed_.u8afixed.md#_bitlength)* + +*Defined in [codec/U8aFixed.ts:14](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8aFixed.ts#L14)* + +___ + + +## raw + +**● raw**: *`Uint8Array`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## length + +getlength(): `number` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* + +*Defined in [codec/U8a.ts:25](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L25)* + +**Returns:** `number` + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[byteLength](_codec_u8afixed_.u8afixed.md#bytelength)* + +*Overrides [U8a](_codec_u8a_.u8a.md).[byteLength](_codec_u8a_.u8a.md#bytelength)* + +*Defined in [codec/U8aFixed.ts:28](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8aFixed.ts#L28)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [U8aFixed](_codec_u8afixed_.u8afixed.md) + +*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[fromJSON](_codec_u8afixed_.u8afixed.md#fromjson)* + +*Overrides [U8a](_codec_u8a_.u8a.md).[fromJSON](_codec_u8a_.u8a.md#fromjson)* + +*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8aFixed.ts#L32)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [U8aFixed](_codec_u8afixed_.u8afixed.md) + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [U8aFixed](_codec_u8afixed_.u8afixed.md) + +*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[fromU8a](_codec_u8afixed_.u8afixed.md#fromu8a)* + +*Overrides [U8a](_codec_u8a_.u8a.md).[fromU8a](_codec_u8a_.u8a.md#fromu8a)* + +*Defined in [codec/U8aFixed.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8aFixed.ts#L40)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [U8aFixed](_codec_u8afixed_.u8afixed.md) + +___ + + +## toHex + +▸ **toHex**(): `string` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* + +*Defined in [codec/U8a.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L45)* + +**Returns:** `string` + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/U8a.ts:49](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L49)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/U8a.ts:57](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L57)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L53)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + diff --git a/docs/types/classes/_signedblock_.signedblock.md b/docs/types/classes/_signedblock_.signedblock.md new file mode 100644 index 0000000000..b8f41c72e7 --- /dev/null +++ b/docs/types/classes/_signedblock_.signedblock.md @@ -0,0 +1,313 @@ + + +# Type parameters +#### S +#### T +#### V +#### E +# Hierarchy + +↳ [Struct](_codec_struct_.struct.md) + +**↳ SignedBlock** + +# Constructors + + + +## constructor + +⊕ **new SignedBlock**(value?: *`SignedBlockValue`*): [SignedBlock](_signedblock_.signedblock.md) + +*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* + +*Defined in [SignedBlock.ts:14](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/SignedBlock.ts#L14)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | `SignedBlockValue` | + +**Returns:** [SignedBlock](_signedblock_.signedblock.md) + +___ + +# Properties + + + +## `` _Types + +**● _Types**: *`E`* + +*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* + +*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)* + +___ + + +## `` _jsonMap + +**● _jsonMap**: *`Map`<`keyof S`, `string`>* + +*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* + +*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)* + +___ + + +## raw + +**● raw**: *`T`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## Type + +getType(): `E` + +*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* + +*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)* + +**Returns:** `E` + +___ + + +## block + +getblock(): [Block](_block_.block.md) + +*Defined in [SignedBlock.ts:22](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/SignedBlock.ts#L22)* + +**Returns:** [Block](_block_.block.md) + +___ + + +## justification + +getjustification(): [Justification](_bft_.justification.md) + +*Defined in [SignedBlock.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/SignedBlock.ts#L26)* + +**Returns:** [Justification](_bft_.justification.md) + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L86)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## get + +▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) + +*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* + +*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| index | `number` | + +**Returns:** [Base](_codec_base_.base.md) + +___ + + +## keys + +▸ **keys**(): `Array`<`string`> + +*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* + +*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)* + +**Returns:** `Array`<`string`> + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L115)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## values + +▸ **values**(): `Array`<[Base](_codec_base_.base.md)> + +*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* + +*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)* + +**Returns:** `Array`<[Base](_codec_base_.base.md)> + +___ + + +## `` decode + +▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` + +*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* + +*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)* + +**Type parameters:** + +#### S +#### V +#### T +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | +| value | `V` | `Array`<`any`>| +| isTuple | `boolean` | + +**Returns:** `T` + +___ + + +## `` with + +▸ **with**<`S`>(Types: *`S`*): `object` + +*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* + +*Defined in [codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L66)* + +**Type parameters:** + +#### S +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | + +**Returns:** `object` + +___ + diff --git a/docs/types/classes/_storagechangeset_.storagechangeset.md b/docs/types/classes/_storagechangeset_.storagechangeset.md new file mode 100644 index 0000000000..42b8a9e4af --- /dev/null +++ b/docs/types/classes/_storagechangeset_.storagechangeset.md @@ -0,0 +1,313 @@ + + +# Type parameters +#### S +#### T +#### V +#### E +# Hierarchy + +↳ [Struct](_codec_struct_.struct.md) + +**↳ StorageChangeSet** + +# Constructors + + + +## constructor + +⊕ **new StorageChangeSet**(value?: *`StorageChangeSetValue`*): [StorageChangeSet](_storagechangeset_.storagechangeset.md) + +*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* + +*Defined in [StorageChangeSet.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/StorageChangeSet.ts#L19)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | `StorageChangeSetValue` | + +**Returns:** [StorageChangeSet](_storagechangeset_.storagechangeset.md) + +___ + +# Properties + + + +## `` _Types + +**● _Types**: *`E`* + +*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* + +*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)* + +___ + + +## `` _jsonMap + +**● _jsonMap**: *`Map`<`keyof S`, `string`>* + +*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* + +*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)* + +___ + + +## raw + +**● raw**: *`T`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## Type + +getType(): `E` + +*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* + +*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)* + +**Returns:** `E` + +___ + + +## changes + +getchanges(): [Vector](_codec_vector_.vector.md)<[KeyValueOption](_keyvalue_.keyvalueoption.md)> + +*Defined in [StorageChangeSet.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/StorageChangeSet.ts#L27)* + +**Returns:** [Vector](_codec_vector_.vector.md)<[KeyValueOption](_keyvalue_.keyvalueoption.md)> + +___ + + +## hash + +gethash(): [Hash](_hash_.hash.md) + +*Defined in [StorageChangeSet.ts:31](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/StorageChangeSet.ts#L31)* + +**Returns:** [Hash](_hash_.hash.md) + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L86)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## get + +▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) + +*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* + +*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| index | `number` | + +**Returns:** [Base](_codec_base_.base.md) + +___ + + +## keys + +▸ **keys**(): `Array`<`string`> + +*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* + +*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)* + +**Returns:** `Array`<`string`> + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L115)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## values + +▸ **values**(): `Array`<[Base](_codec_base_.base.md)> + +*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* + +*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)* + +**Returns:** `Array`<[Base](_codec_base_.base.md)> + +___ + + +## `` decode + +▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` + +*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* + +*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)* + +**Type parameters:** + +#### S +#### V +#### T +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | +| value | `V` | `Array`<`any`>| +| isTuple | `boolean` | + +**Returns:** `T` + +___ + + +## `` with + +▸ **with**<`S`>(Types: *`S`*): `object` + +*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* + +*Defined in [codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L66)* + +**Type parameters:** + +#### S +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | + +**Returns:** `object` + +___ + diff --git a/docs/types/classes/_storagedata_.storagedata.md b/docs/types/classes/_storagedata_.storagedata.md new file mode 100644 index 0000000000..3c9bc88912 --- /dev/null +++ b/docs/types/classes/_storagedata_.storagedata.md @@ -0,0 +1,199 @@ + + +# Hierarchy + +↳ [Bytes](_bytes_.bytes.md) + +**↳ StorageData** + +# Constructors + + + +## constructor + +⊕ **new StorageData**(value?: *[AnyU8a](../modules/_types_d_.md#anyu8a)*): [StorageData](_storagedata_.storagedata.md) + +*Inherited from [Bytes](_bytes_.bytes.md).[constructor](_bytes_.bytes.md#constructor)* + +*Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* + +*Defined in [Bytes.ts:16](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bytes.ts#L16)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | [AnyU8a](../modules/_types_d_.md#anyu8a) | + +**Returns:** [StorageData](_storagedata_.storagedata.md) + +___ + +# Properties + + + +## `` _length + +**● _length**: *[Length](_codec_length_.length.md)* + +*Inherited from [Bytes](_bytes_.bytes.md).[_length](_bytes_.bytes.md#_length)* + +*Defined in [Bytes.ts:16](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bytes.ts#L16)* + +___ + + +## raw + +**● raw**: *`Uint8Array`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## length + +getlength(): `number` + +*Inherited from [Bytes](_bytes_.bytes.md).[length](_bytes_.bytes.md#length)* + +*Overrides [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* + +*Defined in [Bytes.ts:24](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bytes.ts#L24)* + +**Returns:** `number` + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [Bytes](_bytes_.bytes.md).[byteLength](_bytes_.bytes.md#bytelength)* + +*Overrides [U8a](_codec_u8a_.u8a.md).[byteLength](_codec_u8a_.u8a.md#bytelength)* + +*Defined in [Bytes.ts:28](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bytes.ts#L28)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Bytes](_bytes_.bytes.md) + +*Inherited from [Bytes](_bytes_.bytes.md).[fromJSON](_bytes_.bytes.md#fromjson)* + +*Overrides [U8a](_codec_u8a_.u8a.md).[fromJSON](_codec_u8a_.u8a.md#fromjson)* + +*Defined in [Bytes.ts:32](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bytes.ts#L32)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Bytes](_bytes_.bytes.md) + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Bytes](_bytes_.bytes.md) + +*Inherited from [Bytes](_bytes_.bytes.md).[fromU8a](_bytes_.bytes.md#fromu8a)* + +*Overrides [U8a](_codec_u8a_.u8a.md).[fromU8a](_codec_u8a_.u8a.md#fromu8a)* + +*Defined in [Bytes.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bytes.ts#L40)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Bytes](_bytes_.bytes.md) + +___ + + +## toHex + +▸ **toHex**(): `string` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* + +*Defined in [codec/U8a.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L45)* + +**Returns:** `string` + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/U8a.ts:49](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L49)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/U8a.ts:57](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L57)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [Bytes](_bytes_.bytes.md).[toU8a](_bytes_.bytes.md#tou8a)* + +*Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* + +*Defined in [Bytes.ts:51](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bytes.ts#L51)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + diff --git a/docs/types/classes/_storagekey_.storagekey.md b/docs/types/classes/_storagekey_.storagekey.md new file mode 100644 index 0000000000..618795446b --- /dev/null +++ b/docs/types/classes/_storagekey_.storagekey.md @@ -0,0 +1,242 @@ + + +# Hierarchy + +↳ [Bytes](_bytes_.bytes.md) + +**↳ StorageKey** + +# Constructors + + + +## constructor + +⊕ **new StorageKey**(value: * [AnyU8a](../modules/_types_d_.md#anyu8a) | [StorageKey](_storagekey_.storagekey.md) | [StorageFunction](../interfaces/_storagekey_.storagefunction.md) | [[StorageFunction](../interfaces/_storagekey_.storagefunction.md), `any`]*): [StorageKey](_storagekey_.storagekey.md) + +*Overrides [Bytes](_bytes_.bytes.md).[constructor](_bytes_.bytes.md#constructor)* + +*Defined in [StorageKey.ts:25](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/StorageKey.ts#L25)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| value | [AnyU8a](../modules/_types_d_.md#anyu8a) | [StorageKey](_storagekey_.storagekey.md) | [StorageFunction](../interfaces/_storagekey_.storagefunction.md) | [[StorageFunction](../interfaces/_storagekey_.storagefunction.md), `any`]| + +**Returns:** [StorageKey](_storagekey_.storagekey.md) + +___ + +# Properties + + + +## `` _length + +**● _length**: *[Length](_codec_length_.length.md)* + +*Inherited from [Bytes](_bytes_.bytes.md).[_length](_bytes_.bytes.md#_length)* + +*Defined in [Bytes.ts:16](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bytes.ts#L16)* + +___ + + +## raw + +**● raw**: *`Uint8Array`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## length + +getlength(): `number` + +*Inherited from [Bytes](_bytes_.bytes.md).[length](_bytes_.bytes.md#length)* + +*Overrides [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* + +*Defined in [Bytes.ts:24](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bytes.ts#L24)* + +**Returns:** `number` + +___ + + +## outputType + +getoutputType(): `string` | `null` + +*Defined in [StorageKey.ts:63](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/StorageKey.ts#L63)* + +**Returns:** `string` | `null` + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [Bytes](_bytes_.bytes.md).[byteLength](_bytes_.bytes.md#bytelength)* + +*Overrides [U8a](_codec_u8a_.u8a.md).[byteLength](_codec_u8a_.u8a.md#bytelength)* + +*Defined in [Bytes.ts:28](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bytes.ts#L28)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Bytes](_bytes_.bytes.md) + +*Inherited from [Bytes](_bytes_.bytes.md).[fromJSON](_bytes_.bytes.md#fromjson)* + +*Overrides [U8a](_codec_u8a_.u8a.md).[fromJSON](_codec_u8a_.u8a.md#fromjson)* + +*Defined in [Bytes.ts:32](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bytes.ts#L32)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Bytes](_bytes_.bytes.md) + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Bytes](_bytes_.bytes.md) + +*Inherited from [Bytes](_bytes_.bytes.md).[fromU8a](_bytes_.bytes.md#fromu8a)* + +*Overrides [U8a](_codec_u8a_.u8a.md).[fromU8a](_codec_u8a_.u8a.md#fromu8a)* + +*Defined in [Bytes.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bytes.ts#L40)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Bytes](_bytes_.bytes.md) + +___ + + +## toHex + +▸ **toHex**(): `string` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* + +*Defined in [codec/U8a.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L45)* + +**Returns:** `string` + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/U8a.ts:49](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L49)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/U8a.ts:57](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L57)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [Bytes](_bytes_.bytes.md).[toU8a](_bytes_.bytes.md#tou8a)* + +*Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* + +*Defined in [Bytes.ts:51](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bytes.ts#L51)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## `` encode + +▸ **encode**(value: * [AnyU8a](../modules/_types_d_.md#anyu8a) | [StorageKey](_storagekey_.storagekey.md) | [StorageFunction](../interfaces/_storagekey_.storagefunction.md) | [[StorageFunction](../interfaces/_storagekey_.storagefunction.md), `any`]*): `Uint8Array` + +*Defined in [StorageKey.ts:33](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/StorageKey.ts#L33)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| value | [AnyU8a](../modules/_types_d_.md#anyu8a) | [StorageKey](_storagekey_.storagekey.md) | [StorageFunction](../interfaces/_storagekey_.storagefunction.md) | [[StorageFunction](../interfaces/_storagekey_.storagefunction.md), `any`]| + +**Returns:** `Uint8Array` + +___ + + +## `` getType + +▸ **getType**(value: * [StorageKey](_storagekey_.storagekey.md) | [StorageFunction](../interfaces/_storagekey_.storagefunction.md) | [[StorageFunction](../interfaces/_storagekey_.storagefunction.md), `any`]*): `string` | `null` + +*Defined in [StorageKey.ts:49](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/StorageKey.ts#L49)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| value | [StorageKey](_storagekey_.storagekey.md) | [StorageFunction](../interfaces/_storagekey_.storagefunction.md) | [[StorageFunction](../interfaces/_storagekey_.storagefunction.md), `any`]| + +**Returns:** `string` | `null` + +___ + diff --git a/docs/types/classes/_text_.text.md b/docs/types/classes/_text_.text.md new file mode 100644 index 0000000000..f3833af1cc --- /dev/null +++ b/docs/types/classes/_text_.text.md @@ -0,0 +1,168 @@ + + +# Hierarchy + + [Base](_codec_base_.base.md)<`string`> + +**↳ Text** + +↳ [Type](_type_.type.md) + +# Constructors + + + +## constructor + +⊕ **new Text**(value?: * [Text](_text_.text.md) | `string`*): [Text](_text_.text.md) + +*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* + +*Defined in [Text.ts:21](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Text.ts#L21)* + +**Parameters:** + +| Param | Type | Default value | +| ------ | ------ | ------ | +| `Default value` value | [Text](_text_.text.md) | `string`| "" | + +**Returns:** [Text](_text_.text.md) + +___ + +# Properties + + + +## `` _length + +**● _length**: *[Length](_codec_length_.length.md)* + +*Defined in [Text.ts:21](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Text.ts#L21)* + +___ + + +## raw + +**● raw**: *`string`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## length + +getlength(): `number` + +*Defined in [Text.ts:33](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Text.ts#L33)* + +**Returns:** `number` + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [Text.ts:37](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Text.ts#L37)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Text](_text_.text.md) + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [Text.ts:44](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Text.ts#L44)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Text](_text_.text.md) + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Text](_text_.text.md) + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [Text.ts:50](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Text.ts#L50)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Text](_text_.text.md) + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [Text.ts:61](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Text.ts#L61)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [Text.ts:65](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Text.ts#L65)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [Text.ts:69](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Text.ts#L69)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + diff --git a/docs/types/classes/_type_.type.md b/docs/types/classes/_type_.type.md new file mode 100644 index 0000000000..25088d1176 --- /dev/null +++ b/docs/types/classes/_type_.type.md @@ -0,0 +1,176 @@ + + +# Hierarchy + +↳ [Text](_text_.text.md) + +**↳ Type** + +# Constructors + + + +## constructor + +⊕ **new Type**(value?: * [Text](_text_.text.md) | `string`*): [Type](_type_.type.md) + +*Overrides [Text](_text_.text.md).[constructor](_text_.text.md#constructor)* + +*Defined in [Type.ts:14](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Type.ts#L14)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | [Text](_text_.text.md) | `string`| + +**Returns:** [Type](_type_.type.md) + +___ + +# Properties + + + +## `` _length + +**● _length**: *[Length](_codec_length_.length.md)* + +*Inherited from [Text](_text_.text.md).[_length](_text_.text.md#_length)* + +*Defined in [Text.ts:21](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Text.ts#L21)* + +___ + + +## raw + +**● raw**: *`string`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## length + +getlength(): `number` + +*Inherited from [Text](_text_.text.md).[length](_text_.text.md#length)* + +*Defined in [Text.ts:33](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Text.ts#L33)* + +**Returns:** `number` + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [Text](_text_.text.md).[byteLength](_text_.text.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [Text.ts:37](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Text.ts#L37)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Type](_type_.type.md) + +*Overrides [Text](_text_.text.md).[fromJSON](_text_.text.md#fromjson)* + +*Defined in [Type.ts:21](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Type.ts#L21)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Type](_type_.type.md) + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Type](_type_.type.md) + +*Overrides [Text](_text_.text.md).[fromU8a](_text_.text.md#fromu8a)* + +*Defined in [Type.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Type.ts#L27)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Type](_type_.type.md) + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [Text](_text_.text.md).[toJSON](_text_.text.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [Text.ts:61](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Text.ts#L61)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [Text](_text_.text.md).[toString](_text_.text.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [Text.ts:65](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Text.ts#L65)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Overrides [Text](_text_.text.md).[toU8a](_text_.text.md#tou8a)* + +*Defined in [Type.ts:36](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Type.ts#L36)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + diff --git a/docs/types/classes/_u128_.u128.md b/docs/types/classes/_u128_.u128.md new file mode 100644 index 0000000000..eefa611241 --- /dev/null +++ b/docs/types/classes/_u128_.u128.md @@ -0,0 +1,399 @@ + + +# Hierarchy + +↳ [UInt](_codec_uint_.uint.md) + +**↳ U128** + +↳ [Balance](_balance_.balance.md) + +# Constructors + + + +## constructor + +⊕ **new U128**(value?: *[AnyNumber](../modules/_types_d_.md#anynumber)*): [U128](_u128_.u128.md) + +*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* + +*Defined in [U128.ts:9](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/U128.ts#L9)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | [AnyNumber](../modules/_types_d_.md#anynumber) | + +**Returns:** [U128](_u128_.u128.md) + +___ + +# Properties + + + +## raw + +**● raw**: *`BN`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Methods + + + +## add + +▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* + +*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L95)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [UInt](_codec_uint_.uint.md).[byteLength](_codec_uint_.uint.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/UInt.ts:53](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L53)* + +**Returns:** `number` + +___ + + +## cmp + +▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` + +*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* + +*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `number` + +___ + + +## div + +▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* + +*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L107)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [UInt](_codec_uint_.uint.md) + +*Inherited from [UInt](_codec_uint_.uint.md).[fromJSON](_codec_uint_.uint.md#fromjson)* + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L57)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [UInt](_codec_uint_.uint.md) + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [UInt](_codec_uint_.uint.md) + +*Inherited from [UInt](_codec_uint_.uint.md).[fromU8a](_codec_uint_.uint.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/UInt.ts:63](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L63)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [UInt](_codec_uint_.uint.md) + +___ + + +## gt + +▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* + +*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L129)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## gte + +▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* + +*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L135)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## isZero + +▸ **isZero**(): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* + +*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L113)* + +**Returns:** `boolean` + +___ + + +## lt + +▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* + +*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L117)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## lte + +▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* + +*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L123)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## mul + +▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* + +*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L141)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## sub + +▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* + +*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L147)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## toBn + +▸ **toBn**(): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* + +*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L85)* + +**Returns:** `BN` + +___ + + +## toHex + +▸ **toHex**(): `string` + +*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* + +*Defined in [codec/UInt.ts:69](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L69)* + +**Returns:** `string` + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L73)* + +**Returns:** `any` + +___ + + +## toNumber + +▸ **toNumber**(): `number` + +*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* + +*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L89)* + +**Returns:** `number` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/UInt.ts:81](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L81)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L77)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## `` decode + +▸ **decode**(value: *[AnyNumber](../modules/_types_d_.md#anynumber)*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[decode](_codec_uint_.uint.md#decode)* + +*Defined in [codec/UInt.ts:38](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L38)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| value | [AnyNumber](../modules/_types_d_.md#anynumber) | + +**Returns:** `BN` + +___ + diff --git a/docs/types/classes/_u16_.u16.md b/docs/types/classes/_u16_.u16.md new file mode 100644 index 0000000000..a8017a00b7 --- /dev/null +++ b/docs/types/classes/_u16_.u16.md @@ -0,0 +1,397 @@ + + +# Hierarchy + +↳ [UInt](_codec_uint_.uint.md) + +**↳ U16** + +# Constructors + + + +## constructor + +⊕ **new U16**(value?: *[AnyNumber](../modules/_types_d_.md#anynumber)*): [U16](_u16_.u16.md) + +*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* + +*Defined in [U16.ts:9](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/U16.ts#L9)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | [AnyNumber](../modules/_types_d_.md#anynumber) | + +**Returns:** [U16](_u16_.u16.md) + +___ + +# Properties + + + +## raw + +**● raw**: *`BN`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Methods + + + +## add + +▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* + +*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L95)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [UInt](_codec_uint_.uint.md).[byteLength](_codec_uint_.uint.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/UInt.ts:53](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L53)* + +**Returns:** `number` + +___ + + +## cmp + +▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` + +*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* + +*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `number` + +___ + + +## div + +▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* + +*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L107)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [UInt](_codec_uint_.uint.md) + +*Inherited from [UInt](_codec_uint_.uint.md).[fromJSON](_codec_uint_.uint.md#fromjson)* + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L57)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [UInt](_codec_uint_.uint.md) + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [UInt](_codec_uint_.uint.md) + +*Inherited from [UInt](_codec_uint_.uint.md).[fromU8a](_codec_uint_.uint.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/UInt.ts:63](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L63)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [UInt](_codec_uint_.uint.md) + +___ + + +## gt + +▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* + +*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L129)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## gte + +▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* + +*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L135)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## isZero + +▸ **isZero**(): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* + +*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L113)* + +**Returns:** `boolean` + +___ + + +## lt + +▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* + +*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L117)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## lte + +▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* + +*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L123)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## mul + +▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* + +*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L141)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## sub + +▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* + +*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L147)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## toBn + +▸ **toBn**(): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* + +*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L85)* + +**Returns:** `BN` + +___ + + +## toHex + +▸ **toHex**(): `string` + +*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* + +*Defined in [codec/UInt.ts:69](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L69)* + +**Returns:** `string` + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L73)* + +**Returns:** `any` + +___ + + +## toNumber + +▸ **toNumber**(): `number` + +*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* + +*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L89)* + +**Returns:** `number` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/UInt.ts:81](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L81)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L77)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## `` decode + +▸ **decode**(value: *[AnyNumber](../modules/_types_d_.md#anynumber)*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[decode](_codec_uint_.uint.md#decode)* + +*Defined in [codec/UInt.ts:38](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L38)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| value | [AnyNumber](../modules/_types_d_.md#anynumber) | + +**Returns:** `BN` + +___ + diff --git a/docs/types/classes/_u256_.u256.md b/docs/types/classes/_u256_.u256.md new file mode 100644 index 0000000000..e299647c5e --- /dev/null +++ b/docs/types/classes/_u256_.u256.md @@ -0,0 +1,397 @@ + + +# Hierarchy + +↳ [UInt](_codec_uint_.uint.md) + +**↳ U256** + +# Constructors + + + +## constructor + +⊕ **new U256**(value?: *[AnyNumber](../modules/_types_d_.md#anynumber)*): [U256](_u256_.u256.md) + +*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* + +*Defined in [U256.ts:9](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/U256.ts#L9)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | [AnyNumber](../modules/_types_d_.md#anynumber) | + +**Returns:** [U256](_u256_.u256.md) + +___ + +# Properties + + + +## raw + +**● raw**: *`BN`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Methods + + + +## add + +▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* + +*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L95)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [UInt](_codec_uint_.uint.md).[byteLength](_codec_uint_.uint.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/UInt.ts:53](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L53)* + +**Returns:** `number` + +___ + + +## cmp + +▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` + +*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* + +*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `number` + +___ + + +## div + +▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* + +*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L107)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [UInt](_codec_uint_.uint.md) + +*Inherited from [UInt](_codec_uint_.uint.md).[fromJSON](_codec_uint_.uint.md#fromjson)* + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L57)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [UInt](_codec_uint_.uint.md) + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [UInt](_codec_uint_.uint.md) + +*Inherited from [UInt](_codec_uint_.uint.md).[fromU8a](_codec_uint_.uint.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/UInt.ts:63](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L63)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [UInt](_codec_uint_.uint.md) + +___ + + +## gt + +▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* + +*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L129)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## gte + +▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* + +*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L135)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## isZero + +▸ **isZero**(): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* + +*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L113)* + +**Returns:** `boolean` + +___ + + +## lt + +▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* + +*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L117)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## lte + +▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* + +*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L123)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## mul + +▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* + +*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L141)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## sub + +▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* + +*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L147)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## toBn + +▸ **toBn**(): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* + +*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L85)* + +**Returns:** `BN` + +___ + + +## toHex + +▸ **toHex**(): `string` + +*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* + +*Defined in [codec/UInt.ts:69](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L69)* + +**Returns:** `string` + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L73)* + +**Returns:** `any` + +___ + + +## toNumber + +▸ **toNumber**(): `number` + +*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* + +*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L89)* + +**Returns:** `number` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/UInt.ts:81](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L81)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L77)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## `` decode + +▸ **decode**(value: *[AnyNumber](../modules/_types_d_.md#anynumber)*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[decode](_codec_uint_.uint.md#decode)* + +*Defined in [codec/UInt.ts:38](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L38)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| value | [AnyNumber](../modules/_types_d_.md#anynumber) | + +**Returns:** `BN` + +___ + diff --git a/docs/types/classes/_u32_.u32.md b/docs/types/classes/_u32_.u32.md new file mode 100644 index 0000000000..904a7697f8 --- /dev/null +++ b/docs/types/classes/_u32_.u32.md @@ -0,0 +1,411 @@ + + +# Hierarchy + +↳ [UInt](_codec_uint_.uint.md) + +**↳ U32** + +↳ [Index](_nonce_.index.md) + +↳ [Permill](_permill_.permill.md) + +↳ [Perbill](_perbill_.perbill.md) + +↳ [PropIndex](_propindex_.propindex.md) + +↳ [ProposalIndex](_proposalindex_.proposalindex.md) + +↳ [ReferendumIndex](_referendumindex_.referendumindex.md) + +↳ [VoteIndex](_voteindex_.voteindex.md) + +# Constructors + + + +## constructor + +⊕ **new U32**(value?: *[AnyNumber](../modules/_types_d_.md#anynumber)*): [U32](_u32_.u32.md) + +*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* + +*Defined in [U32.ts:9](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/U32.ts#L9)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | [AnyNumber](../modules/_types_d_.md#anynumber) | + +**Returns:** [U32](_u32_.u32.md) + +___ + +# Properties + + + +## raw + +**● raw**: *`BN`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Methods + + + +## add + +▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* + +*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L95)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [UInt](_codec_uint_.uint.md).[byteLength](_codec_uint_.uint.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/UInt.ts:53](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L53)* + +**Returns:** `number` + +___ + + +## cmp + +▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` + +*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* + +*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `number` + +___ + + +## div + +▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* + +*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L107)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [UInt](_codec_uint_.uint.md) + +*Inherited from [UInt](_codec_uint_.uint.md).[fromJSON](_codec_uint_.uint.md#fromjson)* + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L57)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [UInt](_codec_uint_.uint.md) + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [UInt](_codec_uint_.uint.md) + +*Inherited from [UInt](_codec_uint_.uint.md).[fromU8a](_codec_uint_.uint.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/UInt.ts:63](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L63)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [UInt](_codec_uint_.uint.md) + +___ + + +## gt + +▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* + +*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L129)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## gte + +▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* + +*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L135)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## isZero + +▸ **isZero**(): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* + +*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L113)* + +**Returns:** `boolean` + +___ + + +## lt + +▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* + +*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L117)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## lte + +▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* + +*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L123)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## mul + +▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* + +*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L141)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## sub + +▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* + +*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L147)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## toBn + +▸ **toBn**(): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* + +*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L85)* + +**Returns:** `BN` + +___ + + +## toHex + +▸ **toHex**(): `string` + +*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* + +*Defined in [codec/UInt.ts:69](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L69)* + +**Returns:** `string` + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L73)* + +**Returns:** `any` + +___ + + +## toNumber + +▸ **toNumber**(): `number` + +*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* + +*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L89)* + +**Returns:** `number` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/UInt.ts:81](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L81)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L77)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## `` decode + +▸ **decode**(value: *[AnyNumber](../modules/_types_d_.md#anynumber)*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[decode](_codec_uint_.uint.md#decode)* + +*Defined in [codec/UInt.ts:38](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L38)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| value | [AnyNumber](../modules/_types_d_.md#anynumber) | + +**Returns:** `BN` + +___ + diff --git a/docs/types/classes/_u64_.u64.md b/docs/types/classes/_u64_.u64.md new file mode 100644 index 0000000000..180be407e0 --- /dev/null +++ b/docs/types/classes/_u64_.u64.md @@ -0,0 +1,403 @@ + + +# Hierarchy + +↳ [UInt](_codec_uint_.uint.md) + +**↳ U64** + +↳ [BlockNumber](_blocknumber_.blocknumber.md) + +↳ [Gas](_gas_.gas.md) + +↳ [ParachainId](_parachainid_.parachainid.md) + +# Constructors + + + +## constructor + +⊕ **new U64**(value?: *[AnyNumber](../modules/_types_d_.md#anynumber)*): [U64](_u64_.u64.md) + +*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* + +*Defined in [U64.ts:9](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/U64.ts#L9)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | [AnyNumber](../modules/_types_d_.md#anynumber) | + +**Returns:** [U64](_u64_.u64.md) + +___ + +# Properties + + + +## raw + +**● raw**: *`BN`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Methods + + + +## add + +▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* + +*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L95)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [UInt](_codec_uint_.uint.md).[byteLength](_codec_uint_.uint.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/UInt.ts:53](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L53)* + +**Returns:** `number` + +___ + + +## cmp + +▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` + +*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* + +*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `number` + +___ + + +## div + +▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* + +*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L107)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [UInt](_codec_uint_.uint.md) + +*Inherited from [UInt](_codec_uint_.uint.md).[fromJSON](_codec_uint_.uint.md#fromjson)* + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L57)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [UInt](_codec_uint_.uint.md) + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [UInt](_codec_uint_.uint.md) + +*Inherited from [UInt](_codec_uint_.uint.md).[fromU8a](_codec_uint_.uint.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/UInt.ts:63](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L63)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [UInt](_codec_uint_.uint.md) + +___ + + +## gt + +▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* + +*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L129)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## gte + +▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* + +*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L135)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## isZero + +▸ **isZero**(): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* + +*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L113)* + +**Returns:** `boolean` + +___ + + +## lt + +▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* + +*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L117)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## lte + +▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* + +*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L123)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## mul + +▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* + +*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L141)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## sub + +▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* + +*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L147)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## toBn + +▸ **toBn**(): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* + +*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L85)* + +**Returns:** `BN` + +___ + + +## toHex + +▸ **toHex**(): `string` + +*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* + +*Defined in [codec/UInt.ts:69](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L69)* + +**Returns:** `string` + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L73)* + +**Returns:** `any` + +___ + + +## toNumber + +▸ **toNumber**(): `number` + +*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* + +*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L89)* + +**Returns:** `number` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/UInt.ts:81](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L81)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L77)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## `` decode + +▸ **decode**(value: *[AnyNumber](../modules/_types_d_.md#anynumber)*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[decode](_codec_uint_.uint.md#decode)* + +*Defined in [codec/UInt.ts:38](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L38)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| value | [AnyNumber](../modules/_types_d_.md#anynumber) | + +**Returns:** `BN` + +___ + diff --git a/docs/types/classes/_u8_.u8.md b/docs/types/classes/_u8_.u8.md new file mode 100644 index 0000000000..7322a52bca --- /dev/null +++ b/docs/types/classes/_u8_.u8.md @@ -0,0 +1,397 @@ + + +# Hierarchy + +↳ [UInt](_codec_uint_.uint.md) + +**↳ U8** + +# Constructors + + + +## constructor + +⊕ **new U8**(value?: *[AnyNumber](../modules/_types_d_.md#anynumber)*): [U8](_u8_.u8.md) + +*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* + +*Defined in [U8.ts:9](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/U8.ts#L9)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | [AnyNumber](../modules/_types_d_.md#anynumber) | + +**Returns:** [U8](_u8_.u8.md) + +___ + +# Properties + + + +## raw + +**● raw**: *`BN`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Methods + + + +## add + +▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* + +*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L95)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [UInt](_codec_uint_.uint.md).[byteLength](_codec_uint_.uint.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/UInt.ts:53](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L53)* + +**Returns:** `number` + +___ + + +## cmp + +▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` + +*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* + +*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `number` + +___ + + +## div + +▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* + +*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L107)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [UInt](_codec_uint_.uint.md) + +*Inherited from [UInt](_codec_uint_.uint.md).[fromJSON](_codec_uint_.uint.md#fromjson)* + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L57)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [UInt](_codec_uint_.uint.md) + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [UInt](_codec_uint_.uint.md) + +*Inherited from [UInt](_codec_uint_.uint.md).[fromU8a](_codec_uint_.uint.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/UInt.ts:63](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L63)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [UInt](_codec_uint_.uint.md) + +___ + + +## gt + +▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* + +*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L129)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## gte + +▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* + +*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L135)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## isZero + +▸ **isZero**(): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* + +*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L113)* + +**Returns:** `boolean` + +___ + + +## lt + +▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* + +*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L117)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## lte + +▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* + +*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L123)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## mul + +▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* + +*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L141)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## sub + +▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* + +*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L147)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## toBn + +▸ **toBn**(): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* + +*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L85)* + +**Returns:** `BN` + +___ + + +## toHex + +▸ **toHex**(): `string` + +*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* + +*Defined in [codec/UInt.ts:69](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L69)* + +**Returns:** `string` + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L73)* + +**Returns:** `any` + +___ + + +## toNumber + +▸ **toNumber**(): `number` + +*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* + +*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L89)* + +**Returns:** `number` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/UInt.ts:81](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L81)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L77)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## `` decode + +▸ **decode**(value: *[AnyNumber](../modules/_types_d_.md#anynumber)*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[decode](_codec_uint_.uint.md#decode)* + +*Defined in [codec/UInt.ts:38](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L38)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| value | [AnyNumber](../modules/_types_d_.md#anynumber) | + +**Returns:** `BN` + +___ + diff --git a/docs/types/classes/_validatorprefs_.validatorprefs.md b/docs/types/classes/_validatorprefs_.validatorprefs.md new file mode 100644 index 0000000000..26d2c74f30 --- /dev/null +++ b/docs/types/classes/_validatorprefs_.validatorprefs.md @@ -0,0 +1,313 @@ + + +# Type parameters +#### S +#### T +#### V +#### E +# Hierarchy + +↳ [Struct](_codec_struct_.struct.md) + +**↳ ValidatorPrefs** + +# Constructors + + + +## constructor + +⊕ **new ValidatorPrefs**(value?: *`ValidatorPrefsValue`*): [ValidatorPrefs](_validatorprefs_.validatorprefs.md) + +*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* + +*Defined in [ValidatorPrefs.ts:16](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/ValidatorPrefs.ts#L16)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | `ValidatorPrefsValue` | + +**Returns:** [ValidatorPrefs](_validatorprefs_.validatorprefs.md) + +___ + +# Properties + + + +## `` _Types + +**● _Types**: *`E`* + +*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* + +*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)* + +___ + + +## `` _jsonMap + +**● _jsonMap**: *`Map`<`keyof S`, `string`>* + +*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* + +*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)* + +___ + + +## raw + +**● raw**: *`T`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Accessors + + + +## Type + +getType(): `E` + +*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* + +*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)* + +**Returns:** `E` + +___ + + +## unstakeThreshold + +getunstakeThreshold(): [U32](_u32_.u32.md) + +*Defined in [ValidatorPrefs.ts:24](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/ValidatorPrefs.ts#L24)* + +**Returns:** [U32](_u32_.u32.md) + +___ + + +## validatorPayment + +getvalidatorPayment(): [Balance](_balance_.balance.md) + +*Defined in [ValidatorPrefs.ts:28](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/ValidatorPrefs.ts#L28)* + +**Returns:** [Balance](_balance_.balance.md) + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L86)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> + +___ + + +## get + +▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) + +*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* + +*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| index | `number` | + +**Returns:** [Base](_codec_base_.base.md) + +___ + + +## keys + +▸ **keys**(): `Array`<`string`> + +*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* + +*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)* + +**Returns:** `Array`<`string`> + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L115)* + +**Returns:** `any` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## values + +▸ **values**(): `Array`<[Base](_codec_base_.base.md)> + +*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* + +*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)* + +**Returns:** `Array`<[Base](_codec_base_.base.md)> + +___ + + +## `` decode + +▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` + +*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* + +*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)* + +**Type parameters:** + +#### S +#### V +#### T +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | +| value | `V` | `Array`<`any`>| +| isTuple | `boolean` | + +**Returns:** `T` + +___ + + +## `` with + +▸ **with**<`S`>(Types: *`S`*): `object` + +*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* + +*Defined in [codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L66)* + +**Type parameters:** + +#### S +**Parameters:** + +| Param | Type | +| ------ | ------ | +| Types | `S` | + +**Returns:** `object` + +___ + diff --git a/docs/types/classes/_voteindex_.voteindex.md b/docs/types/classes/_voteindex_.voteindex.md new file mode 100644 index 0000000000..c3d0a9da34 --- /dev/null +++ b/docs/types/classes/_voteindex_.voteindex.md @@ -0,0 +1,399 @@ + + +# Hierarchy + +↳ [U32](_u32_.u32.md) + +**↳ VoteIndex** + +# Constructors + + + +## constructor + +⊕ **new VoteIndex**(value?: *[AnyNumber](../modules/_types_d_.md#anynumber)*): [VoteIndex](_voteindex_.voteindex.md) + +*Inherited from [U32](_u32_.u32.md).[constructor](_u32_.u32.md#constructor)* + +*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* + +*Defined in [U32.ts:9](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/U32.ts#L9)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | [AnyNumber](../modules/_types_d_.md#anynumber) | + +**Returns:** [VoteIndex](_voteindex_.voteindex.md) + +___ + +# Properties + + + +## raw + +**● raw**: *`BN`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Methods + + + +## add + +▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* + +*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L95)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [UInt](_codec_uint_.uint.md).[byteLength](_codec_uint_.uint.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/UInt.ts:53](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L53)* + +**Returns:** `number` + +___ + + +## cmp + +▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` + +*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* + +*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L101)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `number` + +___ + + +## div + +▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* + +*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L107)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [UInt](_codec_uint_.uint.md) + +*Inherited from [UInt](_codec_uint_.uint.md).[fromJSON](_codec_uint_.uint.md#fromjson)* + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L57)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [UInt](_codec_uint_.uint.md) + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [UInt](_codec_uint_.uint.md) + +*Inherited from [UInt](_codec_uint_.uint.md).[fromU8a](_codec_uint_.uint.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/UInt.ts:63](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L63)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [UInt](_codec_uint_.uint.md) + +___ + + +## gt + +▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* + +*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L129)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## gte + +▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* + +*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L135)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## isZero + +▸ **isZero**(): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* + +*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L113)* + +**Returns:** `boolean` + +___ + + +## lt + +▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* + +*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L117)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## lte + +▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` + +*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* + +*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L123)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `boolean` + +___ + + +## mul + +▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* + +*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L141)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## sub + +▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* + +*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L147)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| + +**Returns:** `BN` + +___ + + +## toBn + +▸ **toBn**(): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* + +*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L85)* + +**Returns:** `BN` + +___ + + +## toHex + +▸ **toHex**(): `string` + +*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* + +*Defined in [codec/UInt.ts:69](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L69)* + +**Returns:** `string` + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L73)* + +**Returns:** `any` + +___ + + +## toNumber + +▸ **toNumber**(): `number` + +*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* + +*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L89)* + +**Returns:** `number` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/UInt.ts:81](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L81)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L77)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + + +## `` decode + +▸ **decode**(value: *[AnyNumber](../modules/_types_d_.md#anynumber)*): `BN` + +*Inherited from [UInt](_codec_uint_.uint.md).[decode](_codec_uint_.uint.md#decode)* + +*Defined in [codec/UInt.ts:38](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L38)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| value | [AnyNumber](../modules/_types_d_.md#anynumber) | + +**Returns:** `BN` + +___ + diff --git a/docs/types/classes/_votethreshold_.votethreshold.md b/docs/types/classes/_votethreshold_.votethreshold.md new file mode 100644 index 0000000000..b09d52d8a8 --- /dev/null +++ b/docs/types/classes/_votethreshold_.votethreshold.md @@ -0,0 +1,168 @@ + + +# Hierarchy + +↳ [Enum](_codec_enum_.enum.md) + +**↳ VoteThreshold** + +# Constructors + + + +## constructor + +⊕ **new VoteThreshold**(index?: * `undefined` | `number`*): [VoteThreshold](_votethreshold_.votethreshold.md) + +*Overrides [Enum](_codec_enum_.enum.md).[constructor](_codec_enum_.enum.md#constructor)* + +*Defined in [VoteThreshold.ts:8](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/VoteThreshold.ts#L8)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` index | `undefined` | `number`| + +**Returns:** [VoteThreshold](_votethreshold_.votethreshold.md) + +___ + +# Properties + + + +## raw + +**● raw**: *`number`* + +*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* + +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)* + +___ + +# Methods + + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from [Enum](_codec_enum_.enum.md).[byteLength](_codec_enum_.enum.md#bytelength)* + +*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* + +*Defined in [codec/Enum.ts:31](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Enum.ts#L31)* + +**Returns:** `number` + +___ + + +## fromJSON + +▸ **fromJSON**(input: *`any`*): [Enum](_codec_enum_.enum.md) + +*Inherited from [Enum](_codec_enum_.enum.md).[fromJSON](_codec_enum_.enum.md#fromjson)* + +*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* + +*Defined in [codec/Enum.ts:35](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Enum.ts#L35)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `any` | + +**Returns:** [Enum](_codec_enum_.enum.md) + +___ + + +## fromU8a + +▸ **fromU8a**(input: *`Uint8Array`*): [Enum](_codec_enum_.enum.md) + +*Inherited from [Enum](_codec_enum_.enum.md).[fromU8a](_codec_enum_.enum.md#fromu8a)* + +*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* + +*Defined in [codec/Enum.ts:42](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Enum.ts#L42)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| input | `Uint8Array` | + +**Returns:** [Enum](_codec_enum_.enum.md) + +___ + + +## toJSON + +▸ **toJSON**(): `any` + +*Inherited from [Enum](_codec_enum_.enum.md).[toJSON](_codec_enum_.enum.md#tojson)* + +*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* + +*Defined in [codec/Enum.ts:49](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Enum.ts#L49)* + +**Returns:** `any` + +___ + + +## toNumber + +▸ **toNumber**(): `number` + +*Inherited from [Enum](_codec_enum_.enum.md).[toNumber](_codec_enum_.enum.md#tonumber)* + +*Defined in [codec/Enum.ts:57](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Enum.ts#L57)* + +**Returns:** `number` + +___ + + +## toString + +▸ **toString**(): `string` + +*Inherited from [Enum](_codec_enum_.enum.md).[toString](_codec_enum_.enum.md#tostring)* + +*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* + +*Defined in [codec/Enum.ts:61](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Enum.ts#L61)* + +**Returns:** `string` + +___ + + +## toU8a + +▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` + +*Inherited from [Enum](_codec_enum_.enum.md).[toU8a](_codec_enum_.enum.md#tou8a)* + +*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* + +*Defined in [codec/Enum.ts:53](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Enum.ts#L53)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` isBare | `undefined` | `false` | `true`| + +**Returns:** `Uint8Array` + +___ + diff --git a/docs/types/interfaces/_storagekey_.storagefunction.md b/docs/types/interfaces/_storagekey_.storagefunction.md new file mode 100644 index 0000000000..7c768999b4 --- /dev/null +++ b/docs/types/interfaces/_storagekey_.storagefunction.md @@ -0,0 +1,63 @@ + + +# Hierarchy + +**StorageFunction** + +# Callable +▸ **__call**(arg?: *`any`*): `Uint8Array` + +*Defined in [StorageKey.ts:14](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/StorageKey.ts#L14)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` arg | `any` | + +**Returns:** `Uint8Array` + +# Properties + + + +## meta + +**● meta**: *[StorageFunctionMetadata](../classes/_metadata_.storagefunctionmetadata.md)* + +*Defined in [StorageKey.ts:16](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/StorageKey.ts#L16)* + +___ + + +## method + +**● method**: *`string`* + +*Defined in [StorageKey.ts:17](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/StorageKey.ts#L17)* + +___ + + +## section + +**● section**: *`string`* + +*Defined in [StorageKey.ts:18](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/StorageKey.ts#L18)* + +___ + + +## toJSON + +**● toJSON**: *`function`* + +*Defined in [StorageKey.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/StorageKey.ts#L19)* + +#### Type declaration +▸(): `any` + +**Returns:** `any` + +___ + diff --git a/docs/types/modules/_accountid_.md b/docs/types/modules/_accountid_.md new file mode 100644 index 0000000000..23f545a8a5 --- /dev/null +++ b/docs/types/modules/_accountid_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [AccountId](../classes/_accountid_.accountid.md) + +--- + diff --git a/docs/types/modules/_accountindex_.md b/docs/types/modules/_accountindex_.md new file mode 100644 index 0000000000..7a38e9677d --- /dev/null +++ b/docs/types/modules/_accountindex_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [AccountIndex](../classes/_accountindex_.accountindex.md) + +--- + diff --git a/docs/types/modules/_address_.md b/docs/types/modules/_address_.md new file mode 100644 index 0000000000..a760beba3b --- /dev/null +++ b/docs/types/modules/_address_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [Address](../classes/_address_.address.md) + +--- + diff --git a/docs/types/modules/_authorityid_.md b/docs/types/modules/_authorityid_.md new file mode 100644 index 0000000000..2e4c9ac4e9 --- /dev/null +++ b/docs/types/modules/_authorityid_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [AuthorityId](../classes/_authorityid_.authorityid.md) + +--- + diff --git a/docs/types/modules/_balance_.md b/docs/types/modules/_balance_.md new file mode 100644 index 0000000000..655f6876e6 --- /dev/null +++ b/docs/types/modules/_balance_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [Balance](../classes/_balance_.balance.md) + +--- + diff --git a/docs/types/modules/_bft_.md b/docs/types/modules/_bft_.md new file mode 100644 index 0000000000..98d7b4cc10 --- /dev/null +++ b/docs/types/modules/_bft_.md @@ -0,0 +1,54 @@ + + +# Index + +### Classes + +* [BftAuthoritySignature](../classes/_bft_.bftauthoritysignature.md) +* [BftHashSignature](../classes/_bft_.bfthashsignature.md) +* [Justification](../classes/_bft_.justification.md) + +### Type aliases + +* [BftAuthoritySignatureValue](_bft_.md#bftauthoritysignaturevalue) +* [BftHashSignatureValue](_bft_.md#bfthashsignaturevalue) +* [JustificationValue](_bft_.md#justificationvalue) + +--- + +# Type aliases + + + +## BftAuthoritySignatureValue + +**Ƭ BftAuthoritySignatureValue**: *`object`* + +*Defined in [Bft.ts:15](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bft.ts#L15)* + +#### Type declaration + +___ + + +## BftHashSignatureValue + +**Ƭ BftHashSignatureValue**: *`object`* + +*Defined in [Bft.ts:39](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bft.ts#L39)* + +#### Type declaration + +___ + + +## JustificationValue + +**Ƭ JustificationValue**: *`object`* + +*Defined in [Bft.ts:63](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bft.ts#L63)* + +#### Type declaration + +___ + diff --git a/docs/types/modules/_block_.md b/docs/types/modules/_block_.md new file mode 100644 index 0000000000..d9fb8ce401 --- /dev/null +++ b/docs/types/modules/_block_.md @@ -0,0 +1,28 @@ + + +# Index + +### Classes + +* [Block](../classes/_block_.block.md) + +### Type aliases + +* [BlockValue](_block_.md#blockvalue) + +--- + +# Type aliases + + + +## BlockValue + +**Ƭ BlockValue**: *`object`* + +*Defined in [Block.ts:14](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Block.ts#L14)* + +#### Type declaration + +___ + diff --git a/docs/types/modules/_blocknumber_.md b/docs/types/modules/_blocknumber_.md new file mode 100644 index 0000000000..078e8735ac --- /dev/null +++ b/docs/types/modules/_blocknumber_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [BlockNumber](../classes/_blocknumber_.blocknumber.md) + +--- + diff --git a/docs/types/modules/_bool_.md b/docs/types/modules/_bool_.md new file mode 100644 index 0000000000..ec0cf1ac87 --- /dev/null +++ b/docs/types/modules/_bool_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [Bool](../classes/_bool_.bool.md) + +--- + diff --git a/docs/types/modules/_bytes_.md b/docs/types/modules/_bytes_.md new file mode 100644 index 0000000000..a77ad2f55c --- /dev/null +++ b/docs/types/modules/_bytes_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [Bytes](../classes/_bytes_.bytes.md) + +--- + diff --git a/docs/types/modules/_codec_base_.md b/docs/types/modules/_codec_base_.md new file mode 100644 index 0000000000..bb6d8554d0 --- /dev/null +++ b/docs/types/modules/_codec_base_.md @@ -0,0 +1,28 @@ + + +# Index + +### Classes + +* [Base](../classes/_codec_base_.base.md) + +### Variables + +* [l](_codec_base_.md#l) + +--- + +# Variables + + + +## `` l + +**● l**: *`object`* = logger('codec') + +*Defined in [codec/Base.ts:7](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L7)* + +#### Type declaration + +___ + diff --git a/docs/types/modules/_codec_compact_.md b/docs/types/modules/_codec_compact_.md new file mode 100644 index 0000000000..f892d0de37 --- /dev/null +++ b/docs/types/modules/_codec_compact_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [Compact](../classes/_codec_compact_.compact.md) + +--- + diff --git a/docs/types/modules/_codec_createtype_.md b/docs/types/modules/_codec_createtype_.md new file mode 100644 index 0000000000..cb0e5ceaad --- /dev/null +++ b/docs/types/modules/_codec_createtype_.md @@ -0,0 +1,91 @@ + + +# Functions + + + +## createType + +▸ **createType**(type: *`string`*, value?: *`any`*): [Base](../classes/_codec_base_.base.md) + +*Defined in [codec/createType.ts:117](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/createType.ts#L117)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| type | `string` | +| `Optional` value | `any` | + +**Returns:** [Base](../classes/_codec_base_.base.md) + +___ + + +## getTupleType + +▸ **getTupleType**(type: *`string`*): `Constructor` + +*Defined in [codec/createType.ts:81](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/createType.ts#L81)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| type | `string` | + +**Returns:** `Constructor` + +___ + + +## getType + +▸ **getType**(_type: *`string`*): `Constructor` + +*Defined in [codec/createType.ts:99](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/createType.ts#L99)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| _type | `string` | + +**Returns:** `Constructor` + +___ + + +## getVectorType + +▸ **getVectorType**(type: *`string`*): `Constructor` + +*Defined in [codec/createType.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/createType.ts#L66)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| type | `string` | + +**Returns:** `Constructor` + +___ + + +## typeSplit + +▸ **typeSplit**(type: *`string`*): `Array`<`string`> + +*Defined in [codec/createType.ts:15](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/createType.ts#L15)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| type | `string` | + +**Returns:** `Array`<`string`> + +___ + diff --git a/docs/types/modules/_codec_enum_.md b/docs/types/modules/_codec_enum_.md new file mode 100644 index 0000000000..7774e75382 --- /dev/null +++ b/docs/types/modules/_codec_enum_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [Enum](../classes/_codec_enum_.enum.md) + +--- + diff --git a/docs/types/modules/_codec_enumtype_.md b/docs/types/modules/_codec_enumtype_.md new file mode 100644 index 0000000000..bac2d20e43 --- /dev/null +++ b/docs/types/modules/_codec_enumtype_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [EnumType](../classes/_codec_enumtype_.enumtype.md) + +--- + diff --git a/docs/types/modules/_codec_index_.md b/docs/types/modules/_codec_index_.md new file mode 100644 index 0000000000..139597f9cb --- /dev/null +++ b/docs/types/modules/_codec_index_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/types/modules/_codec_length_.md b/docs/types/modules/_codec_length_.md new file mode 100644 index 0000000000..b71aedde0c --- /dev/null +++ b/docs/types/modules/_codec_length_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [Length](../classes/_codec_length_.length.md) + +--- + diff --git a/docs/types/modules/_codec_option_.md b/docs/types/modules/_codec_option_.md new file mode 100644 index 0000000000..31e36dbde9 --- /dev/null +++ b/docs/types/modules/_codec_option_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [Option](../classes/_codec_option_.option.md) + +--- + diff --git a/docs/types/modules/_codec_struct_.md b/docs/types/modules/_codec_struct_.md new file mode 100644 index 0000000000..78b6b53bf6 --- /dev/null +++ b/docs/types/modules/_codec_struct_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [Struct](../classes/_codec_struct_.struct.md) + +--- + diff --git a/docs/types/modules/_codec_tuple_.md b/docs/types/modules/_codec_tuple_.md new file mode 100644 index 0000000000..8b6af3e8ee --- /dev/null +++ b/docs/types/modules/_codec_tuple_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [Tuple](../classes/_codec_tuple_.tuple.md) + +--- + diff --git a/docs/types/modules/_codec_u8a_.md b/docs/types/modules/_codec_u8a_.md new file mode 100644 index 0000000000..6e7b7aa79e --- /dev/null +++ b/docs/types/modules/_codec_u8a_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [U8a](../classes/_codec_u8a_.u8a.md) + +--- + diff --git a/docs/types/modules/_codec_u8afixed_.md b/docs/types/modules/_codec_u8afixed_.md new file mode 100644 index 0000000000..ab51c99319 --- /dev/null +++ b/docs/types/modules/_codec_u8afixed_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [U8aFixed](../classes/_codec_u8afixed_.u8afixed.md) + +--- + diff --git a/docs/types/modules/_codec_uint_.md b/docs/types/modules/_codec_uint_.md new file mode 100644 index 0000000000..4f01dedb97 --- /dev/null +++ b/docs/types/modules/_codec_uint_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [UInt](../classes/_codec_uint_.uint.md) + +--- + diff --git a/docs/types/modules/_codec_vector_.md b/docs/types/modules/_codec_vector_.md new file mode 100644 index 0000000000..02bb06dd38 --- /dev/null +++ b/docs/types/modules/_codec_vector_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [Vector](../classes/_codec_vector_.vector.md) + +--- + diff --git a/docs/types/modules/_extrinsic_.md b/docs/types/modules/_extrinsic_.md new file mode 100644 index 0000000000..59e5275858 --- /dev/null +++ b/docs/types/modules/_extrinsic_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [Extrinsic](../classes/_extrinsic_.extrinsic.md) + +--- + diff --git a/docs/types/modules/_extrinsics_.md b/docs/types/modules/_extrinsics_.md new file mode 100644 index 0000000000..7644af2fae --- /dev/null +++ b/docs/types/modules/_extrinsics_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [Extrinsics](../classes/_extrinsics_.extrinsics.md) + +--- + diff --git a/docs/types/modules/_gas_.md b/docs/types/modules/_gas_.md new file mode 100644 index 0000000000..dba7c651dc --- /dev/null +++ b/docs/types/modules/_gas_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [Gas](../classes/_gas_.gas.md) + +--- + diff --git a/docs/types/modules/_h256_.md b/docs/types/modules/_h256_.md new file mode 100644 index 0000000000..8ae1f221a5 --- /dev/null +++ b/docs/types/modules/_h256_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [H256](../classes/_h256_.h256.md) + +--- + diff --git a/docs/types/modules/_h512_.md b/docs/types/modules/_h512_.md new file mode 100644 index 0000000000..9b2325ddfe --- /dev/null +++ b/docs/types/modules/_h512_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [H512](../classes/_h512_.h512.md) + +--- + diff --git a/docs/types/modules/_hash_.md b/docs/types/modules/_hash_.md new file mode 100644 index 0000000000..d5bd9068cd --- /dev/null +++ b/docs/types/modules/_hash_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [Hash](../classes/_hash_.hash.md) + +--- + diff --git a/docs/types/modules/_header_.md b/docs/types/modules/_header_.md new file mode 100644 index 0000000000..c170b89a52 --- /dev/null +++ b/docs/types/modules/_header_.md @@ -0,0 +1,29 @@ + + +# Index + +### Classes + +* [Digest](../classes/_header_.digest.md) +* [Header](../classes/_header_.header.md) + +### Type aliases + +* [HeaderValue](_header_.md#headervalue) + +--- + +# Type aliases + + + +## HeaderValue + +**Ƭ HeaderValue**: *`object`* + +*Defined in [Header.ts:20](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Header.ts#L20)* + +#### Type declaration + +___ + diff --git a/docs/types/modules/_index_.md b/docs/types/modules/_index_.md new file mode 100644 index 0000000000..139597f9cb --- /dev/null +++ b/docs/types/modules/_index_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/types/modules/_keyvalue_.md b/docs/types/modules/_keyvalue_.md new file mode 100644 index 0000000000..31d395f867 --- /dev/null +++ b/docs/types/modules/_keyvalue_.md @@ -0,0 +1,29 @@ + + +# Index + +### Classes + +* [KeyValue](../classes/_keyvalue_.keyvalue.md) +* [KeyValueOption](../classes/_keyvalue_.keyvalueoption.md) + +### Type aliases + +* [KeyValueOptionValue](_keyvalue_.md#keyvalueoptionvalue) + +--- + +# Type aliases + + + +## KeyValueOptionValue + +**Ƭ KeyValueOptionValue**: *`object`* + +*Defined in [KeyValue.ts:39](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/KeyValue.ts#L39)* + +#### Type declaration + +___ + diff --git a/docs/types/modules/_metadata_.md b/docs/types/modules/_metadata_.md new file mode 100644 index 0000000000..d70ab8bedd --- /dev/null +++ b/docs/types/modules/_metadata_.md @@ -0,0 +1,23 @@ + + +# Index + +### Classes + +* [CallMetadata](../classes/_metadata_.callmetadata.md) +* [EventMetadata](../classes/_metadata_.eventmetadata.md) +* [FunctionArgumentMetadata](../classes/_metadata_.functionargumentmetadata.md) +* [FunctionMetadata](../classes/_metadata_.functionmetadata.md) +* [ModuleMetadata](../classes/_metadata_.modulemetadata.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) +* [StorageFunctionType](../classes/_metadata_.storagefunctiontype.md) +* [StorageFunctionType$Map](../classes/_metadata_.storagefunctiontype_map.md) +* [StorageMetadata](../classes/_metadata_.storagemetadata.md) + +--- + diff --git a/docs/types/modules/_metadata_rpc_.md b/docs/types/modules/_metadata_rpc_.md new file mode 100644 index 0000000000..139597f9cb --- /dev/null +++ b/docs/types/modules/_metadata_rpc_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/types/modules/_misbehaviorreport_.md b/docs/types/modules/_misbehaviorreport_.md new file mode 100644 index 0000000000..5972cb78d7 --- /dev/null +++ b/docs/types/modules/_misbehaviorreport_.md @@ -0,0 +1,14 @@ + + +# Index + +### Classes + +* [BftAtReport](../classes/_misbehaviorreport_.bftatreport.md) +* [BftDoubleCommit](../classes/_misbehaviorreport_.bftdoublecommit.md) +* [BftDoublePrepare](../classes/_misbehaviorreport_.bftdoubleprepare.md) +* [MisbehaviorKind](../classes/_misbehaviorreport_.misbehaviorkind.md) +* [MisbehaviorReport](../classes/_misbehaviorreport_.misbehaviorreport.md) + +--- + diff --git a/docs/types/modules/_moment_.md b/docs/types/modules/_moment_.md new file mode 100644 index 0000000000..a17bec6120 --- /dev/null +++ b/docs/types/modules/_moment_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [Moment](../classes/_moment_.moment.md) + +--- + diff --git a/docs/types/modules/_newaccountoutcome_.md b/docs/types/modules/_newaccountoutcome_.md new file mode 100644 index 0000000000..647bb51cd8 --- /dev/null +++ b/docs/types/modules/_newaccountoutcome_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [NewAccountOutcome](../classes/_newaccountoutcome_.newaccountoutcome.md) + +--- + diff --git a/docs/types/modules/_nonce_.md b/docs/types/modules/_nonce_.md new file mode 100644 index 0000000000..729c347a58 --- /dev/null +++ b/docs/types/modules/_nonce_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [Index](../classes/_nonce_.index.md) + +--- + diff --git a/docs/types/modules/_origin_.md b/docs/types/modules/_origin_.md new file mode 100644 index 0000000000..03197ea917 --- /dev/null +++ b/docs/types/modules/_origin_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [Origin](../classes/_origin_.origin.md) + +--- + diff --git a/docs/types/modules/_parachainid_.md b/docs/types/modules/_parachainid_.md new file mode 100644 index 0000000000..9df7bac4d8 --- /dev/null +++ b/docs/types/modules/_parachainid_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [ParachainId](../classes/_parachainid_.parachainid.md) + +--- + diff --git a/docs/types/modules/_pendingextrinsics_.md b/docs/types/modules/_pendingextrinsics_.md new file mode 100644 index 0000000000..90f8ad413f --- /dev/null +++ b/docs/types/modules/_pendingextrinsics_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [PendingExtrinsics](../classes/_pendingextrinsics_.pendingextrinsics.md) + +--- + diff --git a/docs/types/modules/_perbill_.md b/docs/types/modules/_perbill_.md new file mode 100644 index 0000000000..0ab615aba5 --- /dev/null +++ b/docs/types/modules/_perbill_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [Perbill](../classes/_perbill_.perbill.md) + +--- + diff --git a/docs/types/modules/_permill_.md b/docs/types/modules/_permill_.md new file mode 100644 index 0000000000..1cc9046847 --- /dev/null +++ b/docs/types/modules/_permill_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [Permill](../classes/_permill_.permill.md) + +--- + diff --git a/docs/types/modules/_propindex_.md b/docs/types/modules/_propindex_.md new file mode 100644 index 0000000000..2e4ff40005 --- /dev/null +++ b/docs/types/modules/_propindex_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [PropIndex](../classes/_propindex_.propindex.md) + +--- + diff --git a/docs/types/modules/_proposal_.md b/docs/types/modules/_proposal_.md new file mode 100644 index 0000000000..ac814efb66 --- /dev/null +++ b/docs/types/modules/_proposal_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [Proposal](../classes/_proposal_.proposal.md) + +--- + diff --git a/docs/types/modules/_proposalindex_.md b/docs/types/modules/_proposalindex_.md new file mode 100644 index 0000000000..489e2337b2 --- /dev/null +++ b/docs/types/modules/_proposalindex_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [ProposalIndex](../classes/_proposalindex_.proposalindex.md) + +--- + diff --git a/docs/types/modules/_rawaddress_.md b/docs/types/modules/_rawaddress_.md new file mode 100644 index 0000000000..84b0324309 --- /dev/null +++ b/docs/types/modules/_rawaddress_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [RawAddress](../classes/_rawaddress_.rawaddress.md) + +--- + diff --git a/docs/types/modules/_referendumindex_.md b/docs/types/modules/_referendumindex_.md new file mode 100644 index 0000000000..4eac202632 --- /dev/null +++ b/docs/types/modules/_referendumindex_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [ReferendumIndex](../classes/_referendumindex_.referendumindex.md) + +--- + diff --git a/docs/types/modules/_runtimeversion_.md b/docs/types/modules/_runtimeversion_.md new file mode 100644 index 0000000000..0edb4fce77 --- /dev/null +++ b/docs/types/modules/_runtimeversion_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [RuntimeVersion](../classes/_runtimeversion_.runtimeversion.md) + +--- + diff --git a/docs/types/modules/_signature_.md b/docs/types/modules/_signature_.md new file mode 100644 index 0000000000..9cf0bfdf42 --- /dev/null +++ b/docs/types/modules/_signature_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [Signature](../classes/_signature_.signature.md) + +--- + diff --git a/docs/types/modules/_signedblock_.md b/docs/types/modules/_signedblock_.md new file mode 100644 index 0000000000..c4327c3e6b --- /dev/null +++ b/docs/types/modules/_signedblock_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [SignedBlock](../classes/_signedblock_.signedblock.md) + +--- + diff --git a/docs/types/modules/_storagechangeset_.md b/docs/types/modules/_storagechangeset_.md new file mode 100644 index 0000000000..abac8f16c6 --- /dev/null +++ b/docs/types/modules/_storagechangeset_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [StorageChangeSet](../classes/_storagechangeset_.storagechangeset.md) + +--- + diff --git a/docs/types/modules/_storagedata_.md b/docs/types/modules/_storagedata_.md new file mode 100644 index 0000000000..c030138027 --- /dev/null +++ b/docs/types/modules/_storagedata_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [StorageData](../classes/_storagedata_.storagedata.md) + +--- + diff --git a/docs/types/modules/_storagekey_.md b/docs/types/modules/_storagekey_.md new file mode 100644 index 0000000000..33cd951f81 --- /dev/null +++ b/docs/types/modules/_storagekey_.md @@ -0,0 +1,14 @@ + + +# Index + +### Classes + +* [StorageKey](../classes/_storagekey_.storagekey.md) + +### Interfaces + +* [StorageFunction](../interfaces/_storagekey_.storagefunction.md) + +--- + diff --git a/docs/types/modules/_text_.md b/docs/types/modules/_text_.md new file mode 100644 index 0000000000..c416d877a7 --- /dev/null +++ b/docs/types/modules/_text_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [Text](../classes/_text_.text.md) + +--- + diff --git a/docs/types/modules/_type_.md b/docs/types/modules/_type_.md new file mode 100644 index 0000000000..51be28b9cb --- /dev/null +++ b/docs/types/modules/_type_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [Type](../classes/_type_.type.md) + +--- + diff --git a/docs/types/modules/_types_d_.md b/docs/types/modules/_types_d_.md new file mode 100644 index 0000000000..c7f856a4ce --- /dev/null +++ b/docs/types/modules/_types_d_.md @@ -0,0 +1,34 @@ + + +# Type aliases + + + +## AnyNumber + +**Ƭ AnyNumber**: * [UInt](../classes/_codec_uint_.uint.md) | `BN` | `Uint8Array` | `number` | `string` +* + +*Defined in [types.d.ts:10](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/types.d.ts#L10)* + +___ + + +## AnyU8a + +**Ƭ AnyU8a**: * [U8a](../classes/_codec_u8a_.u8a.md) | `Uint8Array` | `Array`<`number`> | `string` +* + +*Defined in [types.d.ts:12](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/types.d.ts#L12)* + +___ + + +## CodecTypes + +**Ƭ CodecTypes**: *`keyof "/home/travis/build/polkadot-js/api/packages/types/src/index"`* + +*Defined in [types.d.ts:14](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/types.d.ts#L14)* + +___ + diff --git a/docs/types/modules/_u128_.md b/docs/types/modules/_u128_.md new file mode 100644 index 0000000000..68e070352b --- /dev/null +++ b/docs/types/modules/_u128_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [U128](../classes/_u128_.u128.md) + +--- + diff --git a/docs/types/modules/_u16_.md b/docs/types/modules/_u16_.md new file mode 100644 index 0000000000..9f0eb81b44 --- /dev/null +++ b/docs/types/modules/_u16_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [U16](../classes/_u16_.u16.md) + +--- + diff --git a/docs/types/modules/_u256_.md b/docs/types/modules/_u256_.md new file mode 100644 index 0000000000..05657bb3b5 --- /dev/null +++ b/docs/types/modules/_u256_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [U256](../classes/_u256_.u256.md) + +--- + diff --git a/docs/types/modules/_u32_.md b/docs/types/modules/_u32_.md new file mode 100644 index 0000000000..3cae2a6675 --- /dev/null +++ b/docs/types/modules/_u32_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [U32](../classes/_u32_.u32.md) + +--- + diff --git a/docs/types/modules/_u64_.md b/docs/types/modules/_u64_.md new file mode 100644 index 0000000000..ab41aa92aa --- /dev/null +++ b/docs/types/modules/_u64_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [U64](../classes/_u64_.u64.md) + +--- + diff --git a/docs/types/modules/_u8_.md b/docs/types/modules/_u8_.md new file mode 100644 index 0000000000..bb12ebee0c --- /dev/null +++ b/docs/types/modules/_u8_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [U8](../classes/_u8_.u8.md) + +--- + diff --git a/docs/types/modules/_validatorprefs_.md b/docs/types/modules/_validatorprefs_.md new file mode 100644 index 0000000000..b6ba8ee16d --- /dev/null +++ b/docs/types/modules/_validatorprefs_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [ValidatorPrefs](../classes/_validatorprefs_.validatorprefs.md) + +--- + diff --git a/docs/types/modules/_voteindex_.md b/docs/types/modules/_voteindex_.md new file mode 100644 index 0000000000..0cc0e02847 --- /dev/null +++ b/docs/types/modules/_voteindex_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [VoteIndex](../classes/_voteindex_.voteindex.md) + +--- + diff --git a/docs/types/modules/_votethreshold_.md b/docs/types/modules/_votethreshold_.md new file mode 100644 index 0000000000..6feb56ba9c --- /dev/null +++ b/docs/types/modules/_votethreshold_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [VoteThreshold](../classes/_votethreshold_.votethreshold.md) + +--- + diff --git a/lerna.json b/lerna.json index c9f8f076e2..eb3e3a36ef 100644 --- a/lerna.json +++ b/lerna.json @@ -9,5 +9,5 @@ "packages": [ "packages/*" ], - "version": "0.30.9" + "version": "0.30.10" } diff --git a/package.json b/package.json index a9df419f67..572e8d2921 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "version": "0.30.9", + "version": "0.30.10", "private": true, "engines": { "node": "^10.1.0", diff --git a/packages/api-observable/package.json b/packages/api-observable/package.json index 4aa6be1d57..04a127e68d 100644 --- a/packages/api-observable/package.json +++ b/packages/api-observable/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/api-observable", - "version": "0.30.9", + "version": "0.30.10", "description": "An Observable wrapper around the Polkadot JS API", "main": "index.js", "keywords": [ @@ -30,8 +30,8 @@ "homepage": "https://github.com/polkadot-js/api/tree/master/packages/api-rx#readme", "dependencies": { "@babel/runtime": "^7.0.0", - "@polkadot/api": "^0.30.9", - "@polkadot/api-provider": "^0.30.9", + "@polkadot/api": "^0.30.10", + "@polkadot/api-provider": "^0.30.10", "@types/rx": "^4.1.1", "rxjs": "^6.3.2" } diff --git a/packages/api-provider/package.json b/packages/api-provider/package.json index fc8fcd12f5..fdbf14ddf9 100644 --- a/packages/api-provider/package.json +++ b/packages/api-provider/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/api-provider", - "version": "0.30.9", + "version": "0.30.10", "description": "Transport providers for the API", "main": "index.js", "keywords": [ @@ -30,7 +30,7 @@ "homepage": "https://github.com/polkadot-js/api/tree/master/packages/api-provider#readme", "dependencies": { "@babel/runtime": "^7.0.0", - "@polkadot/storage": "^0.30.9", + "@polkadot/storage": "^0.30.10", "@polkadot/util": "^0.30.7", "@polkadot/util-crypto": "^0.30.7", "@polkadot/util-keyring": "^0.30.7", diff --git a/packages/api-rx/package.json b/packages/api-rx/package.json index 4a9c4c5fed..523a5a52c0 100644 --- a/packages/api-rx/package.json +++ b/packages/api-rx/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/api-rx", - "version": "0.30.9", + "version": "0.30.10", "description": "An RxJs wrapper around the Polkadot JS API", "main": "index.js", "keywords": [ @@ -30,8 +30,8 @@ "homepage": "https://github.com/polkadot-js/api/tree/master/packages/api-rx#readme", "dependencies": { "@babel/runtime": "^7.0.0", - "@polkadot/api": "^0.30.9", - "@polkadot/api-provider": "^0.30.9", + "@polkadot/api": "^0.30.10", + "@polkadot/api-provider": "^0.30.10", "@types/rx": "^4.1.1", "rxjs": "^6.3.2" } diff --git a/packages/api/package.json b/packages/api/package.json index b9e5386f36..cf2bb67f2d 100644 --- a/packages/api/package.json +++ b/packages/api/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/api", - "version": "0.30.9", + "version": "0.30.10", "description": "A JavaScript wrapper for the Polkadot JsonRPC interface", "main": "index.js", "keywords": [ @@ -30,8 +30,8 @@ "homepage": "https://github.com/polkadot-js/api/tree/master/packages/api#readme", "dependencies": { "@babel/runtime": "^7.0.0", - "@polkadot/api-provider": "^0.30.9", - "@polkadot/jsonrpc": "^0.30.9", + "@polkadot/api-provider": "^0.30.10", + "@polkadot/jsonrpc": "^0.30.10", "@polkadot/util": "^0.30.7" } } diff --git a/packages/type-extrinsics/package.json b/packages/type-extrinsics/package.json index b9c905ad29..07e2e9a80c 100644 --- a/packages/type-extrinsics/package.json +++ b/packages/type-extrinsics/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/extrinsics", - "version": "0.30.9", + "version": "0.30.10", "main": "index.js", "repository": "https://github.com/polkadot-js/api.git", "author": "Jaco Greeff ", diff --git a/packages/type-jsonrpc/package.json b/packages/type-jsonrpc/package.json index 74ed234063..f9705a3013 100644 --- a/packages/type-jsonrpc/package.json +++ b/packages/type-jsonrpc/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/jsonrpc", - "version": "0.30.9", + "version": "0.30.10", "description": "Method definitions for the Polkadot RPC layer", "main": "index.js", "engines": { diff --git a/packages/type-storage/package.json b/packages/type-storage/package.json index 4b2b048516..2a928920d8 100644 --- a/packages/type-storage/package.json +++ b/packages/type-storage/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/storage", - "version": "0.30.9", + "version": "0.30.10", "description": "Generic wrapper wrapper around state storage", "main": "index.js", "engines": { @@ -30,9 +30,9 @@ "homepage": "https://github.com/polkadot-js/api/tree/master/packages/type-storage#readme", "dependencies": { "@babel/runtime": "^7.0.0", - "@polkadot/types": "^0.30.9", "@polkadot/params": "^0.30.3", "@polkadot/primitives": "^0.30.3", + "@polkadot/types": "^0.30.10", "@polkadot/util": "^0.30.7", "@polkadot/util-crypto": "^0.30.7", "@polkadot/util-keyring": "^0.30.7" diff --git a/packages/types/package.json b/packages/types/package.json index 9833ef588e..cb8ad74b69 100644 --- a/packages/types/package.json +++ b/packages/types/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/types", - "version": "0.30.9", + "version": "0.30.10", "description": "Implementation of the Parity codec", "main": "index.js", "keywords": [